Class Rule

Manages a Load Balancer Rule.

NOTE When using this resource, the Load Balancer needs to have a FrontEnd IP Configuration Attached

Inheritance

System.Object

Resource

CustomResource

Rule

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Azure.Lb

Assembly: Pulumi.Azure.dll

Syntax

public class Rule : CustomResource

Constructors

View Source

Rule(String, RuleArgs, CustomResourceOptions)

Create a Rule resource with the given unique name, arguments, and options.

Declaration

public Rule(string name, RuleArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
RuleArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

View Source

BackendAddressPoolId

A reference to a Backend Address Pool over which this Load Balancing Rule operates.

Declaration

public Output<string> BackendAddressPoolId { get; }

Property Value

Type	Description
Output<System.String>

View Source

BackendPort

The port used for internal connections on the endpoint. Possible values range between 0 and 65535, inclusive.

Declaration

public Output<int> BackendPort { get; }

Property Value

Type	Description
Output<System.Int32>

View Source

DisableOutboundSnat

Is snat enabled for this Load Balancer Rule? Default false.

Declaration

public Output<bool?> DisableOutboundSnat { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

View Source

EnableFloatingIp

Are the Floating IPs enabled for this Load Balncer Rule? A "floating” IP is reassigned to a secondary server in case the primary server fails. Required to configure a SQL AlwaysOn Availability Group. Defaults to false.

Declaration

public Output<bool?> EnableFloatingIp { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

View Source

EnableTcpReset

Is TCP Reset enabled for this Load Balancer Rule? Defaults to false.

Declaration

public Output<bool?> EnableTcpReset { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

View Source

FrontendIpConfigurationId

Declaration

public Output<string> FrontendIpConfigurationId { get; }

Property Value

Type	Description
Output<System.String>

View Source

FrontendIpConfigurationName

The name of the frontend IP configuration to which the rule is associated.

Declaration

public Output<string> FrontendIpConfigurationName { get; }

Property Value

Type	Description
Output<System.String>

View Source

FrontendPort

The port for the external endpoint. Port numbers for each Rule must be unique within the Load Balancer. Possible values range between 0 and 65534, inclusive.

Declaration

public Output<int> FrontendPort { get; }

Property Value

Type	Description
Output<System.Int32>

View Source

IdleTimeoutInMinutes

Specifies the idle timeout in minutes for TCP connections. Valid values are between 4 and 30 minutes. Defaults to 4 minutes.

Declaration

public Output<int> IdleTimeoutInMinutes { get; }

Property Value

Type	Description
Output<System.Int32>

View Source

LoadbalancerId

The ID of the Load Balancer in which to create the Rule.

Declaration

public Output<string> LoadbalancerId { get; }

Property Value

Type	Description
Output<System.String>

View Source

LoadDistribution

Specifies the load balancing distribution type to be used by the Load Balancer. Possible values are: Default – The load balancer is configured to use a 5 tuple hash to map traffic to available servers. SourceIP – The load balancer is configured to use a 2 tuple hash to map traffic to available servers. SourceIPProtocol – The load balancer is configured to use a 3 tuple hash to map traffic to available servers. Also known as Session Persistence, where the options are called None, Client IP and Client IP and Protocol respectively.

Declaration

public Output<string> LoadDistribution { get; }

Property Value

Type	Description
Output<System.String>

View Source

Name

Specifies the name of the LB Rule.

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

View Source

ProbeId

A reference to a Probe used by this Load Balancing Rule.

Declaration

public Output<string> ProbeId { get; }

Property Value

Type	Description
Output<System.String>

View Source

Protocol

The transport protocol for the external endpoint. Possible values are Tcp, Udp or All.

Declaration

public Output<string> Protocol { get; }

Property Value

Type	Description
Output<System.String>

View Source

ResourceGroupName

The name of the resource group in which to create the resource.

Declaration

public Output<string> ResourceGroupName { get; }

Property Value

Type	Description
Output<System.String>

Methods

View Source

Get(String, Input<String>, RuleState, CustomResourceOptions)

Get an existing Rule resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration

public static Rule Get(string name, Input<string> id, RuleState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
RuleState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
Rule