REST Resource: firewallPolicies

Resource: FirewallPolicy

Represents a Firewall Policy resource.

JSON representation 
{
  "id": string,
  "creationTimestamp": string,
  "name": string,
  "description": string,
  "rules": [
    {
      "description": string,
      "priority": integer,
      "match": {
        "srcIpRanges": [
          string
        ],
        "destIpRanges": [
          string
        ],
        "layer4Configs": [
          {
            "ipProtocol": string,
            "ports": [
              string
            ]
          }
        ],
        "srcSecureLabels": [
          string
        ]
      },
      "action": string,
      "direction": enum,
      "targetResources": [
        string
      ],
      "enableLogging": boolean,
      "ruleTupleCount": integer,
      "targetServiceAccounts": [
        string
      ],
      "targetSecureLabels": [
        string
      ],
      "disabled": boolean,
      "kind": string
    }
  ],
  "fingerprint": string,
  "selfLink": string,
  "selfLinkWithId": string,
  "associations": [
    {
      "name": string,
      "attachmentTarget": string,
      "firewallPolicyId": string,
      "shortName": string,
      "displayName": string
    }
  ],
  "ruleTupleCount": integer,
  "shortName": string,
  "displayName": string,
  "parent": string,
  "kind": string
}
Fields
id

string (fixed64 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

[Output Only] Name of the resource. It is a numeric ID allocated by GCP which uniquely identifies the Firewall Policy.
description

string

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

object

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.
rules[].description

string

An optional description for this resource.
rules[].priority

integer

An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority.
rules[].match

object

A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.
rules[].match.srcIpRanges[]

string

CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 256.
rules[].match.destIpRanges[]

string

CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 256.
rules[].match.layer4Configs[]

object

Pairs of IP protocols and ports that the rule should match.
rules[].match.layer4Configs[].ipProtocol

string

The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number.
rules[].match.layer4Configs[].ports[]

string

An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port.

Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
rules[].match.srcSecureLabels[]
(deprecated)

string

globalOperations.list of firewall label values, which should be matched at the source of the traffic. Maximum number of source label values allowed is 256.
rules[].action

string

The Action to perform when the client connection triggers the rule. Can currently be either "allow" or "deny()" where valid values for status are 403, 404, and 502.
rules[].direction

enum

The direction in which this rule applies.
rules[].targetResources[]

string

A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule.
rules[].enableLogging

boolean

Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules.
rules[].ruleTupleCount

integer

[Output Only] Calculation of the complexity of a single firewall policy rule.
rules[].targetServiceAccounts[]

string

A list of service accounts indicating the sets of instances that are applied with this rule.
rules[].targetSecureLabels[]
(deprecated)

string

A list of secure labels that controls which instances the firewall rule applies to. If targetSecureLabel are specified, then the firewall rule applies only to instances in the VPC network that have one of those secure labels. targetSecureLabel may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureLabel are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label values allowed is 256.
rules[].disabled

boolean

Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled.
rules[].kind

string

[Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules
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

A list of associations that belong to this firewall policy.
associations[].name

string

The name for an association.
associations[].attachmentTarget

string

The target that the firewall policy is attached to.
associations[].firewallPolicyId

string

[Output Only] The firewall policy ID of the association.
associations[].shortName

string

[Output Only] The short name of the firewall policy of the association.
associations[].displayName
(deprecated)

string

[Output Only] Deprecated, please use short name instead. The display name of the firewall policy of the association.
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 plicy. The name should be unique in the organization in which the firewall policy is created. 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

Depreacted, please use short name instead. User-provided name of the Organization firewall plicy. The name should be unique in the organization in which the firewall policy is created. 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.
kind

string

[Output only] Type of the resource. Always compute#firewallPolicyfor firewall policies

Methods

addAssociation

 Inserts an association for the specified firewall policy.

addRule

 Inserts a rule into a firewall policy.

cloneRules

 Copies rules to the specified firewall policy.

delete

 Deletes the specified policy.

get

 Returns the specified firewall policy.

getAssociation

 Gets an association with the specified name.

getIamPolicy

 Gets the access control policy for a resource.

getRule

 Gets a rule of the specified priority.

insert

 Creates a new policy in the specified project using the data included in the request.

list

 Lists all the policies that have been configured for the specified project.

listAssociations

 Lists associations of a specified target, i.e., organization or folder.

move

 Moves the specified firewall policy.

patch

 Patches the specified policy with the data included in the request.

patchRule

 Patches a rule of the specified priority.

removeAssociation

 Removes an association for the specified firewall policy.

removeRule

 Deletes a rule of the specified priority.

setIamPolicy

 Sets the access control policy on the specified resource.

testIamPermissions

 Returns permissions that a caller has on the specified resource.