REST Resource: securityPolicies

Resource: SecurityPolicy
- JSON representation
  - JSON representation
    - JSON representation
Methods

Resource: SecurityPolicy

Represents a Cloud Armor Security Policy resource.

Only external backend services that use load balancers can reference a Security Policy. For more information, read Cloud Armor Security Policy Concepts.

JSON representation
{ "id": string, "creationTimestamp": string, "name": string, "description": string, "rules": [ { "description": string, "priority": integer, "match": { "expr": { "expression": string, "title": string, "description": string, "location": string }, "versionedExpr": enum, "config": { "srcIpRanges": [ string ], "destIpRanges": [ string ], "layer4Configs": [ { "ipProtocol": string, "ports": [ string ] } ] } }, "action": string, "preview": boolean, "direction": enum, "targetResources": [ string ], "enableLogging": boolean, "ruleTupleCount": integer, "targetServiceAccounts": [ string ], "kind": string } ], "fingerprint": string, "selfLink": string, "selfLinkWithId": string, "type": enum, "associations": [ { "name": string, "attachmentId": string, "securityPolicyId": string, "displayName": string } ], "labels": { string: string, ... }, "labelFingerprint": string, "ruleTupleCount": integer, "displayName": string, "parent": string, "kind": string }

JSON representation

{
  "id": string,
  "creationTimestamp": string,
  "name": string,
  "description": string,
  "rules": [
    {
      "description": string,
      "priority": integer,
      "match": {
        "expr": {
          "expression": string,
          "title": string,
          "description": string,
          "location": string
        },
        "versionedExpr": enum,
        "config": {
          "srcIpRanges": [
            string
          ],
          "destIpRanges": [
            string
          ],
          "layer4Configs": [
            {
              "ipProtocol": string,
              "ports": [
                string
              ]
            }
          ]
        }
      },
      "action": string,
      "preview": boolean,
      "direction": enum,
      "targetResources": [
        string
      ],
      "enableLogging": boolean,
      "ruleTupleCount": integer,
      "targetServiceAccounts": [
        string
      ],
      "kind": string
    }
  ],
  "fingerprint": string,
  "selfLink": string,
  "selfLinkWithId": string,
  "type": enum,
  "associations": [
    {
      "name": string,
      "attachmentId": string,
      "securityPolicyId": string,
      "displayName": string
    }
  ],
  "labels": {
    string: string,
    ...
  },
  "labelFingerprint": string,
  "ruleTupleCount": integer,
  "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` Name of the resource. Provided by the client when the resource 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.
`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 security policy, a default rule with action "allow" will be added.
`rules[].description`	`string` An optional description of this resource. Provide this property when you create the 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.expr`	`object` User defined CEVAL expression. A CEVAL expression is used to specify match criteria such as origin.ip, source.region_code and contents in the request header.
`rules[].match.expr.expression`	`string` Textual representation of an expression in Common Expression Language syntax.
`rules[].match.expr.title`	`string` Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
`rules[].match.expr.description`	`string` Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
`rules[].match.expr.location`	`string` Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
`rules[].match.versionedExpr`	`enum` Preconfigured versioned expression. If this field is specified, config must also be specified. Available preconfigured expressions along with their requirements are: SRC_IPS_V1 - must specify the corresponding srcIpRange field in config.
`rules[].match.config`	`object` The configuration options available when specifying versionedExpr. This field must be specified if versionedExpr is specified and cannot be specified if versionedExpr is not specified.
`rules[].match.config.srcIpRanges[]`	`string` CIDR IP address range.
`rules[].match.config.destIpRanges[]`	`string` CIDR IP address range. This field may only be specified when versionedExpr is set to FIREWALL.
`rules[].match.config.layer4Configs[]`	`object` Pairs of IP protocols and ports that the rule should match. This field may only be specified when versionedExpr is set to FIREWALL.
`rules[].match.config.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.config.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"]`. This field may only be specified when versionedExpr is set to FIREWALL.
`rules[].action`	`string` The Action to preform 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[].preview`	`boolean` If set to true, the specified action is not enforced.
`rules[].direction`	`enum` The direction in which this rule applies. This field may only be specified when versionedExpr is set to FIREWALL.
`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. This field may only be specified when versionedExpr is set to FIREWALL.
`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. This field may only be specified when the versionedExpr is set to FIREWALL.
`rules[].ruleTupleCount`	`integer` [Output Only] Calculation of the complexity of a single firewall security policy rule.
`rules[].targetServiceAccounts[]`	`string` A list of service accounts indicating the sets of instances that are applied with this rule.
`rules[].kind`	`string` [Output only] Type of the resource. Always `compute#securityPolicyRule` for security 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 security policy. A base64-encoded string.
`selfLink`	`string` [Output Only] Server-defined URL for the resource.
`selfLinkWithId`	`string` [Output Only] Server-defined URL for this resource with the resource id.
`type`	`enum` The type indicates the intended use of the security policy. CLOUD_ARMOR policies apply to backend services. FIREWALL policies apply to organizations.
`associations[]`	`object` A list of associations that belong to this policy.
`associations[].name`	`string` The name for an association.
`associations[].attachmentId`	`string` The resource that the security policy is attached to.
`associations[].securityPolicyId`	`string` [Output Only] The security policy ID of the association.
`associations[].displayName`	`string` [Output Only] The display name of the security policy of the association.
`labels`	`map (key: string, value: string)` Labels for this resource. These can only be added or modified by the `setLabels` method. Each label key/value pair must comply with RFC1035. Label values may be empty. An object containing a list of `"key": value` pairs. Example: `{ "name": "wrench", "mass": "1.3kg", "count": "3" }`.
`labelFingerprint`	`string (bytes format)` A fingerprint for the labels being applied to this security policy, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. To see the latest fingerprint, make `get()` request to the security policy. A base64-encoded string.
`ruleTupleCount`	`integer` [Output Only] Total count of all security policy rule tuples. A security policy can not exceed a set number of tuples.
`displayName`	`string` User-provided name of the Organization security plicy. The name should be unique in the organization in which the security policy is created. This should only be used when SecurityPolicyType is FIREWALL. 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 security policy.
`kind`	`string` [Output only] Type of the resource. Always `compute#securityPolicy`for security policies

Methods
`addRule`	Inserts a rule into a security policy.
`delete`	Deletes the specified policy.
`get`	List all of the ordered rules present in a single specified policy.
`getRule`	Gets a rule at the specified priority.
`insert`	Creates a new policy in the specified project using the data included in the request.
`list`	List all the policies that have been configured for the specified project.
`listPreconfiguredExpressionSets`	Gets the current list of preconfigured Web Application Firewall (WAF) expressions.
`patch`	Patches the specified policy with the data included in the request.
`patchRule`	Patches a rule at the specified priority.
`removeRule`	Deletes a rule at the specified priority.
`setLabels`	Sets the labels on a security policy.
`testIamPermissions`	Returns permissions that a caller has on the specified resource.

REST Resource: securityPolicies

Resource: SecurityPolicy

Methods

`addRule`

`delete`

`get`

`getRule`

`insert`

`list`

`listPreconfiguredExpressionSets`

`patch`

`patchRule`

`removeRule`

`setLabels`

`testIamPermissions`