Compute Engine v1 API - Class FirewallPolicyRule (3.0.0)

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

Reference documentation and code samples for the Compute Engine v1 API class FirewallPolicyRule.

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 > FirewallPolicyRule

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Constructors

FirewallPolicyRule()

public FirewallPolicyRule()

FirewallPolicyRule(FirewallPolicyRule)

public FirewallPolicyRule(FirewallPolicyRule other)
Parameter
Name Description
other FirewallPolicyRule

Properties

Action

public string Action { get; set; }

The Action to perform when the client connection triggers the rule. Valid actions for firewall rules are: "allow", "deny", "apply_security_profile_group" and "goto_next". Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" and "goto_next".

Property Value
Type Description
string

Description

public string Description { get; set; }

An optional description for this resource.

Property Value
Type Description
string

Direction

public string Direction { get; set; }

The direction in which this rule applies. Check the Direction enum for the list of possible values.

Property Value
Type Description
string

Disabled

public bool Disabled { get; set; }

Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled.

Property Value
Type Description
bool

EnableLogging

public bool EnableLogging { get; set; }

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.

Property Value
Type Description
bool

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

HasDirection

public bool HasDirection { get; }

Gets whether the "direction" field is set

Property Value
Type Description
bool

HasDisabled

public bool HasDisabled { get; }

Gets whether the "disabled" field is set

Property Value
Type Description
bool

HasEnableLogging

public bool HasEnableLogging { get; }

Gets whether the "enable_logging" 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

HasPriority

public bool HasPriority { get; }

Gets whether the "priority" field is set

Property Value
Type Description
bool

HasRuleName

public bool HasRuleName { get; }

Gets whether the "rule_name" field is set

Property Value
Type Description
bool

HasRuleTupleCount

public bool HasRuleTupleCount { get; }

Gets whether the "rule_tuple_count" field is set

Property Value
Type Description
bool

HasSecurityProfileGroup

public bool HasSecurityProfileGroup { get; }

Gets whether the "security_profile_group" field is set

Property Value
Type Description
bool

HasTlsInspect

public bool HasTlsInspect { get; }

Gets whether the "tls_inspect" field is set

Property Value
Type Description
bool

Kind

public string Kind { get; set; }

[Output only] Type of the resource. Returns compute#firewallPolicyRule for firewall rules and compute#packetMirroringRule for packet mirroring rules.

Property Value
Type Description
string

Match

public FirewallPolicyRuleMatcher 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
FirewallPolicyRuleMatcher

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

RuleName

public string RuleName { get; set; }

An optional name for the rule. This field is not a unique identifier and can be updated.

Property Value
Type Description
string

RuleTupleCount

public int RuleTupleCount { get; set; }

[Output Only] Calculation of the complexity of a single firewall policy rule.

Property Value
Type Description
int

SecurityProfileGroup

public string SecurityProfileGroup { get; set; }

A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group Must be specified if action is one of 'apply_security_profile_group' or 'mirror'. Cannot be specified for other actions.

Property Value
Type Description
string

TargetResources

public RepeatedField<string> TargetResources { get; }

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.

Property Value
Type Description
RepeatedFieldstring

TargetSecureTags

public RepeatedField<FirewallPolicyRuleSecureTag> TargetSecureTags { get; }

A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256.

Property Value
Type Description
RepeatedFieldFirewallPolicyRuleSecureTag

TargetServiceAccounts

public RepeatedField<string> TargetServiceAccounts { get; }

A list of service accounts indicating the sets of instances that are applied with this rule.

Property Value
Type Description
RepeatedFieldstring

TlsInspect

public bool TlsInspect { get; set; }

Boolean flag indicating if the traffic should be TLS decrypted. Can be set only if action = 'apply_security_profile_group' and cannot be set for other actions.

Property Value
Type Description
bool