Rule

Manages a Load Balancer Rule.

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

Create a Rule Resource

new Rule(name: string, args: RuleArgs, opts?: CustomResourceOptions);

def Rule(resource_name, opts=None, backend_address_pool_id=None, backend_port=None, disable_outbound_snat=None, enable_floating_ip=None, enable_tcp_reset=None, frontend_ip_configuration_name=None, frontend_port=None, idle_timeout_in_minutes=None, load_distribution=None, loadbalancer_id=None, name=None, probe_id=None, protocol=None, resource_group_name=None, __props__=None);

func NewRule(ctx *Context, name string, args RuleArgs, opts ...ResourceOption) (*Rule, error)

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

name string: The unique name of the resource.
args RuleArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args RuleArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args RuleArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

Rule Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The Rule resource accepts the following input properties:

BackendPort int: The port used for internal connections on the endpoint. Possible values range between 0 and 65535, inclusive.
FrontendIpConfigurationName string: The name of the frontend IP configuration to which the rule is associated.
FrontendPort int: 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.
LoadbalancerId string: The ID of the Load Balancer in which to create the Rule.
Protocol string: The transport protocol for the external endpoint. Possible values are Tcp, Udp or All.
ResourceGroupName string: The name of the resource group in which to create the resource.
BackendAddressPoolId string: A reference to a Backend Address Pool over which this Load Balancing Rule operates.
DisableOutboundSnat bool: Is snat enabled for this Load Balancer Rule? Default false.
EnableFloatingIp bool: 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.
EnableTcpReset bool: Is TCP Reset enabled for this Load Balancer Rule? Defaults to false.
IdleTimeoutInMinutes int: Specifies the idle timeout in minutes for TCP connections. Valid values are between 4 and 30 minutes. Defaults to 4 minutes.
LoadDistribution string: 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.
Name string: Specifies the name of the LB Rule.
ProbeId string: A reference to a Probe used by this Load Balancing Rule.

BackendPort int: The port used for internal connections on the endpoint. Possible values range between 0 and 65535, inclusive.
FrontendIpConfigurationName string: The name of the frontend IP configuration to which the rule is associated.
FrontendPort int: 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.
LoadbalancerId string: The ID of the Load Balancer in which to create the Rule.
Protocol string: The transport protocol for the external endpoint. Possible values are Tcp, Udp or All.
ResourceGroupName string: The name of the resource group in which to create the resource.
BackendAddressPoolId string: A reference to a Backend Address Pool over which this Load Balancing Rule operates.
DisableOutboundSnat bool: Is snat enabled for this Load Balancer Rule? Default false.
EnableFloatingIp bool: 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.
EnableTcpReset bool: Is TCP Reset enabled for this Load Balancer Rule? Defaults to false.
IdleTimeoutInMinutes int: Specifies the idle timeout in minutes for TCP connections. Valid values are between 4 and 30 minutes. Defaults to 4 minutes.
LoadDistribution string: 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.
Name string: Specifies the name of the LB Rule.
ProbeId string: A reference to a Probe used by this Load Balancing Rule.

backendPort number: The port used for internal connections on the endpoint. Possible values range between 0 and 65535, inclusive.
frontendIpConfigurationName string: The name of the frontend IP configuration to which the rule is associated.
frontendPort number: 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.
loadbalancerId string: The ID of the Load Balancer in which to create the Rule.
protocol string: The transport protocol for the external endpoint. Possible values are Tcp, Udp or All.
resourceGroupName string: The name of the resource group in which to create the resource.
backendAddressPoolId string: A reference to a Backend Address Pool over which this Load Balancing Rule operates.
disableOutboundSnat boolean: Is snat enabled for this Load Balancer Rule? Default false.
enableFloatingIp boolean: 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.
enableTcpReset boolean: Is TCP Reset enabled for this Load Balancer Rule? Defaults to false.
idleTimeoutInMinutes number: Specifies the idle timeout in minutes for TCP connections. Valid values are between 4 and 30 minutes. Defaults to 4 minutes.
loadDistribution string: 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.
name string: Specifies the name of the LB Rule.
probeId string: A reference to a Probe used by this Load Balancing Rule.

backend_port float: The port used for internal connections on the endpoint. Possible values range between 0 and 65535, inclusive.
frontend_ip_configuration_name str: The name of the frontend IP configuration to which the rule is associated.
frontend_port float: 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.
loadbalancer_id str: The ID of the Load Balancer in which to create the Rule.
protocol str: The transport protocol for the external endpoint. Possible values are Tcp, Udp or All.
resource_group_name str: The name of the resource group in which to create the resource.
backend_address_pool_id str: A reference to a Backend Address Pool over which this Load Balancing Rule operates.
disable_outbound_snat bool: Is snat enabled for this Load Balancer Rule? Default false.
enable_floating_ip bool: 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.
enable_tcp_reset bool: Is TCP Reset enabled for this Load Balancer Rule? Defaults to false.
idle_timeout_in_minutes float: Specifies the idle timeout in minutes for TCP connections. Valid values are between 4 and 30 minutes. Defaults to 4 minutes.
load_distribution str: 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.
name str: Specifies the name of the LB Rule.
probe_id str: A reference to a Probe used by this Load Balancing Rule.

Outputs

All input properties are implicitly available as output properties. Additionally, the Rule resource produces the following output properties:

FrontendIpConfigurationId string
Id string: The provider-assigned unique ID for this managed resource.

FrontendIpConfigurationId string
Id string: The provider-assigned unique ID for this managed resource.

