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