Compute Engine v1 API - Class SecurityPolicyRule (2.3.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
NameDescription
otherSecurityPolicyRule

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(): deny access to target, returns the HTTP response code specified (valid values 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. - 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
TypeDescription
String

Description

public string Description { get; set; }

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

Property Value
TypeDescription
String

HasAction

public bool HasAction { get; }

Gets whether the "action" field is set

Property Value
TypeDescription
Boolean

HasDescription

public bool HasDescription { get; }

Gets whether the "description" field is set

Property Value
TypeDescription
Boolean

HasKind

public bool HasKind { get; }

Gets whether the "kind" field is set

Property Value
TypeDescription
Boolean

HasPreview

public bool HasPreview { get; }

Gets whether the "preview" field is set

Property Value
TypeDescription
Boolean

HasPriority

public bool HasPriority { get; }

Gets whether the "priority" field is set

Property Value
TypeDescription
Boolean

HeaderAction

public SecurityPolicyRuleHttpHeaderAction HeaderAction { get; set; }

Optional, additional actions that are performed on headers.

Property Value
TypeDescription
SecurityPolicyRuleHttpHeaderAction

Kind

public string Kind { get; set; }

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

Property Value
TypeDescription
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
TypeDescription
SecurityPolicyRuleMatcher

Preview

public bool Preview { get; set; }

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

Property Value
TypeDescription
Boolean

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
TypeDescription
Int32

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
TypeDescription
SecurityPolicyRuleRateLimitOptions

RedirectOptions

public SecurityPolicyRuleRedirectOptions RedirectOptions { get; set; }

Parameters defining the redirect action. Cannot be specified for any other actions.

Property Value
TypeDescription
SecurityPolicyRuleRedirectOptions