Class SecurityPolicyRule

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

Inheritance
object
SecurityPolicyRule
Implements
Inherited Members
Namespace: Google.Apis.Compute.v1.Data
Assembly: Google.Apis.Compute.v1.dll
Syntax
public class SecurityPolicyRule : IDirectResponseSchema

Properties

Action

The Action to perform when the rule is matched. The following are the valid actions: - allow: allow access to target. - deny(STATUS): deny access to target, returns the HTTP response code specified. Valid values for STATUS are 403, 404, and 502. - rate_based_ban: limit client traffic to the configured threshold and ban the client if the traffic exceeds the threshold. Configure parameters for this action in RateLimitOptions. Requires rate_limit_options to be set. - redirect: redirect to a different target. This can either be an internal reCAPTCHA redirect, or an external URL-based redirect via a 302 response. Parameters for this action can be configured via redirectOptions. This action is only supported in Global Security Policies of type CLOUD_ARMOR. - throttle: limit client traffic to the configured threshold. Configure parameters for this action in rateLimitOptions. Requires rate_limit_options to be set for this.

Declaration
[JsonProperty("action")]
public virtual string Action { get; set; }
Property Value
Type Description
string

Description

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

Declaration
[JsonProperty("description")]
public virtual string Description { get; set; }
Property Value
Type Description
string

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

HeaderAction

Optional, additional actions that are performed on headers. This field is only supported in Global Security Policies of type CLOUD_ARMOR.

Declaration
[JsonProperty("headerAction")]
public virtual SecurityPolicyRuleHttpHeaderAction HeaderAction { get; set; }
Property Value
Type Description
SecurityPolicyRuleHttpHeaderAction

Kind

[Output only] Type of the resource. Always compute#securityPolicyRule for security policy rules

Declaration
[JsonProperty("kind")]
public virtual string Kind { get; set; }
Property Value
Type Description
string

Match

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

Declaration
[JsonProperty("match")]
public virtual SecurityPolicyRuleMatcher Match { get; set; }
Property Value
Type Description
SecurityPolicyRuleMatcher

NetworkMatch

A match condition that incoming packets are evaluated against for CLOUD_ARMOR_NETWORK security policies. If it matches, the corresponding 'action' is enforced. The match criteria for a rule consists of built-in match fields (like 'srcIpRanges') and potentially multiple user-defined match fields ('userDefinedFields'). Field values may be extracted directly from the packet or derived from it (e.g. 'srcRegionCodes'). Some fields may not be present in every packet (e.g. 'srcPorts'). A user-defined field is only present if the base header is found in the packet and the entire field is in bounds. Each match field may specify which values can match it, listing one or more ranges, prefixes, or exact values that are considered a match for the field. A field value must be present in order to match a specified match field. If no match values are specified for a match field, then any field value is considered to match it, and it's not required to be present. For strings specifying '*' is also equivalent to match all. For a packet to match a rule, all specified match fields must match the corresponding field values derived from the packet. Example: networkMatch: srcIpRanges: - "192.0.2.0/24" - "198.51.100.0/24" userDefinedFields: - name: "ipv4_fragment_offset" values:

  • "1-0x1fff" The above match condition matches packets with a source IP in 192.0.2.0/24 or 198.51.100.0/24 and a user-defined field named "ipv4_fragment_offset" with a value between 1 and 0x1fff inclusive.
Declaration
[JsonProperty("networkMatch")]
public virtual SecurityPolicyRuleNetworkMatcher NetworkMatch { get; set; }
Property Value
Type Description
SecurityPolicyRuleNetworkMatcher

PreconfiguredWafConfig

Preconfigured WAF configuration to be applied for the rule. If the rule does not evaluate preconfigured WAF rules, i.e., if evaluatePreconfiguredWaf() is not used, this field will have no effect.

Declaration
[JsonProperty("preconfiguredWafConfig")]
public virtual SecurityPolicyRulePreconfiguredWafConfig PreconfiguredWafConfig { get; set; }
Property Value
Type Description
SecurityPolicyRulePreconfiguredWafConfig

Preview

If set to true, the specified action is not enforced.

Declaration
[JsonProperty("preview")]
public virtual bool? Preview { get; set; }
Property Value
Type Description
bool?

Priority

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

Declaration
[JsonProperty("priority")]
public virtual int? Priority { get; set; }
Property Value
Type Description
int?

RateLimitOptions

Must be specified if the action is "rate_based_ban" or "throttle". Cannot be specified for any other actions.

Declaration
[JsonProperty("rateLimitOptions")]
public virtual SecurityPolicyRuleRateLimitOptions RateLimitOptions { get; set; }
Property Value
Type Description
SecurityPolicyRuleRateLimitOptions

RedirectOptions

Parameters defining the redirect action. Cannot be specified for any other actions. This field is only supported in Global Security Policies of type CLOUD_ARMOR.

Declaration
[JsonProperty("redirectOptions")]
public virtual SecurityPolicyRuleRedirectOptions RedirectOptions { get; set; }
Property Value
Type Description
SecurityPolicyRuleRedirectOptions

Implements