Skip to main content

network_firewall_policies

Overview

Namenetwork_firewall_policies
TypeResource
Idgoogle.compute.network_firewall_policies

Fields

NameDatatypeDescription
idstring[Output Only] The unique identifier for the resource. This identifier is defined by the server.
namestringName of the resource. For Organization Firewall Policies it's a [Output Only] numeric ID allocated by Google Cloud which uniquely identifies the Organization Firewall Policy.
descriptionstringAn optional description of this resource. Provide this property when you create the resource.
shortNamestringUser-provided name of the Organization firewall policy. The name should be unique in the organization in which the firewall policy is created. This field is not applicable to network firewall policies. This name must be set on creation and cannot be changed. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
associationsarrayA list of associations that belong to this firewall policy.
kindstring[Output only] Type of the resource. Always compute#firewallPolicyfor firewall policies
parentstring[Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies.
displayNamestringDeprecated, please use short name instead. User-provided name of the Organization firewall policy. The name should be unique in the organization in which the firewall policy is created. This field is not applicable to network firewall policies. This name must be set on creation and cannot be changed. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
selfLinkstring[Output Only] Server-defined URL for the resource.
fingerprintstringSpecifies a fingerprint for this resource, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make get() request to the firewall policy.
selfLinkWithIdstring[Output Only] Server-defined URL for this resource with the resource id.
regionstring[Output Only] URL of the region where the regional firewall policy resides. This field is not applicable to global firewall policies. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
creationTimestampstring[Output Only] Creation timestamp in RFC3339 text format.
rulesarrayA list of rules that belong to this policy. There must always be a default rule (rule with priority 2147483647 and match "*"). If no rules are provided when creating a firewall policy, a default rule with action "allow" will be added.
ruleTupleCountinteger[Output Only] Total count of all firewall policy rule tuples. A firewall policy can not exceed a set number of tuples.

Methods

NameAccessible byRequired ParamsDescription
getSELECTfirewallPolicy, projectReturns the specified network firewall policy.
listSELECTprojectLists all the policies that have been configured for the specified project.
insertINSERTprojectCreates a new policy in the specified project using the data included in the request.
deleteDELETEfirewallPolicy, projectDeletes the specified policy.
clone_rulesEXECfirewallPolicy, projectCopies rules to the specified firewall policy.
patchEXECfirewallPolicy, projectPatches the specified policy with the data included in the request.
patch_ruleEXECfirewallPolicy, projectPatches a rule of the specified priority.