REST Resource: networkFirewallPolicies

Resource: FirewallPolicy

Represents a Firewall Policy resource.

JSON representation
{
  "kind": string,
  "id": string,
  "creationTimestamp": string,
  "name": string,
  "description": string,
  "rules": [
    {
      object (Rule)
    }
  ],
  "fingerprint": string,
  "selfLink": string,
  "selfLinkWithId": string,
  "associations": [
    {
      object (Association)
    }
  ],
  "ruleTupleCount": integer,
  "shortName": string,
  "displayName": string,
  "parent": string,
  "region": string
}
Fields
kind

string

[Output only] Type of the resource. Always

compute#firewallPolicy

for firewall policies

id

string (uint64 format)

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.

name

string

Name 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.

description

string

An optional description of this resource. Provide this property when you create the resource.

rules[]

object (Rule)

A 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.

fingerprint

string (bytes format)

Specifies 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.

A base64-encoded string.

associations[]

object (Association)

A list of associations that belong to this firewall policy.

ruleTupleCount

integer

[Output Only] Total count of all firewall policy rule tuples. A firewall policy can not exceed a set number of tuples.

shortName

string

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.

displayName
(deprecated)

string

Deprecated, 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.

parent

string

[Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies.

region

string

[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.

Methods

addAssociation

The method compute.v1.NetworkFirewallPoliciesService.AddAssociation is not available in this (s3nsapis.fr) universe.

addRule

The method compute.v1.NetworkFirewallPoliciesService.AddRule is not available in this (s3nsapis.fr) universe.

aggregatedList

The method compute.v1.NetworkFirewallPoliciesService.AggregatedList is not available in this (s3nsapis.fr) universe.

cloneRules

The method compute.v1.NetworkFirewallPoliciesService.CloneRules is not available in this (s3nsapis.fr) universe.

delete

The method compute.v1.NetworkFirewallPoliciesService.Delete is not available in this (s3nsapis.fr) universe.

get

The method compute.v1.NetworkFirewallPoliciesService.Get is not available in this (s3nsapis.fr) universe.

getAssociation

The method compute.v1.NetworkFirewallPoliciesService.GetAssociation is not available in this (s3nsapis.fr) universe.

getIamPolicy

The method compute.v1.NetworkFirewallPoliciesService.GetPolicy is not available in this (s3nsapis.fr) universe.

getRule

The method compute.v1.NetworkFirewallPoliciesService.GetRule is not available in this (s3nsapis.fr) universe.

insert

The method compute.v1.NetworkFirewallPoliciesService.Insert is not available in this (s3nsapis.fr) universe.

list

The method compute.v1.NetworkFirewallPoliciesService.List is not available in this (s3nsapis.fr) universe.

patch

The method compute.v1.NetworkFirewallPoliciesService.Patch is not available in this (s3nsapis.fr) universe.

patchRule

The method compute.v1.NetworkFirewallPoliciesService.PatchRule is not available in this (s3nsapis.fr) universe.

removeAssociation

The method compute.v1.NetworkFirewallPoliciesService.RemoveAssociation is not available in this (s3nsapis.fr) universe.

removeRule

The method compute.v1.NetworkFirewallPoliciesService.RemoveRule is not available in this (s3nsapis.fr) universe.

setIamPolicy

The method compute.v1.NetworkFirewallPoliciesService.SetPolicy is not available in this (s3nsapis.fr) universe.

testIamPermissions

The method compute.v1.NetworkFirewallPoliciesService.TestPermissions is not available in this (s3nsapis.fr) universe.