frontendIpConfigurationId string
id string: The provider-assigned unique ID for this managed resource.

frontend_ip_configuration_id str
id str: The provider-assigned unique ID for this managed resource.

Look up an Existing Rule Resource

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

public static get(name: string, id: Input<ID>, state?: RuleState, opts?: CustomResourceOptions): Rule

static get(resource_name, id, opts=None, backend_address_pool_id=None, backend_port=None, disable_outbound_snat=None, enable_floating_ip=None, enable_tcp_reset=None, frontend_ip_configuration_id=None, frontend_ip_configuration_name=None, frontend_port=None, idle_timeout_in_minutes=None, load_distribution=None, loadbalancer_id=None, name=None, probe_id=None, protocol=None, resource_group_name=None, __props__=None);

func GetRule(ctx *Context, name string, id IDInput, state *RuleState, opts ...ResourceOption) (*Rule, error)

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

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

BackendAddressPoolId string: A reference to a Backend Address Pool over which this Load Balancing Rule operates.
BackendPort int: The port used for internal connections on the endpoint. Possible values range between 0 and 65535, inclusive.
DisableOutboundSnat bool: Is snat enabled for this Load Balancer Rule? Default false.
EnableFloatingIp bool: 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.
EnableTcpReset bool: Is TCP Reset enabled for this Load Balancer Rule? Defaults to false.
FrontendIpConfigurationId string
FrontendIpConfigurationName string: The name of the frontend IP configuration to which the rule is associated.
FrontendPort int: 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.
IdleTimeoutInMinutes int: Specifies the idle timeout in minutes for TCP connections. Valid values are between 4 and 30 minutes. Defaults to 4 minutes.
LoadDistribution string: 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.
LoadbalancerId string: The ID of the Load Balancer in which to create the Rule.
Name string: Specifies the name of the LB Rule.
ProbeId string: A reference to a Probe used by this Load Balancing Rule.
Protocol string: The transport protocol for the external endpoint. Possible values are Tcp, Udp or All.
ResourceGroupName string: The name of the resource group in which to create the resource.

BackendAddressPoolId string: A reference to a Backend Address Pool over which this Load Balancing Rule operates.
BackendPort int: The port used for internal connections on the endpoint. Possible values range between 0 and 65535, inclusive.
DisableOutboundSnat bool: Is snat enabled for this Load Balancer Rule? Default false.
EnableFloatingIp bool: 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.
EnableTcpReset bool: Is TCP Reset enabled for this Load Balancer Rule? Defaults to false.
FrontendIpConfigurationId string
FrontendIpConfigurationName string: The name of the frontend IP configuration to which the rule is associated.
FrontendPort int: 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.
IdleTimeoutInMinutes int: Specifies the idle timeout in minutes for TCP connections. Valid values are between 4 and 30 minutes. Defaults to 4 minutes.
LoadDistribution string: 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.
LoadbalancerId string: The ID of the Load Balancer in which to create the Rule.
Name string: Specifies the name of the LB Rule.
ProbeId string: A reference to a Probe used by this Load Balancing Rule.
Protocol string: The transport protocol for the external endpoint. Possible values are Tcp, Udp or All.
ResourceGroupName string: The name of the resource group in which to create the resource.

backendAddressPoolId string: A reference to a Backend Address Pool over which this Load Balancing Rule operates.
backendPort number: The port used for internal connections on the endpoint. Possible values range between 0 and 65535, inclusive.
disableOutboundSnat boolean: Is snat enabled for this Load Balancer Rule? Default false.
enableFloatingIp boolean: 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.
enableTcpReset boolean: Is TCP Reset enabled for this Load Balancer Rule? Defaults to false.
frontendIpConfigurationId string
frontendIpConfigurationName string: The name of the frontend IP configuration to which the rule is associated.
frontendPort number: 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.
idleTimeoutInMinutes number: Specifies the idle timeout in minutes for TCP connections. Valid values are between 4 and 30 minutes. Defaults to 4 minutes.
loadDistribution string: 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.
loadbalancerId string: The ID of the Load Balancer in which to create the Rule.
name string: Specifies the name of the LB Rule.
probeId string: A reference to a Probe used by this Load Balancing Rule.
protocol string: The transport protocol for the external endpoint. Possible values are Tcp, Udp or All.
resourceGroupName string: The name of the resource group in which to create the resource.

backend_address_pool_id str: A reference to a Backend Address Pool over which this Load Balancing Rule operates.
backend_port float: The port used for internal connections on the endpoint. Possible values range between 0 and 65535, inclusive.
disable_outbound_snat bool: Is snat enabled for this Load Balancer Rule? Default false.
enable_floating_ip bool: 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.
enable_tcp_reset bool: Is TCP Reset enabled for this Load Balancer Rule? Defaults to false.
frontend_ip_configuration_id str
frontend_ip_configuration_name str: The name of the frontend IP configuration to which the rule is associated.
frontend_port float: 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.
idle_timeout_in_minutes float: Specifies the idle timeout in minutes for TCP connections. Valid values are between 4 and 30 minutes. Defaults to 4 minutes.
load_distribution str: 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.
loadbalancer_id str: The ID of the Load Balancer in which to create the Rule.
name str: Specifies the name of the LB Rule.
probe_id str: A reference to a Probe used by this Load Balancing Rule.
protocol str: The transport protocol for the external endpoint. Possible values are Tcp, Udp or All.
resource_group_name str: The name of the resource group in which to create the resource.

Package Details

Repository: https://github.com/pulumi/pulumi-azure
License: Apache-2.0
Notes: This Pulumi package is based on the azurerm Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud