Compute Engine v1 API - Class SecurityPolicyRule (3.1.0) 

public sealed class SecurityPolicyRule : IMessage<SecurityPolicyRule>, IEquatable<SecurityPolicyRule>, IDeepCloneable<SecurityPolicyRule>, IBufferMessage, IMessage

Reference documentation and code samples for the Compute Engine v1 API 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

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Constructors

SecurityPolicyRule()

public SecurityPolicyRule()

SecurityPolicyRule(SecurityPolicyRule)

public SecurityPolicyRule(SecurityPolicyRule other)
Parameter
Name Description
other SecurityPolicyRule

Properties

Action

public string Action { get; set; }

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.

Property Value
Type Description
string

Description

public string Description { get; set; }

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

Property Value
Type Description
string

HasAction

public bool HasAction { get; }

Gets whether the "action" field is set

Property Value
Type Description
bool

HasDescription

public bool HasDescription { get; }

Gets whether the "description" field is set

Property Value
Type Description
bool

HasKind

public bool HasKind { get; }

Gets whether the "kind" field is set

Property Value
Type Description
bool

HasPreview

public bool HasPreview { get; }

Gets whether the "preview" field is set

Property Value
Type Description
bool

HasPriority

public bool HasPriority { get; }

Gets whether the "priority" field is set

Property Value
Type Description
bool

HeaderAction

public SecurityPolicyRuleHttpHeaderAction HeaderAction { get; set; }

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

Property Value
Type Description
SecurityPolicyRuleHttpHeaderAction

Kind

public string Kind { get; set; }

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

Property Value
Type Description
string

Match

public SecurityPolicyRuleMatcher Match { get; set; }

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

Property Value
Type Description
SecurityPolicyRuleMatcher

NetworkMatch

public SecurityPolicyRuleNetworkMatcher NetworkMatch { get; set; }

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.

Property Value
Type Description
SecurityPolicyRuleNetworkMatcher

PreconfiguredWafConfig

public SecurityPolicyRulePreconfiguredWafConfig PreconfiguredWafConfig { get; set; }

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.

Property Value
Type Description
SecurityPolicyRulePreconfiguredWafConfig

Preview

public bool Preview { get; set; }

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

Property Value
Type Description
bool

Priority

public int Priority { get; set; }

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.

Property Value
Type Description
int

RateLimitOptions

public SecurityPolicyRuleRateLimitOptions RateLimitOptions { get; set; }

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

Property Value
Type Description
SecurityPolicyRuleRateLimitOptions

RedirectOptions

public SecurityPolicyRuleRedirectOptions RedirectOptions { get; set; }

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.

Property Value
Type Description
SecurityPolicyRuleRedirectOptions