2022-03-01
▼ ▲ compute.networkFirewallPolicies.getAssociation
HTTP Method: GET
Path: projects/{project}/global/firewallPolicies/{firewallPolicy}/getAssociation
Parameter Order:
Scopes:
Description: Gets an association with the specified name.
Flat Path: projects/{project}/global/firewallPolicies/{firewallPolicy}/getAssociation
Parameters:
firewallPolicy
Required: Yes
Description: Name of the firewall policy to which the queried association belongs.
Type: string
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location: path
name
Type: string
Description: The name of the association to get from the firewall policy.
Location: query
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])?))
Location: path
Type: string
Required: Yes
▼ ▲ compute.networkFirewallPolicies.getIamPolicy
Scopes:
Path: projects/{project}/global/firewallPolicies/{resource}/getIamPolicy
Parameters:
project
Location: path
Description: Project ID for this request.
Type: string
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])?))
resource
Required: Yes
Pattern: [a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type: string
Description: Name or id of the resource for this request.
Location: path
optionsRequestedPolicyVersion
Description: Requested IAM Policy version.
Type: integer
Format: int32
Location: query
HTTP Method: GET
Flat 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.
Parameter Order:
▼ ▲ compute.networkFirewallPolicies.testIamPermissions
Description: Returns permissions that a caller has on the specified resource.
Parameter Order:
Scopes:
HTTP Method: POST
Flat Path: projects/{project}/global/firewallPolicies/{resource}/testIamPermissions
Path: projects/{project}/global/firewallPolicies/{resource}/testIamPermissions
Parameters:
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
resource
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 or id of the resource for this request.
▼ ▲ compute.networkFirewallPolicies.patch
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
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.
firewallPolicy
Description: Name of the firewall policy to update.
Location: path
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required: Yes
Type: string
Path: projects/{project}/global/firewallPolicies/{firewallPolicy}
Scopes:
HTTP Method: PATCH
Description: Patches the specified policy with the data included in the request.
Flat Path: projects/{project}/global/firewallPolicies/{firewallPolicy}
Parameter Order:
▼ ▲ compute.networkFirewallPolicies.setIamPolicy
Parameter Order:
Flat Path: projects/{project}/global/firewallPolicies/{resource}/setIamPolicy
Parameters:
resource
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 or id of the resource for this request.
project
Type: string
Description: Project ID for this request.
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])?))
Required: Yes
HTTP Method: POST
Description: Sets the access control policy on the specified resource. Replaces any existing policy.
Path: projects/{project}/global/firewallPolicies/{resource}/setIamPolicy
Scopes:
▼ ▲ compute.networkFirewallPolicies.patchRule
Description: Patches a rule of the specified priority.
Scopes:
Path: projects/{project}/global/firewallPolicies/{firewallPolicy}/patchRule
Parameter Order:
Parameters:
firewallPolicy
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 of the firewall policy to update.
priority
Location: query
Type: integer
Description: The priority of the rule to patch.
Format: int32
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
Location: path
Type: string
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
HTTP Method: POST
Flat Path: projects/{project}/global/firewallPolicies/{firewallPolicy}/patchRule
▼ ▲ compute.networkFirewallPolicies.cloneRules
Scopes:
Parameter Order:
Flat Path: projects/{project}/global/firewallPolicies/{firewallPolicy}/cloneRules
Path: projects/{project}/global/firewallPolicies/{firewallPolicy}/cloneRules
Description: Copies rules to the specified firewall policy.
Parameters:
project
Description: Project ID for this request.
Location: path
Type: string
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])?))
firewallPolicy
Description: Name of the firewall policy to update.
Required: Yes
Location: path
Type: string
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
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
sourceFirewallPolicy
Description: The firewall policy from which to copy rules.
Type: string
Location: query
HTTP Method: POST
▼ ▲ compute.networkFirewallPolicies.removeAssociation
Path: projects/{project}/global/firewallPolicies/{firewallPolicy}/removeAssociation
HTTP Method: POST
Description: Removes an association for the specified firewall policy.
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
name
Description: Name for the attachment that will be removed.
Location: query
Type: string
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])?))
firewallPolicy
Description: Name of the firewall policy to update.
Type: string
Location: path
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required: Yes
Scopes:
Parameter Order:
Flat Path: projects/{project}/global/firewallPolicies/{firewallPolicy}/removeAssociation
▼ ▲ compute.networkFirewallPolicies.removeRule
Path: projects/{project}/global/firewallPolicies/{firewallPolicy}/removeRule
Flat Path: projects/{project}/global/firewallPolicies/{firewallPolicy}/removeRule
Scopes:
Parameter Order:
HTTP Method: POST
Parameters:
firewallPolicy
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
Type: string
Location: path
priority
Location: query
Format: int32
Type: integer
Description: The priority of the rule to remove from the firewall policy.
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
project
Type: string
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])?))
Location: path
Description: Project ID for this request.
Description: Deletes a rule of the specified priority.
▼ ▲ compute.networkFirewallPolicies.delete
Scopes:
Parameters:
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
firewallPolicy
Description: Name of the firewall policy to delete.
Required: Yes
Location: path
Type: string
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
project
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])?))
Type: string
Description: Deletes the specified policy.
Path: projects/{project}/global/firewallPolicies/{firewallPolicy}
Parameter Order:
Flat Path: projects/{project}/global/firewallPolicies/{firewallPolicy}
HTTP Method: DELETE
▼ ▲ compute.networkFirewallPolicies.addAssociation
Parameter Order:
Parameters:
replaceExistingAssociation
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.
Location: query
Type: boolean
firewallPolicy
Location: path
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type: string
Required: Yes
Description: Name of the firewall policy to update.
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
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.
Required: Yes
Scopes:
Flat Path: projects/{project}/global/firewallPolicies/{firewallPolicy}/addAssociation
Path: projects/{project}/global/firewallPolicies/{firewallPolicy}/addAssociation
HTTP Method: POST
Description: Inserts an association for the specified firewall policy.
▼ ▲ compute.networkFirewallPolicies.addRule
Flat Path: projects/{project}/global/firewallPolicies/{firewallPolicy}/addRule
Scopes:
Description: Inserts a rule into a firewall policy.
Parameter Order:
HTTP Method: POST
Parameters:
firewallPolicy
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
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
minPriority
Location: query
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.
project
Type: string
Description: Project ID for this request.
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])?))
Required: Yes
maxPriority
Location: query
Description: When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority>. This field is exclusive with rule.priority.
Format: int32
Type: integer
Path: projects/{project}/global/firewallPolicies/{firewallPolicy}/addRule
▼ ▲ compute.networkFirewallPolicies.getRule
Scopes:
Parameters:
firewallPolicy
Location: path
Required: Yes
Description: Name of the firewall policy to which the queried rule belongs.
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type: string
project
Description: Project ID for this request.
Type: string
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])?))
Location: path
priority
Description: The priority of the rule to get from the firewall policy.
Location: query
Type: integer
Format: int32
Description: Gets a rule of the specified priority.
Path: projects/{project}/global/firewallPolicies/{firewallPolicy}/getRule
Parameter Order:
HTTP Method: GET
Flat Path: projects/{project}/global/firewallPolicies/{firewallPolicy}/getRule
▼ ▲ compute.networkFirewallPolicies.get
Parameter Order:
Description: Returns the specified network firewall policy.
Path: projects/{project}/global/firewallPolicies/{firewallPolicy}
Parameters:
firewallPolicy
Location: path
Description: Name of the firewall policy to get.
Type: string
Required: Yes
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
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.
HTTP Method: GET
Flat Path: projects/{project}/global/firewallPolicies/{firewallPolicy}
Scopes:
▼ ▲ compute.networkFirewallPolicies.insert
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).
Type: string
Location: query
project
Type: string
Required: Yes
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])?))
Flat Path: projects/{project}/global/firewallPolicies
Path: projects/{project}/global/firewallPolicies
HTTP Method: POST
Description: Creates a new policy in the specified project using the data included in the request.
Parameter Order: project
▼ ▲ compute.networkFirewallPolicies.list
Flat Path: projects/{project}/global/firewallPolicies
Parameter Order: project
Path: projects/{project}/global/firewallPolicies
Description: Lists all the policies that have been configured for the specified project.
Scopes:
HTTP Method: GET
Parameters:
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) ```
Type: string
Location: query
returnPartialSuccess
Type: boolean
Location: query
Description: Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
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])?))
Description: Project ID for this request.
Required: Yes
Location: path
pageToken
Location: query
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.
maxResults
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`)
Minimum: 0
Location: query
Type: integer
Default: 500
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
▼ ▲ compute.regionNetworkFirewallPolicies.patch
Scopes:
HTTP Method: PATCH
Description: Patches the specified network firewall policy.
Flat Path: projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}
Path: projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}
Parameter Order:
Parameters:
region
Required: Yes
Location: path
Type: string
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description: Name of the region scoping this request.
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
firewallPolicy
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type: string
Required: Yes
Location: path
Description: Name of the firewall policy to update.
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.
Type: string
Required: Yes
▼ ▲ compute.regionNetworkFirewallPolicies.getAssociation
Scopes:
Flat Path: projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/getAssociation
HTTP Method: GET
Description: Gets an association with the specified name.
Parameter Order:
Path: projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/getAssociation
Parameters:
firewallPolicy
Location: path
Required: Yes
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 which the queried association belongs.
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.
Location: path
Type: string
Required: Yes
region
Type: string
Required: Yes
Location: path
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description: Name of the region scoping this request.
name
Type: string
Location: query
Description: The name of the association to get from the firewall policy.
▼ ▲ compute.regionNetworkFirewallPolicies.patchRule
Parameters:
priority
Location: query
Format: int32
Description: The priority of the rule to patch.
Type: integer
region
Description: Name of the region scoping this request.
Required: Yes
Type: string
Location: path
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).
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])?))
Description: Project ID for this request.
Location: path
Required: Yes
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.
Type: string
Location: path
Required: Yes
HTTP Method: POST
Flat Path: projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/patchRule
Scopes:
Path: projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/patchRule
Parameter Order:
Description: Patches a rule of the specified priority.
▼ ▲ compute.regionNetworkFirewallPolicies.setIamPolicy
Flat Path: projects/{project}/regions/{region}/firewallPolicies/{resource}/setIamPolicy
Parameters:
resource
Location: path
Required: Yes
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type: string
Description: Name or id of the resource for this request.
project
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.
Required: Yes
region
Required: Yes
Type: string
Location: path
Description: The name of the region for this request.
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description: Sets the access control policy on the specified resource. Replaces any existing policy.
Parameter Order:
Scopes:
HTTP Method: POST
Path: projects/{project}/regions/{region}/firewallPolicies/{resource}/setIamPolicy
▼ ▲ compute.regionNetworkFirewallPolicies.getRule
Path: projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/getRule
Parameters:
firewallPolicy
Location: path
Description: Name of the firewall policy to which the queried rule belongs.
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required: Yes
Type: string
region
Type: string
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description: Name of the region scoping this request.
Required: Yes
Location: path
project
Location: path
Required: Yes
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])?))
priority
Format: int32
Description: The priority of the rule to get from the firewall policy.
Location: query
Type: integer
Parameter Order:
Description: Gets a rule of the specified priority.
HTTP Method: GET
Flat Path: projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/getRule
Scopes:
▼ ▲ compute.regionNetworkFirewallPolicies.delete
Description: Deletes the specified network firewall policy.
Parameters:
firewallPolicy
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 delete.
Required: Yes
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
region
Location: path
Required: Yes
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type: string
Description: Name of the region scoping 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).
HTTP Method: DELETE
Path: projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}
Scopes:
Flat Path: projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}
Parameter Order:
▼ ▲ compute.regionNetworkFirewallPolicies.testIamPermissions
Scopes:
Parameter Order:
Description: Returns permissions that a caller has on the specified resource.
Flat Path: projects/{project}/regions/{region}/firewallPolicies/{resource}/testIamPermissions
Path: projects/{project}/regions/{region}/firewallPolicies/{resource}/testIamPermissions
HTTP Method: POST
Parameters:
resource
Description: Name or id of the resource for this request.
Location: path
Required: Yes
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type: string
region
Location: path
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type: string
Required: Yes
Description: The name of the region for this request.
project
Location: path
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
▼ ▲ compute.regionNetworkFirewallPolicies.cloneRules
HTTP Method: POST
Scopes:
Parameters:
sourceFirewallPolicy
Description: The firewall policy from which to copy rules.
Type: string
Location: query
firewallPolicy
Location: path
Description: Name of the firewall policy to update.
Required: Yes
Type: string
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
region
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description: Name of the region scoping this request.
Location: path
Type: string
Required: Yes
project
Type: string
Required: Yes
Description: Project ID for this request.
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])?))
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
Parameter Order:
Flat Path: projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/cloneRules
Description: Copies rules to the specified network firewall policy.
Path: projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/cloneRules
▼ ▲ compute.regionNetworkFirewallPolicies.insert
Scopes:
HTTP Method: POST
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
region
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required: Yes
Description: Name of the region scoping this request.
Type: string
Location: path
project
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])?))
Description: Project ID for this request.
Path: projects/{project}/regions/{region}/firewallPolicies
Flat Path: projects/{project}/regions/{region}/firewallPolicies
Description: Creates a new network firewall policy in the specified project and region.
▼ ▲ compute.regionNetworkFirewallPolicies.removeAssociation
Scopes:
Parameter Order:
Flat Path: projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/removeAssociation
Parameters:
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
name
Description: Name for the association that will be removed.
Type: string
Location: query
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
region
Required: Yes
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description: Name of the region scoping this request.
Type: string
Location: path
firewallPolicy
Location: path
Type: string
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}
Path: projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/removeAssociation
Description: Removes an association for the specified network firewall policy.
HTTP Method: POST
▼ ▲ compute.regionNetworkFirewallPolicies.addAssociation
Scopes:
Description: Inserts an association for the specified network firewall policy.
HTTP Method: POST
Flat Path: projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/addAssociation
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
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.
Location: path
region
Description: Name of the region scoping this request.
Location: path
Type: string
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required: Yes
firewallPolicy
Required: Yes
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 update.
Type: string
replaceExistingAssociation
Type: boolean
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.
Location: query
Parameter Order:
Path: projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/addAssociation
▼ ▲ compute.regionNetworkFirewallPolicies.getEffectiveFirewalls
Scopes:
HTTP Method: GET
Parameters:
region
Required: Yes
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location: path
Type: string
Description: Name of the region scoping this request.
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.
network
Location: query
Description: Network reference
Required: Yes
Type: string
Path: projects/{project}/regions/{region}/firewallPolicies/getEffectiveFirewalls
Description: Returns the effective firewalls on a given network.
Parameter Order:
Flat Path: projects/{project}/regions/{region}/firewallPolicies/getEffectiveFirewalls
▼ ▲ compute.regionNetworkFirewallPolicies.addRule
Flat Path: projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/addRule
Description: Inserts a rule into a network firewall policy.
Scopes:
HTTP Method: POST
Parameters:
region
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description: Name of the region scoping this request.
Required: Yes
Type: string
Location: path
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
maxPriority
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
Type: integer
Format: int32
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 update.
Required: Yes
Location: path
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).
minPriority
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
Type: integer
Format: int32
Parameter Order:
Path: projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/addRule
▼ ▲ compute.regionNetworkFirewallPolicies.getIamPolicy
Flat Path: projects/{project}/regions/{region}/firewallPolicies/{resource}/getIamPolicy
Scopes:
Parameter Order:
Parameters:
region
Location: path
Required: Yes
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type: string
Description: The name of the region for this request.
resource
Location: path
Description: Name or id of the resource for this request.
Type: string
Required: Yes
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
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])?))
Type: string
Description: Project ID for this request.
Required: Yes
optionsRequestedPolicyVersion
Type: integer
Format: int32
Location: query
Description: Requested IAM Policy version.
Path: projects/{project}/regions/{region}/firewallPolicies/{resource}/getIamPolicy
Description: Gets the access control policy for a resource. May be empty if no such policy or resource exists.
HTTP Method: GET
▼ ▲ compute.regionNetworkFirewallPolicies.get
Flat Path: projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}
Parameters:
firewallPolicy
Required: Yes
Location: path
Description: Name of the firewall policy to get.
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type: string
project
Location: path
Type: string
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])?))
Description: Project ID for this request.
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
Path: projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}
Description: Returns the specified network firewall policy.
Scopes:
Parameter Order:
HTTP Method: GET
▼ ▲ compute.regionNetworkFirewallPolicies.removeRule
Parameter Order:
Path: projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/removeRule
HTTP Method: POST
Flat Path: projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/removeRule
Scopes:
Description: Deletes a rule of the specified priority.
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
priority
Description: The priority of the rule to remove from the firewall policy.
Type: integer
Location: query
Format: int32
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])?
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])?))
Required: Yes
Location: path
Description: Project ID for this request.
Type: string
firewallPolicy
Required: Yes
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.
▼ ▲ compute.regionNetworkFirewallPolicies.list
Parameter Order:
Path: projects/{project}/regions/{region}/firewallPolicies
HTTP Method: GET
Description: Lists all the network firewall policies that have been configured for the specified project in the given region.
Scopes:
Flat Path: projects/{project}/regions/{region}/firewallPolicies
Parameters:
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
orderBy
Location: query
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
region
Required: Yes
Location: path
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type: string
Description: Name of the region scoping this request.
filter
Location: query
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) ```
Type: string
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
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
Description: Project ID for this request.
Type: string
Required: Yes
maxResults
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`)
Location: query
Default: 500
Type: integer
Minimum: 0
Format: uint32