2022-02-14
▼ ▲ compute.regionNetworkFirewallPolicies.getRule
Scopes:
Parameters:
priority
Type: integer
Format: int32
Description: The priority of the rule to get from the firewall policy.
Location: query
project
Location: path
Required: Yes
Type: string
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Description: Project ID for this request.
firewallPolicy
Location: path
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description: Name of the firewall policy to which the queried rule belongs.
Required: Yes
Type: string
region
Required: Yes
Location: path
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description: Name of the region scoping this request.
Type: string
Path: projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/getRule
Parameter Order:
Flat Path: projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/getRule
Description: Gets a rule of the specified priority.
HTTP Method: GET
▼ ▲ compute.regionNetworkFirewallPolicies.cloneRules
Parameter Order:
Path: projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/cloneRules
Description: Copies rules to the specified network firewall policy.
Scopes:
Flat Path: projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/cloneRules
Parameters:
requestId
Type: string
Description: An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
Location: query
project
Type: string
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Location: path
Required: Yes
Description: Project ID for this request.
firewallPolicy
Location: path
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required: Yes
Description: Name of the firewall policy to update.
Type: string
sourceFirewallPolicy
Location: query
Description: The firewall policy from which to copy rules.
Type: string
region
Location: path
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type: string
Description: Name of the region scoping this request.
Required: Yes
HTTP Method: POST
▼ ▲ compute.regionNetworkFirewallPolicies.addAssociation
Scopes:
Path: projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/addAssociation
Description: Inserts an association for the specified network firewall policy.
Flat Path: projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/addAssociation
HTTP Method: POST
Parameter Order:
Parameters:
region
Location: path
Description: Name of the region scoping this request.
Required: Yes
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type: string
firewallPolicy
Location: path
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type: string
Description: Name of the firewall policy to update.
Required: Yes
project
Type: string
Description: Project ID for this request.
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Required: Yes
Location: path
requestId
Type: string
Description: An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
Location: query
replaceExistingAssociation
Type: boolean
Location: query
Description: Indicates whether or not to replace it if an association already exists. This is false by default, in which case an error will be returned if an association already exists.
▼ ▲ compute.regionNetworkFirewallPolicies.patchRule
Parameters:
firewallPolicy
Location: path
Description: Name of the firewall policy to update.
Required: Yes
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type: string
project
Location: path
Description: Project ID for this request.
Required: Yes
Type: string
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
requestId
Location: query
Description: An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
Type: string
region
Required: Yes
Location: path
Description: Name of the region scoping this request.
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type: string
priority
Location: query
Description: The priority of the rule to patch.
Type: integer
Format: int32
Parameter Order:
HTTP Method: POST
Flat Path: projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/patchRule
Path: projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/patchRule
Description: Patches a rule of the specified priority.
Scopes:
▼ ▲ compute.regionNetworkFirewallPolicies.getEffectiveFirewalls
Description: Returns the effective firewalls on a given network.
Path: projects/{project}/regions/{region}/firewallPolicies/getEffectiveFirewalls
HTTP Method: GET
Flat Path: projects/{project}/regions/{region}/firewallPolicies/getEffectiveFirewalls
Parameter Order:
Scopes:
Parameters:
project
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Type: string
Required: Yes
Description: Project ID for this request.
Location: path
network
Location: query
Type: string
Required: Yes
Description: Network reference
region
Location: path
Type: string
Required: Yes
Description: Name of the region scoping this request.
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
▼ ▲ compute.regionNetworkFirewallPolicies.addRule
Parameter Order:
Parameters:
requestId
Type: string
Description: An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
Location: query
maxPriority
Type: integer
Format: int32
Description: When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority>. This field is exclusive with rule.priority.
Location: query
firewallPolicy
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type: string
Description: Name of the firewall policy to update.
Location: path
Required: Yes
project
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Location: path
Type: string
Description: Project ID for this request.
Required: Yes
minPriority
Description: When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority>. This field is exclusive with rule.priority.
Type: integer
Location: query
Format: int32
region
Type: string
Description: Name of the region scoping this request.
Location: path
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required: Yes
Description: Inserts a rule into a network firewall policy.
Path: projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/addRule
HTTP Method: POST
Flat Path: projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/addRule
Scopes:
▼ ▲ compute.regionNetworkFirewallPolicies.list
Flat Path: projects/{project}/regions/{region}/firewallPolicies
Description: Lists all the network firewall policies that have been configured for the specified project in the given region.
HTTP Method: GET
Scopes:
Parameter Order:
Path: projects/{project}/regions/{region}/firewallPolicies
Parameters:
orderBy
Location: query
Type: string
Description: Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.
project
Description: Project ID for this request.
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Type: string
Required: Yes
Location: path
region
Type: string
Location: path
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required: Yes
Description: Name of the region scoping this request.
maxResults
Type: integer
Minimum: 0
Format: uint32
Description: The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
Default: 500
Location: query
filter
Type: string
Description: A filter expression that filters resources listed in the response. The expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ```
Location: query
pageToken
Type: string
Location: query
Description: Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
returnPartialSuccess
Description: Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
Location: query
Type: boolean
▼ ▲ compute.regionNetworkFirewallPolicies.get
Parameters:
firewallPolicy
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description: Name of the firewall policy to get.
Required: Yes
Location: path
Type: string
project
Required: Yes
Description: Project ID for this request.
Location: path
Type: string
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
region
Description: Name of the region scoping this request.
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location: path
Type: string
Required: Yes
Description: Returns the specified network firewall policy.
Flat Path: projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}
Scopes:
HTTP Method: GET
Path: projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}
Parameter Order:
▼ ▲ compute.regionNetworkFirewallPolicies.testIamPermissions
Flat Path: projects/{project}/regions/{region}/firewallPolicies/{resource}/testIamPermissions
Path: projects/{project}/regions/{region}/firewallPolicies/{resource}/testIamPermissions
HTTP Method: POST
Parameter Order:
Description: Returns permissions that a caller has on the specified resource.
Scopes:
Parameters:
region
Required: Yes
Type: string
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description: The name of the region for this request.
Location: path
project
Description: Project ID for this request.
Required: Yes
Location: path
Type: string
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
resource
Type: string
Description: Name or id of the resource for this request.
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required: Yes
Location: path
▼ ▲ compute.regionNetworkFirewallPolicies.removeRule
Description: Deletes a rule of the specified priority.
Parameters:
requestId
Location: query
Type: string
Description: An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
priority
Location: query
Type: integer
Format: int32
Description: The priority of the rule to remove from the firewall policy.
region
Required: Yes
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type: string
Description: Name of the region scoping this request.
Location: path
firewallPolicy
Required: Yes
Location: path
Description: Name of the firewall policy to update.
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type: string
project
Type: string
Description: Project ID for this request.
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Required: Yes
Location: path
HTTP Method: POST
Path: projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/removeRule
Parameter Order:
Flat Path: projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/removeRule
Scopes:
▼ ▲ compute.regionNetworkFirewallPolicies.getAssociation
Scopes:
Flat Path: projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/getAssociation
HTTP Method: GET
Parameter Order:
Description: Gets an association with the specified name.
Path: projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/getAssociation
Parameters:
firewallPolicy
Type: string
Description: Name of the firewall policy to which the queried association belongs.
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location: path
Required: Yes
region
Location: path
Type: string
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required: Yes
Description: Name of the region scoping this request.
project
Location: path
Description: Project ID for this request.
Required: Yes
Type: string
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
name
Description: The name of the association to get from the firewall policy.
Type: string
Location: query
▼ ▲ compute.regionNetworkFirewallPolicies.patch
Path: projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}
Parameters:
firewallPolicy
Type: string
Required: Yes
Location: path
Description: Name of the firewall policy to update.
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
project
Required: Yes
Type: string
Location: path
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Description: Project ID for this request.
requestId
Location: query
Type: string
Description: An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
region
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type: string
Required: Yes
Location: path
Description: Name of the region scoping this request.
Scopes:
Description: Patches the specified network firewall policy.
Parameter Order:
Flat Path: projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}
HTTP Method: PATCH
▼ ▲ compute.regionNetworkFirewallPolicies.removeAssociation
Parameters:
project
Location: path
Required: Yes
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Type: string
Description: Project ID for this request.
firewallPolicy
Location: path
Required: Yes
Type: string
Description: Name of the firewall policy to update.
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
region
Location: path
Description: Name of the region scoping this request.
Required: Yes
Type: string
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
requestId
Type: string
Location: query
Description: An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
name
Description: Name for the association that will be removed.
Location: query
Type: string
Path: projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/removeAssociation
Description: Removes an association for the specified network firewall policy.
HTTP Method: POST
Parameter Order:
Flat Path: projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/removeAssociation
Scopes:
▼ ▲ compute.regionNetworkFirewallPolicies.delete
HTTP Method: DELETE
Scopes:
Description: Deletes the specified network firewall policy.
Parameter Order:
Path: projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}
Flat Path: projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}
Parameters:
region
Type: string
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location: path
Description: Name of the region scoping this request.
Required: Yes
project
Required: Yes
Location: path
Type: string
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Description: Project ID for this request.
firewallPolicy
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location: path
Description: Name of the firewall policy to delete.
Required: Yes
Type: string
requestId
Type: string
Location: query
Description: An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
▼ ▲ compute.regionNetworkFirewallPolicies.setIamPolicy
Scopes:
Flat Path: projects/{project}/regions/{region}/firewallPolicies/{resource}/setIamPolicy
Description: Sets the access control policy on the specified resource. Replaces any existing policy.
Parameter Order:
HTTP Method: POST
Path: projects/{project}/regions/{region}/firewallPolicies/{resource}/setIamPolicy
Parameters:
region
Description: The name of the region for this request.
Required: Yes
Location: path
Type: string
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
resource
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location: path
Required: Yes
Type: string
Description: Name or id of the resource for this request.
project
Location: path
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Description: Project ID for this request.
Required: Yes
Type: string
▼ ▲ compute.regionNetworkFirewallPolicies.insert
Parameters:
requestId
Type: string
Location: query
Description: An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
region
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type: string
Required: Yes
Location: path
Description: Name of the region scoping this request.
project
Description: Project ID for this request.
Type: string
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Required: Yes
Location: path
Flat Path: projects/{project}/regions/{region}/firewallPolicies
Parameter Order:
Scopes:
Description: Creates a new network firewall policy in the specified project and region.
Path: projects/{project}/regions/{region}/firewallPolicies
HTTP Method: POST
▼ ▲ compute.regionNetworkFirewallPolicies.getIamPolicy
Parameter Order:
Parameters:
optionsRequestedPolicyVersion
Format: int32
Description: Requested IAM Policy version.
Location: query
Type: integer
region
Required: Yes
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description: The name of the region for this request.
Type: string
Location: path
resource
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description: Name or id of the resource for this request.
Type: string
Location: path
Required: Yes
project
Description: Project ID for this request.
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Required: Yes
Type: string
Location: path
Description: Gets the access control policy for a resource. May be empty if no such policy or resource exists.
Scopes:
Flat Path: projects/{project}/regions/{region}/firewallPolicies/{resource}/getIamPolicy
Path: projects/{project}/regions/{region}/firewallPolicies/{resource}/getIamPolicy
HTTP Method: GET
▼ ▲ compute.networkFirewallPolicies.testIamPermissions
Parameter Order:
Scopes:
Parameters:
project
Location: path
Description: Project ID for this request.
Type: string
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Required: Yes
resource
Description: Name or id of the resource for this request.
Location: path
Pattern: [a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type: string
Required: Yes
Description: Returns permissions that a caller has on the specified resource.
Path: projects/{project}/global/firewallPolicies/{resource}/testIamPermissions
Flat Path: projects/{project}/global/firewallPolicies/{resource}/testIamPermissions
HTTP Method: POST
▼ ▲ compute.networkFirewallPolicies.removeAssociation
Scopes:
Parameters:
project
Location: path
Description: Project ID for this request.
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Type: string
Required: Yes
name
Description: Name for the attachment that will be removed.
Location: query
Type: string
requestId
Type: string
Description: An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
Location: query
firewallPolicy
Type: string
Location: path
Description: Name of the firewall policy to update.
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required: Yes
Description: Removes an association for the specified firewall policy.
Path: projects/{project}/global/firewallPolicies/{firewallPolicy}/removeAssociation
Flat Path: projects/{project}/global/firewallPolicies/{firewallPolicy}/removeAssociation
Parameter Order:
HTTP Method: POST
▼ ▲ compute.networkFirewallPolicies.patchRule
Description: Patches a rule of the specified priority.
Path: projects/{project}/global/firewallPolicies/{firewallPolicy}/patchRule
Scopes:
HTTP Method: POST
Flat Path: projects/{project}/global/firewallPolicies/{firewallPolicy}/patchRule
Parameters:
firewallPolicy
Type: string
Description: Name of the firewall policy to update.
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required: Yes
Location: path
priority
Location: query
Description: The priority of the rule to patch.
Type: integer
Format: int32
project
Description: Project ID for this request.
Location: path
Required: Yes
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Type: string
requestId
Type: string
Location: query
Description: An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
Parameter Order:
▼ ▲ compute.networkFirewallPolicies.addAssociation
HTTP Method: POST
Parameters:
project
Location: path
Required: Yes
Type: string
Description: Project ID for this request.
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
firewallPolicy
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required: Yes
Location: path
Description: Name of the firewall policy to update.
Type: string
requestId
Type: string
Description: An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
Location: query
replaceExistingAssociation
Location: query
Type: boolean
Description: Indicates whether or not to replace it if an association of the attachment already exists. This is false by default, in which case an error will be returned if an association already exists.
Description: Inserts an association for the specified firewall policy.
Scopes:
Flat Path: projects/{project}/global/firewallPolicies/{firewallPolicy}/addAssociation
Path: projects/{project}/global/firewallPolicies/{firewallPolicy}/addAssociation
Parameter Order:
▼ ▲ compute.networkFirewallPolicies.insert
Parameter Order: project
Description: Creates a new policy in the specified project using the data included in the request.
Scopes:
Parameters:
requestId
Description: An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
Location: query
Type: string
project
Required: Yes
Location: path
Description: Project ID for this request.
Type: string
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
HTTP Method: POST
Flat Path: projects/{project}/global/firewallPolicies
Path: projects/{project}/global/firewallPolicies
▼ ▲ compute.networkFirewallPolicies.setIamPolicy
Flat Path: projects/{project}/global/firewallPolicies/{resource}/setIamPolicy
Parameters:
project
Description: Project ID for this request.
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Required: Yes
Type: string
Location: path
resource
Type: string
Location: path
Required: Yes
Pattern: [a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description: Name or id of the resource for this request.
Path: projects/{project}/global/firewallPolicies/{resource}/setIamPolicy
Scopes:
HTTP Method: POST
Parameter Order:
Description: Sets the access control policy on the specified resource. Replaces any existing policy.
▼ ▲ compute.networkFirewallPolicies.cloneRules
Path: projects/{project}/global/firewallPolicies/{firewallPolicy}/cloneRules
Scopes:
Flat Path: projects/{project}/global/firewallPolicies/{firewallPolicy}/cloneRules
Parameters:
firewallPolicy
Location: path
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type: string
Description: Name of the firewall policy to update.
Required: Yes
project
Required: Yes
Description: Project ID for this request.
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Type: string
Location: path
requestId
Description: An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
Type: string
Location: query
sourceFirewallPolicy
Location: query
Type: string
Description: The firewall policy from which to copy rules.
Description: Copies rules to the specified firewall policy.
HTTP Method: POST
Parameter Order:
▼ ▲ compute.networkFirewallPolicies.patch
Path: projects/{project}/global/firewallPolicies/{firewallPolicy}
Parameters:
requestId
Location: query
Type: string
Description: An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
firewallPolicy
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description: Name of the firewall policy to update.
Location: path
Required: Yes
Type: string
project
Type: string
Location: path
Description: Project ID for this request.
Required: Yes
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Parameter Order:
Flat Path: projects/{project}/global/firewallPolicies/{firewallPolicy}
Scopes:
Description: Patches the specified policy with the data included in the request.
HTTP Method: PATCH
▼ ▲ compute.networkFirewallPolicies.getRule
Flat Path: projects/{project}/global/firewallPolicies/{firewallPolicy}/getRule
Description: Gets a rule of the specified priority.
Scopes:
Parameter Order:
Path: projects/{project}/global/firewallPolicies/{firewallPolicy}/getRule
Parameters:
project
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Description: Project ID for this request.
Required: Yes
Location: path
Type: string
firewallPolicy
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location: path
Type: string
Required: Yes
Description: Name of the firewall policy to which the queried rule belongs.
priority
Format: int32
Description: The priority of the rule to get from the firewall policy.
Type: integer
Location: query
HTTP Method: GET
▼ ▲ compute.networkFirewallPolicies.delete
Flat Path: projects/{project}/global/firewallPolicies/{firewallPolicy}
Parameter Order:
Description: Deletes the specified policy.
Path: projects/{project}/global/firewallPolicies/{firewallPolicy}
Scopes:
HTTP Method: DELETE
Parameters:
project
Location: path
Required: Yes
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Type: string
Description: Project ID for this request.
requestId
Type: string
Location: query
Description: An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
firewallPolicy
Required: Yes
Location: path
Type: string
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description: Name of the firewall policy to delete.
▼ ▲ compute.networkFirewallPolicies.get
Parameters:
project
Description: Project ID for this request.
Type: string
Required: Yes
Location: path
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
firewallPolicy
Type: string
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description: Name of the firewall policy to get.
Required: Yes
Location: path
HTTP Method: GET
Flat Path: projects/{project}/global/firewallPolicies/{firewallPolicy}
Parameter Order:
Description: Returns the specified network firewall policy.
Path: projects/{project}/global/firewallPolicies/{firewallPolicy}
Scopes:
▼ ▲ compute.networkFirewallPolicies.addRule
Description: Inserts a rule into a firewall policy.
Parameters:
maxPriority
Type: integer
Description: When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority>. This field is exclusive with rule.priority.
Location: query
Format: int32
firewallPolicy
Description: Name of the firewall policy to update.
Type: string
Location: path
Required: Yes
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
requestId
Description: An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
Type: string
Location: query
project
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Location: path
Type: string
Required: Yes
Description: Project ID for this request.
minPriority
Type: integer
Description: When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority>. This field is exclusive with rule.priority.
Location: query
Format: int32
HTTP Method: POST
Flat Path: projects/{project}/global/firewallPolicies/{firewallPolicy}/addRule
Path: projects/{project}/global/firewallPolicies/{firewallPolicy}/addRule
Parameter Order:
Scopes:
▼ ▲ compute.networkFirewallPolicies.getAssociation
HTTP Method: GET
Path: projects/{project}/global/firewallPolicies/{firewallPolicy}/getAssociation
Description: Gets an association with the specified name.
Parameter Order:
Parameters:
name
Type: string
Location: query
Description: The name of the association to get from the firewall policy.
project
Type: string
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Required: Yes
Description: Project ID for this request.
Location: path
firewallPolicy
Required: Yes
Type: string
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location: path
Description: Name of the firewall policy to which the queried association belongs.
Flat Path: projects/{project}/global/firewallPolicies/{firewallPolicy}/getAssociation
Scopes:
▼ ▲ compute.networkFirewallPolicies.list
Description: Lists all the policies that have been configured for the specified project.
HTTP Method: GET
Parameter Order: project
Flat Path: projects/{project}/global/firewallPolicies
Scopes:
Parameters:
returnPartialSuccess
Description: Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
Type: boolean
Location: query
project
Required: Yes
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Type: string
Description: Project ID for this request.
Location: path
filter
Description: A filter expression that filters resources listed in the response. The expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ```
Location: query
Type: string
maxResults
Format: uint32
Minimum: 0
Description: The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
Default: 500
Location: query
Type: integer
orderBy
Description: Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.
Type: string
Location: query
pageToken
Type: string
Description: Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
Location: query
Path: projects/{project}/global/firewallPolicies
▼ ▲ compute.networkFirewallPolicies.removeRule
Parameter Order:
Flat Path: projects/{project}/global/firewallPolicies/{firewallPolicy}/removeRule
Parameters:
firewallPolicy
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type: string
Location: path
Required: Yes
Description: Name of the firewall policy to update.
priority
Description: The priority of the rule to remove from the firewall policy.
Format: int32
Location: query
Type: integer
requestId
Type: string
Description: An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
Location: query
project
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Description: Project ID for this request.
Type: string
Location: path
Required: Yes
Description: Deletes a rule of the specified priority.
HTTP Method: POST
Scopes:
Path: projects/{project}/global/firewallPolicies/{firewallPolicy}/removeRule
▼ ▲ compute.networkFirewallPolicies.getIamPolicy
Scopes:
HTTP Method: GET
Parameter Order:
Path: projects/{project}/global/firewallPolicies/{resource}/getIamPolicy
Description: Gets the access control policy for a resource. May be empty if no such policy or resource exists.
Flat Path: projects/{project}/global/firewallPolicies/{resource}/getIamPolicy
Parameters:
optionsRequestedPolicyVersion
Location: query
Type: integer
Format: int32
Description: Requested IAM Policy version.
project
Description: Project ID for this request.
Required: Yes
Location: path
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Type: string
resource
Required: Yes
Type: string
Description: Name or id of the resource for this request.
Pattern: [a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location: path
▼ ▲ compute.regionNetworkFirewallPolicies.getRule
Scopes:
Parameters:
priority
Type: integer
Format: int32
Description: The priority of the rule to get from the firewall policy.
Location: query
project
Location: path
Required: Yes
Type: string
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Description: Project ID for this request.
firewallPolicy
Location: path
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description: Name of the firewall policy to which the queried rule belongs.
Required: Yes
Type: string
region
Required: Yes
Location: path
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description: Name of the region scoping this request.
Type: string
Path: projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/getRule
Parameter Order:
Flat Path: projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/getRule
Description: Gets a rule of the specified priority.
HTTP Method: GET
▼ ▲ compute.regionNetworkFirewallPolicies.cloneRules
Parameter Order:
Path: projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/cloneRules
Description: Copies rules to the specified network firewall policy.
Scopes:
Flat Path: projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/cloneRules
Parameters:
requestId
Type: string
Description: An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
Location: query
project
Type: string
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Location: path
Required: Yes
Description: Project ID for this request.
firewallPolicy
Location: path
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required: Yes
Description: Name of the firewall policy to update.
Type: string
sourceFirewallPolicy
Location: query
Description: The firewall policy from which to copy rules.
Type: string
region
Location: path
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type: string
Description: Name of the region scoping this request.
Required: Yes
HTTP Method: POST
▼ ▲ compute.regionNetworkFirewallPolicies.addAssociation
Scopes:
Path: projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/addAssociation
Description: Inserts an association for the specified network firewall policy.
Flat Path: projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/addAssociation
HTTP Method: POST
Parameter Order:
Parameters:
region
Location: path
Description: Name of the region scoping this request.
Required: Yes
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type: string
firewallPolicy
Location: path
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type: string
Description: Name of the firewall policy to update.
Required: Yes
project
Type: string
Description: Project ID for this request.
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Required: Yes
Location: path
requestId
Type: string
Description: An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
Location: query
replaceExistingAssociation
Type: boolean
Location: query
Description: Indicates whether or not to replace it if an association already exists. This is false by default, in which case an error will be returned if an association already exists.
▼ ▲ compute.regionNetworkFirewallPolicies.patchRule
Parameters:
firewallPolicy
Location: path
Description: Name of the firewall policy to update.
Required: Yes
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type: string
project
Location: path
Description: Project ID for this request.
Required: Yes
Type: string
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
requestId
Location: query
Description: An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
Type: string
region
Required: Yes
Location: path
Description: Name of the region scoping this request.
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type: string
priority
Location: query
Description: The priority of the rule to patch.
Type: integer
Format: int32
Parameter Order:
HTTP Method: POST
Flat Path: projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/patchRule
Path: projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/patchRule
Description: Patches a rule of the specified priority.
Scopes:
▼ ▲ compute.regionNetworkFirewallPolicies.getEffectiveFirewalls
Description: Returns the effective firewalls on a given network.
Path: projects/{project}/regions/{region}/firewallPolicies/getEffectiveFirewalls
HTTP Method: GET
Flat Path: projects/{project}/regions/{region}/firewallPolicies/getEffectiveFirewalls
Parameter Order:
Scopes:
Parameters:
project
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Type: string
Required: Yes
Description: Project ID for this request.
Location: path
network
Location: query
Type: string
Required: Yes
Description: Network reference
region
Location: path
Type: string
Required: Yes
Description: Name of the region scoping this request.
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
▼ ▲ compute.regionNetworkFirewallPolicies.addRule
Parameter Order:
Parameters:
requestId
Type: string
Description: An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
Location: query
maxPriority
Type: integer
Format: int32
Description: When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority>. This field is exclusive with rule.priority.
Location: query
firewallPolicy
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type: string
Description: Name of the firewall policy to update.
Location: path
Required: Yes
project
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Location: path
Type: string
Description: Project ID for this request.
Required: Yes
minPriority
Description: When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority>. This field is exclusive with rule.priority.
Type: integer
Location: query
Format: int32
region
Type: string
Description: Name of the region scoping this request.
Location: path
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required: Yes
Description: Inserts a rule into a network firewall policy.
Path: projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/addRule
HTTP Method: POST
Flat Path: projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/addRule
Scopes:
▼ ▲ compute.regionNetworkFirewallPolicies.list
Flat Path: projects/{project}/regions/{region}/firewallPolicies
Description: Lists all the network firewall policies that have been configured for the specified project in the given region.
HTTP Method: GET
Scopes:
Parameter Order:
Path: projects/{project}/regions/{region}/firewallPolicies
Parameters:
orderBy
Location: query
Type: string
Description: Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.
project
Description: Project ID for this request.
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Type: string
Required: Yes
Location: path
region
Type: string
Location: path
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required: Yes
Description: Name of the region scoping this request.
maxResults
Type: integer
Minimum: 0
Format: uint32
Description: The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
Default: 500
Location: query
filter
Type: string
Description: A filter expression that filters resources listed in the response. The expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ```
Location: query
pageToken
Type: string
Location: query
Description: Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
returnPartialSuccess
Description: Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
Location: query
Type: boolean
▼ ▲ compute.regionNetworkFirewallPolicies.get
Parameters:
firewallPolicy
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description: Name of the firewall policy to get.
Required: Yes
Location: path
Type: string
project
Required: Yes
Description: Project ID for this request.
Location: path
Type: string
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
region
Description: Name of the region scoping this request.
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location: path
Type: string
Required: Yes
Description: Returns the specified network firewall policy.
Flat Path: projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}
Scopes:
HTTP Method: GET
Path: projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}
Parameter Order:
▼ ▲ compute.regionNetworkFirewallPolicies.testIamPermissions
Flat Path: projects/{project}/regions/{region}/firewallPolicies/{resource}/testIamPermissions
Path: projects/{project}/regions/{region}/firewallPolicies/{resource}/testIamPermissions
HTTP Method: POST
Parameter Order:
Description: Returns permissions that a caller has on the specified resource.
Scopes:
Parameters:
region
Required: Yes
Type: string
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description: The name of the region for this request.
Location: path
project
Description: Project ID for this request.
Required: Yes
Location: path
Type: string
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
resource
Type: string
Description: Name or id of the resource for this request.
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required: Yes
Location: path
▼ ▲ compute.regionNetworkFirewallPolicies.removeRule
Description: Deletes a rule of the specified priority.
Parameters:
requestId
Location: query
Type: string
Description: An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
priority
Location: query
Type: integer
Format: int32
Description: The priority of the rule to remove from the firewall policy.
region
Required: Yes
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type: string
Description: Name of the region scoping this request.
Location: path
firewallPolicy
Required: Yes
Location: path
Description: Name of the firewall policy to update.
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type: string
project
Type: string
Description: Project ID for this request.
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Required: Yes
Location: path
HTTP Method: POST
Path: projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/removeRule
Parameter Order:
Flat Path: projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/removeRule
Scopes:
▼ ▲ compute.regionNetworkFirewallPolicies.getAssociation
Scopes:
Flat Path: projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/getAssociation
HTTP Method: GET
Parameter Order:
Description: Gets an association with the specified name.
Path: projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/getAssociation
Parameters:
firewallPolicy
Type: string
Description: Name of the firewall policy to which the queried association belongs.
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location: path
Required: Yes
region
Location: path
Type: string
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required: Yes
Description: Name of the region scoping this request.
project
Location: path
Description: Project ID for this request.
Required: Yes
Type: string
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
name
Description: The name of the association to get from the firewall policy.
Type: string
Location: query
▼ ▲ compute.regionNetworkFirewallPolicies.patch
Path: projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}
Parameters:
firewallPolicy
Type: string
Required: Yes
Location: path
Description: Name of the firewall policy to update.
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
project
Required: Yes
Type: string
Location: path
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Description: Project ID for this request.
requestId
Location: query
Type: string
Description: An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
region
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type: string
Required: Yes
Location: path
Description: Name of the region scoping this request.
Scopes:
Description: Patches the specified network firewall policy.
Parameter Order:
Flat Path: projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}
HTTP Method: PATCH
▼ ▲ compute.regionNetworkFirewallPolicies.removeAssociation
Parameters:
project
Location: path
Required: Yes
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Type: string
Description: Project ID for this request.
firewallPolicy
Location: path
Required: Yes
Type: string
Description: Name of the firewall policy to update.
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
region
Location: path
Description: Name of the region scoping this request.
Required: Yes
Type: string
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
requestId
Type: string
Location: query
Description: An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
name
Description: Name for the association that will be removed.
Location: query
Type: string
Path: projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/removeAssociation
Description: Removes an association for the specified network firewall policy.
HTTP Method: POST
Parameter Order:
Flat Path: projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/removeAssociation
Scopes:
▼ ▲ compute.regionNetworkFirewallPolicies.delete
HTTP Method: DELETE
Scopes:
Description: Deletes the specified network firewall policy.
Parameter Order:
Path: projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}
Flat Path: projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}
Parameters:
region
Type: string
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location: path
Description: Name of the region scoping this request.
Required: Yes
project
Required: Yes
Location: path
Type: string
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Description: Project ID for this request.
firewallPolicy
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location: path
Description: Name of the firewall policy to delete.
Required: Yes
Type: string
requestId
Type: string
Location: query
Description: An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
▼ ▲ compute.regionNetworkFirewallPolicies.setIamPolicy
Scopes:
Flat Path: projects/{project}/regions/{region}/firewallPolicies/{resource}/setIamPolicy
Description: Sets the access control policy on the specified resource. Replaces any existing policy.
Parameter Order:
HTTP Method: POST
Path: projects/{project}/regions/{region}/firewallPolicies/{resource}/setIamPolicy
Parameters:
region
Description: The name of the region for this request.
Required: Yes
Location: path
Type: string
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
resource
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location: path
Required: Yes
Type: string
Description: Name or id of the resource for this request.
project
Location: path
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Description: Project ID for this request.
Required: Yes
Type: string
▼ ▲ compute.regionNetworkFirewallPolicies.insert
Parameters:
requestId
Type: string
Location: query
Description: An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
region
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type: string
Required: Yes
Location: path
Description: Name of the region scoping this request.
project
Description: Project ID for this request.
Type: string
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Required: Yes
Location: path
Flat Path: projects/{project}/regions/{region}/firewallPolicies
Parameter Order:
Scopes:
Description: Creates a new network firewall policy in the specified project and region.
Path: projects/{project}/regions/{region}/firewallPolicies
HTTP Method: POST
▼ ▲ compute.regionNetworkFirewallPolicies.getIamPolicy
Parameter Order:
Parameters:
optionsRequestedPolicyVersion
Format: int32
Description: Requested IAM Policy version.
Location: query
Type: integer
region
Required: Yes
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description: The name of the region for this request.
Type: string
Location: path
resource
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description: Name or id of the resource for this request.
Type: string
Location: path
Required: Yes
project
Description: Project ID for this request.
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Required: Yes
Type: string
Location: path
Description: Gets the access control policy for a resource. May be empty if no such policy or resource exists.
Scopes:
Flat Path: projects/{project}/regions/{region}/firewallPolicies/{resource}/getIamPolicy
Path: projects/{project}/regions/{region}/firewallPolicies/{resource}/getIamPolicy
HTTP Method: GET
▼ ▲ compute.networkFirewallPolicies.testIamPermissions
Parameter Order:
Scopes:
Parameters:
project
Location: path
Description: Project ID for this request.
Type: string
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Required: Yes
resource
Description: Name or id of the resource for this request.
Location: path
Pattern: [a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type: string
Required: Yes
Description: Returns permissions that a caller has on the specified resource.
Path: projects/{project}/global/firewallPolicies/{resource}/testIamPermissions
Flat Path: projects/{project}/global/firewallPolicies/{resource}/testIamPermissions
HTTP Method: POST
▼ ▲ compute.networkFirewallPolicies.removeAssociation
Scopes:
Parameters:
project
Location: path
Description: Project ID for this request.
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Type: string
Required: Yes
name
Description: Name for the attachment that will be removed.
Location: query
Type: string
requestId
Type: string
Description: An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
Location: query
firewallPolicy
Type: string
Location: path
Description: Name of the firewall policy to update.
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required: Yes
Description: Removes an association for the specified firewall policy.
Path: projects/{project}/global/firewallPolicies/{firewallPolicy}/removeAssociation
Flat Path: projects/{project}/global/firewallPolicies/{firewallPolicy}/removeAssociation
Parameter Order:
HTTP Method: POST
▼ ▲ compute.networkFirewallPolicies.patchRule
Description: Patches a rule of the specified priority.
Path: projects/{project}/global/firewallPolicies/{firewallPolicy}/patchRule
Scopes:
HTTP Method: POST
Flat Path: projects/{project}/global/firewallPolicies/{firewallPolicy}/patchRule
Parameters:
firewallPolicy
Type: string
Description: Name of the firewall policy to update.
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required: Yes
Location: path
priority
Location: query
Description: The priority of the rule to patch.
Type: integer
Format: int32
project
Description: Project ID for this request.
Location: path
Required: Yes
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Type: string
requestId
Type: string
Location: query
Description: An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
Parameter Order:
▼ ▲ compute.networkFirewallPolicies.addAssociation
HTTP Method: POST
Parameters:
project
Location: path
Required: Yes
Type: string
Description: Project ID for this request.
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
firewallPolicy
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required: Yes
Location: path
Description: Name of the firewall policy to update.
Type: string
requestId
Type: string
Description: An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
Location: query
replaceExistingAssociation
Location: query
Type: boolean
Description: Indicates whether or not to replace it if an association of the attachment already exists. This is false by default, in which case an error will be returned if an association already exists.
Description: Inserts an association for the specified firewall policy.
Scopes:
Flat Path: projects/{project}/global/firewallPolicies/{firewallPolicy}/addAssociation
Path: projects/{project}/global/firewallPolicies/{firewallPolicy}/addAssociation
Parameter Order:
▼ ▲ compute.networkFirewallPolicies.insert
Parameter Order: project
Description: Creates a new policy in the specified project using the data included in the request.
Scopes:
Parameters:
requestId
Description: An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
Location: query
Type: string
project
Required: Yes
Location: path
Description: Project ID for this request.
Type: string
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
HTTP Method: POST
Flat Path: projects/{project}/global/firewallPolicies
Path: projects/{project}/global/firewallPolicies
▼ ▲ compute.networkFirewallPolicies.setIamPolicy
Flat Path: projects/{project}/global/firewallPolicies/{resource}/setIamPolicy
Parameters:
project
Description: Project ID for this request.
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Required: Yes
Type: string
Location: path
resource
Type: string
Location: path
Required: Yes
Pattern: [a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description: Name or id of the resource for this request.
Path: projects/{project}/global/firewallPolicies/{resource}/setIamPolicy
Scopes:
HTTP Method: POST
Parameter Order:
Description: Sets the access control policy on the specified resource. Replaces any existing policy.
▼ ▲ compute.networkFirewallPolicies.cloneRules
Path: projects/{project}/global/firewallPolicies/{firewallPolicy}/cloneRules
Scopes:
Flat Path: projects/{project}/global/firewallPolicies/{firewallPolicy}/cloneRules
Parameters:
firewallPolicy
Location: path
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type: string
Description: Name of the firewall policy to update.
Required: Yes
project
Required: Yes
Description: Project ID for this request.
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Type: string
Location: path
requestId
Description: An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
Type: string
Location: query
sourceFirewallPolicy
Location: query
Type: string
Description: The firewall policy from which to copy rules.
Description: Copies rules to the specified firewall policy.
HTTP Method: POST
Parameter Order:
▼ ▲ compute.networkFirewallPolicies.patch
Path: projects/{project}/global/firewallPolicies/{firewallPolicy}
Parameters:
requestId
Location: query
Type: string
Description: An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
firewallPolicy
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description: Name of the firewall policy to update.
Location: path
Required: Yes
Type: string
project
Type: string
Location: path
Description: Project ID for this request.
Required: Yes
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Parameter Order:
Flat Path: projects/{project}/global/firewallPolicies/{firewallPolicy}
Scopes:
Description: Patches the specified policy with the data included in the request.
HTTP Method: PATCH
▼ ▲ compute.networkFirewallPolicies.getRule
Flat Path: projects/{project}/global/firewallPolicies/{firewallPolicy}/getRule
Description: Gets a rule of the specified priority.
Scopes:
Parameter Order:
Path: projects/{project}/global/firewallPolicies/{firewallPolicy}/getRule
Parameters:
project
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Description: Project ID for this request.
Required: Yes
Location: path
Type: string
firewallPolicy
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location: path
Type: string
Required: Yes
Description: Name of the firewall policy to which the queried rule belongs.
priority
Format: int32
Description: The priority of the rule to get from the firewall policy.
Type: integer
Location: query
HTTP Method: GET
▼ ▲ compute.networkFirewallPolicies.delete
Flat Path: projects/{project}/global/firewallPolicies/{firewallPolicy}
Parameter Order:
Description: Deletes the specified policy.
Path: projects/{project}/global/firewallPolicies/{firewallPolicy}
Scopes:
HTTP Method: DELETE
Parameters:
project
Location: path
Required: Yes
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Type: string
Description: Project ID for this request.
requestId
Type: string
Location: query
Description: An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
firewallPolicy
Required: Yes
Location: path
Type: string
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description: Name of the firewall policy to delete.
▼ ▲ compute.networkFirewallPolicies.get
Parameters:
project
Description: Project ID for this request.
Type: string
Required: Yes
Location: path
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
firewallPolicy
Type: string
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description: Name of the firewall policy to get.
Required: Yes
Location: path
HTTP Method: GET
Flat Path: projects/{project}/global/firewallPolicies/{firewallPolicy}
Parameter Order:
Description: Returns the specified network firewall policy.
Path: projects/{project}/global/firewallPolicies/{firewallPolicy}
Scopes:
▼ ▲ compute.networkFirewallPolicies.addRule
Description: Inserts a rule into a firewall policy.
Parameters:
maxPriority
Type: integer
Description: When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority>. This field is exclusive with rule.priority.
Location: query
Format: int32
firewallPolicy
Description: Name of the firewall policy to update.
Type: string
Location: path
Required: Yes
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
requestId
Description: An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
Type: string
Location: query
project
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Location: path
Type: string
Required: Yes
Description: Project ID for this request.
minPriority
Type: integer
Description: When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority>. This field is exclusive with rule.priority.
Location: query
Format: int32
HTTP Method: POST
Flat Path: projects/{project}/global/firewallPolicies/{firewallPolicy}/addRule
Path: projects/{project}/global/firewallPolicies/{firewallPolicy}/addRule
Parameter Order:
Scopes:
▼ ▲ compute.networkFirewallPolicies.getAssociation
HTTP Method: GET
Path: projects/{project}/global/firewallPolicies/{firewallPolicy}/getAssociation
Description: Gets an association with the specified name.
Parameter Order:
Parameters:
name
Type: string
Location: query
Description: The name of the association to get from the firewall policy.
project
Type: string
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Required: Yes
Description: Project ID for this request.
Location: path
firewallPolicy
Required: Yes
Type: string
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location: path
Description: Name of the firewall policy to which the queried association belongs.
Flat Path: projects/{project}/global/firewallPolicies/{firewallPolicy}/getAssociation
Scopes:
▼ ▲ compute.networkFirewallPolicies.list
Description: Lists all the policies that have been configured for the specified project.
HTTP Method: GET
Parameter Order: project
Flat Path: projects/{project}/global/firewallPolicies
Scopes:
Parameters:
returnPartialSuccess
Description: Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
Type: boolean
Location: query
project
Required: Yes
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Type: string
Description: Project ID for this request.
Location: path
filter
Description: A filter expression that filters resources listed in the response. The expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ```
Location: query
Type: string
maxResults
Format: uint32
Minimum: 0
Description: The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
Default: 500
Location: query
Type: integer
orderBy
Description: Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.
Type: string
Location: query
pageToken
Type: string
Description: Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
Location: query
Path: projects/{project}/global/firewallPolicies
▼ ▲ compute.networkFirewallPolicies.removeRule
Parameter Order:
Flat Path: projects/{project}/global/firewallPolicies/{firewallPolicy}/removeRule
Parameters:
firewallPolicy
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type: string
Location: path
Required: Yes
Description: Name of the firewall policy to update.
priority
Description: The priority of the rule to remove from the firewall policy.
Format: int32
Location: query
Type: integer
requestId
Type: string
Description: An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
Location: query
project
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Description: Project ID for this request.
Type: string
Location: path
Required: Yes
Description: Deletes a rule of the specified priority.
HTTP Method: POST
Scopes:
Path: projects/{project}/global/firewallPolicies/{firewallPolicy}/removeRule
▼ ▲ compute.networkFirewallPolicies.getIamPolicy
Scopes:
HTTP Method: GET
Parameter Order:
Path: projects/{project}/global/firewallPolicies/{resource}/getIamPolicy
Description: Gets the access control policy for a resource. May be empty if no such policy or resource exists.
Flat Path: projects/{project}/global/firewallPolicies/{resource}/getIamPolicy
Parameters:
optionsRequestedPolicyVersion
Location: query
Type: integer
Format: int32
Description: Requested IAM Policy version.
project
Description: Project ID for this request.
Required: Yes
Location: path
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Type: string
resource
Required: Yes
Type: string
Description: Name or id of the resource for this request.
Pattern: [a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location: path