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