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