Method: firewallPolicies.getRule

Gets a rule of the specified priority.

HTTP request

GET https://compute.googleapis.com/compute/beta/locations/global/{resourceId=firewallPolicies/*}/getRule

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
resourceId

string

Name of the firewall policy to which the queried rule belongs.

Query parameters

Parameters
priority

integer

The priority of the rule to get from the firewall policy.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny).

JSON representation 
{
  "description": string,
  "priority": integer,
  "match": {
    "srcIpRanges": [
      string
    ],
    "destIpRanges": [
      string
    ],
    "layer4Configs": [
      {
        "ipProtocol": string,
        "ports": [
          string
        ]
      }
    ]
  },
  "action": string,
  "direction": enum,
  "targetResources": [
    string
  ],
  "enableLogging": boolean,
  "ruleTupleCount": integer,
  "targetServiceAccounts": [
    string
  ],
  "disabled": boolean,
  "kind": string
}
Fields
description

string

An optional description for this resource.
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.
match

object

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

string

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

string

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

object

Pairs of IP protocols and ports that the rule should match.
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.
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"].
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.
direction

enum

The direction in which this rule applies.
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.
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.
ruleTupleCount

integer

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

string

A list of service accounts indicating the sets of instances that are applied with this rule.
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.
kind

string

[Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/compute
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

In addition to any permissions specified on the fields above, authorization requires one or more of the following IAM permissions:

  • compute.firewallPolicies.get

To find predefined roles that contain those permissions, see Compute Engine IAM Roles.