2022-02-12
▼ ▲ compute.regionNetworkFirewallPolicies.delete
Description: Deletes the specified network firewall policy.
Scopes:
Path: projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}
Parameter Order:
HTTP Method: DELETE
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
firewallPolicy
Location: path
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type: string
Description: Name of the firewall policy to delete.
Required: Yes
project
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Type: string
Location: path
Required: Yes
Description: Project ID for this request.
region
Required: Yes
Description: Name of the region scoping this request.
Location: path
Type: string
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Flat Path: projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}
▼ ▲ compute.regionNetworkFirewallPolicies.addAssociation
Parameter Order:
Scopes:
Description: Inserts an association for the specified network firewall policy.
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
Location: path
Description: Project ID for this request.
Required: Yes
firewallPolicy
Type: string
Required: Yes
Location: path
Description: Name of the firewall policy to update.
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
region
Description: Name of the region scoping this request.
Type: string
Location: path
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required: Yes
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
replaceExistingAssociation
Type: boolean
Location: query
Description: Indicates whether or not to replace it if an association already exists. This is false by default, in which case an error will be returned if an association already exists.
HTTP Method: POST
Flat Path: projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/addAssociation
Path: projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/addAssociation
▼ ▲ compute.regionNetworkFirewallPolicies.getAssociation
Path: projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/getAssociation
HTTP Method: GET
Parameter Order:
Scopes:
Flat Path: projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/getAssociation
Parameters:
name
Description: The name of the association to get from the firewall policy.
Location: query
Type: string
region
Description: Name of the region scoping this request.
Required: Yes
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type: string
Location: path
firewallPolicy
Required: Yes
Location: path
Description: Name of the firewall policy to which the queried association belongs.
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
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
Description: Project ID for this request.
Required: Yes
Type: string
Description: Gets an association with the specified name.
▼ ▲ compute.regionNetworkFirewallPolicies.removeAssociation
Parameter Order:
Scopes:
Parameters:
requestId
Location: query
Type: string
Description: An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
name
Type: string
Location: query
Description: Name for the association that will be removed.
region
Location: path
Type: string
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description: Name of the region scoping this request.
Required: Yes
project
Description: Project ID for this request.
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
firewallPolicy
Type: string
Location: path
Description: Name of the firewall policy to update.
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required: Yes
Flat Path: projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/removeAssociation
HTTP Method: POST
Path: projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/removeAssociation
Description: Removes an association for the specified network firewall policy.
▼ ▲ compute.regionNetworkFirewallPolicies.setIamPolicy
Flat Path: projects/{project}/regions/{region}/firewallPolicies/{resource}/setIamPolicy
Scopes:
Parameter Order:
Description: Sets the access control policy on the specified resource. Replaces any existing policy.
Path: projects/{project}/regions/{region}/firewallPolicies/{resource}/setIamPolicy
Parameters:
resource
Required: Yes
Description: Name or id of the resource for this request.
Location: path
Type: string
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
region
Location: path
Description: The name of the region for this request.
Type: string
Required: Yes
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])?))
Type: string
Required: Yes
Location: path
Description: Project ID for this request.
HTTP Method: POST
▼ ▲ compute.regionNetworkFirewallPolicies.list
Flat Path: projects/{project}/regions/{region}/firewallPolicies
Scopes:
Parameter Order:
HTTP Method: GET
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.
Parameters:
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`)
Type: integer
Location: query
Default: 500
Minimum: 0
Format: uint32
region
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type: string
Required: Yes
Location: path
Description: Name of the region scoping this request.
project
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
orderBy
Type: string
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.
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
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.
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
▼ ▲ compute.regionNetworkFirewallPolicies.get
Flat Path: projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}
Parameter Order:
Path: projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}
HTTP Method: GET
Parameters:
region
Type: string
Required: Yes
Description: Name of the region scoping this request.
Location: path
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
firewallPolicy
Type: string
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required: Yes
Description: Name of the firewall policy to get.
Location: path
project
Description: Project ID for this request.
Type: string
Required: Yes
Location: path
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Scopes:
Description: Returns the specified network firewall policy.
▼ ▲ compute.regionNetworkFirewallPolicies.removeRule
Path: projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/removeRule
HTTP Method: POST
Description: Deletes a rule of the specified priority.
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
region
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required: Yes
Description: Name of the region scoping this request.
Location: path
Type: string
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}
Location: path
Type: string
Required: Yes
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
priority
Type: integer
Location: query
Format: int32
Description: The priority of the rule to remove from the firewall policy.
Scopes:
Parameter Order:
Flat Path: projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/removeRule
▼ ▲ compute.regionNetworkFirewallPolicies.insert
HTTP Method: POST
Flat Path: projects/{project}/regions/{region}/firewallPolicies
Path: projects/{project}/regions/{region}/firewallPolicies
Scopes:
Description: Creates a new network firewall policy in the specified project and region.
Parameter Order:
Parameters:
project
Location: path
Description: Project ID for this request.
Required: Yes
Type: string
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
region
Location: path
Type: string
Description: Name of the region scoping this request.
Required: Yes
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
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).
▼ ▲ compute.regionNetworkFirewallPolicies.addRule
Scopes:
Parameters:
requestId
Description: An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
Location: query
Type: string
maxPriority
Type: integer
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
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
region
Description: Name of the region scoping this request.
Required: Yes
Location: path
Type: string
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
project
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: Project ID for this request.
firewallPolicy
Type: string
Required: Yes
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}
Location: path
Description: Inserts a rule into a network firewall policy.
Flat Path: projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/addRule
Parameter Order:
HTTP Method: POST
Path: projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/addRule
▼ ▲ compute.regionNetworkFirewallPolicies.patch
Description: Patches the specified network firewall policy.
Parameter Order:
Scopes:
Path: projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}
Flat Path: projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}
Parameters:
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])?))
Location: path
Description: Project ID for this request.
Type: string
firewallPolicy
Description: Name of the firewall policy to update.
Location: path
Type: string
Required: Yes
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
requestId
Description: An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
Location: query
Type: string
region
Description: Name of the region scoping this request.
Location: path
Type: string
Required: Yes
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
HTTP Method: PATCH
▼ ▲ compute.regionNetworkFirewallPolicies.patchRule
Description: Patches a rule of the specified priority.
Parameters:
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])?))
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).
priority
Location: query
Format: int32
Description: The priority of the rule to patch.
Type: integer
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
region
Description: Name of the region scoping this request.
Location: path
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required: Yes
Type: string
Scopes:
Path: projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/patchRule
Flat Path: projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/patchRule
Parameter Order:
HTTP Method: POST
▼ ▲ compute.regionNetworkFirewallPolicies.getEffectiveFirewalls
HTTP Method: GET
Scopes:
Path: projects/{project}/regions/{region}/firewallPolicies/getEffectiveFirewalls
Parameters:
network
Location: query
Description: Network reference
Type: string
Required: Yes
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.
region
Required: Yes
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location: path
Description: Name of the region scoping this request.
Type: string
Flat Path: projects/{project}/regions/{region}/firewallPolicies/getEffectiveFirewalls
Description: Returns the effective firewalls on a given network.
Parameter Order:
▼ ▲ compute.regionNetworkFirewallPolicies.cloneRules
Path: projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/cloneRules
Scopes:
Description: Copies rules to the specified network firewall policy.
Parameters:
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}
project
Type: string
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
region
Description: Name of the region scoping this request.
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required: Yes
Location: path
Type: string
sourceFirewallPolicy
Type: string
Location: query
Description: The firewall policy from which to copy rules.
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).
HTTP Method: POST
Flat Path: projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/cloneRules
Parameter Order:
▼ ▲ compute.regionNetworkFirewallPolicies.testIamPermissions
Parameter Order:
Path: projects/{project}/regions/{region}/firewallPolicies/{resource}/testIamPermissions
Parameters:
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])?))
resource
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required: Yes
Description: Name or id of the resource for this request.
Location: path
Type: string
region
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description: The name of the region for this request.
Required: Yes
Location: path
Type: string
Scopes:
HTTP Method: POST
Description: Returns permissions that a caller has on the specified resource.
Flat Path: projects/{project}/regions/{region}/firewallPolicies/{resource}/testIamPermissions
▼ ▲ compute.regionNetworkFirewallPolicies.getIamPolicy
Parameter Order:
Description: Gets the access control policy for a resource. May be empty if no such policy or resource exists.
Flat Path: projects/{project}/regions/{region}/firewallPolicies/{resource}/getIamPolicy
Parameters:
project
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Description: Project ID for this request.
Required: Yes
Type: string
Location: path
region
Location: path
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description: The name of the region for this request.
Required: Yes
Type: string
resource
Location: path
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required: Yes
Type: string
Description: Name or id of the resource for this request.
optionsRequestedPolicyVersion
Location: query
Type: integer
Description: Requested IAM Policy version.
Format: int32
Scopes:
Path: projects/{project}/regions/{region}/firewallPolicies/{resource}/getIamPolicy
HTTP Method: GET
▼ ▲ compute.regionNetworkFirewallPolicies.getRule
Scopes:
Path: projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/getRule
HTTP Method: GET
Flat Path: projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/getRule
Description: Gets a rule of the specified priority.
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}
Type: string
Required: Yes
region
Required: Yes
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type: string
Location: path
Description: Name of the region scoping this request.
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
Location: path
Description: Project ID for this request.
Required: Yes
priority
Format: int32
Description: The priority of the rule to get from the firewall policy.
Location: query
Type: integer
Parameter Order:
▼ ▲ compute.networkFirewallPolicies.addAssociation
Parameters:
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
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])?))
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
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
Parameter Order:
Scopes:
Path: projects/{project}/global/firewallPolicies/{firewallPolicy}/addAssociation
Flat Path: projects/{project}/global/firewallPolicies/{firewallPolicy}/addAssociation
Description: Inserts an association for the specified firewall policy.
HTTP Method: POST
▼ ▲ compute.networkFirewallPolicies.testIamPermissions
Description: Returns permissions that a caller has on the specified resource.
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
Location: path
Description: Project ID for this request.
resource
Location: path
Type: string
Required: Yes
Pattern: [a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description: Name or id of the resource for this request.
Flat Path: projects/{project}/global/firewallPolicies/{resource}/testIamPermissions
Scopes:
Parameter Order:
Path: projects/{project}/global/firewallPolicies/{resource}/testIamPermissions
HTTP Method: POST
▼ ▲ compute.networkFirewallPolicies.delete
Parameters:
firewallPolicy
Type: string
Description: Name of the firewall policy to delete.
Location: path
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])?))
Required: Yes
Description: Project ID for this request.
Type: string
requestId
Type: string
Location: query
Description: An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
Description: Deletes the specified policy.
Path: projects/{project}/global/firewallPolicies/{firewallPolicy}
Scopes:
HTTP Method: DELETE
Flat Path: projects/{project}/global/firewallPolicies/{firewallPolicy}
Parameter Order:
▼ ▲ compute.networkFirewallPolicies.insert
Flat Path: projects/{project}/global/firewallPolicies
Parameter Order: project
Scopes:
HTTP Method: POST
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
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.
Path: projects/{project}/global/firewallPolicies
▼ ▲ compute.networkFirewallPolicies.removeAssociation
HTTP Method: POST
Flat Path: projects/{project}/global/firewallPolicies/{firewallPolicy}/removeAssociation
Parameters:
firewallPolicy
Type: string
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location: path
Required: Yes
Description: Name of the firewall policy to update.
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
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])?))
name
Type: string
Description: Name for the attachment that will be removed.
Location: query
Description: Removes an association for the specified firewall policy.
Scopes:
Path: projects/{project}/global/firewallPolicies/{firewallPolicy}/removeAssociation
Parameter Order:
▼ ▲ compute.networkFirewallPolicies.list
Parameters:
pageToken
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
Location: query
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.
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) ```
maxResults
Minimum: 0
Format: uint32
Type: integer
Description: The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
Default: 500
Location: query
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.
returnPartialSuccess
Location: query
Type: boolean
Description: Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
Description: Lists all the policies that have been configured for the specified project.
HTTP Method: GET
Scopes:
Flat Path: projects/{project}/global/firewallPolicies
Parameter Order: project
Path: projects/{project}/global/firewallPolicies
▼ ▲ compute.networkFirewallPolicies.addRule
Path: projects/{project}/global/firewallPolicies/{firewallPolicy}/addRule
Flat Path: projects/{project}/global/firewallPolicies/{firewallPolicy}/addRule
HTTP Method: POST
Scopes:
Description: Inserts a rule into a firewall policy.
Parameter Order:
Parameters:
maxPriority
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
firewallPolicy
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required: Yes
Location: path
Type: string
Description: Name of the firewall policy to update.
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.
Location: query
Type: integer
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
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
▼ ▲ compute.networkFirewallPolicies.getIamPolicy
Scopes:
Parameters:
optionsRequestedPolicyVersion
Description: Requested IAM Policy version.
Location: query
Type: integer
Format: int32
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
resource
Required: Yes
Pattern: [a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description: Name or id of the resource for this request.
Type: string
Location: path
Description: Gets the access control policy for a resource. May be empty if no such policy or resource exists.
Flat Path: projects/{project}/global/firewallPolicies/{resource}/getIamPolicy
Path: projects/{project}/global/firewallPolicies/{resource}/getIamPolicy
HTTP Method: GET
Parameter Order:
▼ ▲ compute.networkFirewallPolicies.get
Path: projects/{project}/global/firewallPolicies/{firewallPolicy}
Flat Path: projects/{project}/global/firewallPolicies/{firewallPolicy}
Parameter Order:
Description: Returns the specified network firewall policy.
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])?))
Location: path
Required: Yes
firewallPolicy
Type: string
Description: Name of the firewall policy to get.
Location: path
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required: Yes
▼ ▲ compute.networkFirewallPolicies.patch
Path: projects/{project}/global/firewallPolicies/{firewallPolicy}
Parameters:
firewallPolicy
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.
Type: string
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
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
Description: Patches the specified policy with the data included in the request.
Scopes:
Flat Path: projects/{project}/global/firewallPolicies/{firewallPolicy}
Parameter Order:
HTTP Method: PATCH
▼ ▲ compute.networkFirewallPolicies.removeRule
Flat Path: projects/{project}/global/firewallPolicies/{firewallPolicy}/removeRule
Description: Deletes a rule of the specified priority.
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
priority
Location: query
Description: The priority of the rule to remove from the firewall policy.
Format: int32
Type: integer
requestId
Type: string
Description: An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
Location: query
firewallPolicy
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}
Type: string
Parameter Order:
Path: projects/{project}/global/firewallPolicies/{firewallPolicy}/removeRule
HTTP Method: POST
▼ ▲ compute.networkFirewallPolicies.getAssociation
Parameter Order:
Description: Gets an association with the specified name.
Path: projects/{project}/global/firewallPolicies/{firewallPolicy}/getAssociation
HTTP Method: GET
Parameters:
name
Type: string
Description: The name of the association to get from the firewall policy.
Location: query
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 which the queried association belongs.
Location: path
Required: Yes
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.
Flat Path: projects/{project}/global/firewallPolicies/{firewallPolicy}/getAssociation
Scopes:
▼ ▲ compute.networkFirewallPolicies.setIamPolicy
Parameter Order:
Description: Sets the access control policy on the specified resource. Replaces any existing policy.
Scopes:
Path: projects/{project}/global/firewallPolicies/{resource}/setIamPolicy
Flat Path: projects/{project}/global/firewallPolicies/{resource}/setIamPolicy
HTTP Method: POST
Parameters:
resource
Type: string
Description: Name or id of the resource for this request.
Location: path
Pattern: [a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required: Yes
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.
▼ ▲ compute.networkFirewallPolicies.cloneRules
Flat Path: projects/{project}/global/firewallPolicies/{firewallPolicy}/cloneRules
HTTP Method: POST
Parameters:
firewallPolicy
Description: Name of the firewall policy to update.
Type: string
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required: Yes
Location: path
project
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Description: Project ID for this request.
Required: Yes
Location: path
Type: string
sourceFirewallPolicy
Location: query
Type: string
Description: The firewall policy from which to copy rules.
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
Scopes:
Description: Copies rules to the specified firewall policy.
Path: projects/{project}/global/firewallPolicies/{firewallPolicy}/cloneRules
Parameter Order:
▼ ▲ compute.networkFirewallPolicies.patchRule
Path: projects/{project}/global/firewallPolicies/{firewallPolicy}/patchRule
HTTP Method: POST
Description: Patches a rule of the specified priority.
Flat Path: projects/{project}/global/firewallPolicies/{firewallPolicy}/patchRule
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
priority
Type: integer
Location: query
Description: The priority of the rule to patch.
Format: int32
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
Type: string
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location: path
Required: Yes
Description: Name of the firewall policy to update.
Scopes:
Parameter Order:
▼ ▲ compute.networkFirewallPolicies.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
priority
Type: integer
Format: int32
Location: query
Description: The priority of the rule to get from the firewall policy.
project
Required: Yes
Location: path
Description: Project ID for this request.
Type: string
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Description: Gets a rule of the specified priority.
HTTP Method: GET
Flat Path: projects/{project}/global/firewallPolicies/{firewallPolicy}/getRule
Path: projects/{project}/global/firewallPolicies/{firewallPolicy}/getRule
Scopes:
Parameter Order: