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
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(): 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.
Declaration
[JsonProperty("action")]
public virtual string Action { get; set; }
Property Value
| Type | Description |
|---|---|
| System.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 |
|---|---|
| System.String |
ETag
The ETag of the item.
Declaration
public virtual string ETag { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
HeaderAction
Optional, additional actions that are performed on headers.
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 |
|---|---|
| System.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 |
Preview
If set to true, the specified action is not enforced.
Declaration
[JsonProperty("preview")]
public virtual bool? Preview { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Boolean> |
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 |
|---|---|
| System.Nullable<System.Int32> |
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.
Declaration
[JsonProperty("redirectOptions")]
public virtual SecurityPolicyRuleRedirectOptions RedirectOptions { get; set; }
Property Value
| Type | Description |
|---|---|
| SecurityPolicyRuleRedirectOptions |