1. Pulumi Registry
  2. Azure Classic
  3. API Docs
  4. lb
  5. Rule
azure logo
Azure Classic v5.38.0, Mar 21 23

azure.lb.Rule

Manages a Load Balancer Rule.

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

Example Usage

using System.Collections.Generic;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new()
    {
        Location = "West Europe",
    });

    var examplePublicIp = new Azure.Network.PublicIp("examplePublicIp", new()
    {
        Location = "West US",
        ResourceGroupName = exampleResourceGroup.Name,
        AllocationMethod = "Static",
    });

    var exampleLoadBalancer = new Azure.Lb.LoadBalancer("exampleLoadBalancer", new()
    {
        Location = "West US",
        ResourceGroupName = exampleResourceGroup.Name,
        FrontendIpConfigurations = new[]
        {
            new Azure.Lb.Inputs.LoadBalancerFrontendIpConfigurationArgs
            {
                Name = "PublicIPAddress",
                PublicIpAddressId = examplePublicIp.Id,
            },
        },
    });

    var exampleRule = new Azure.Lb.Rule("exampleRule", new()
    {
        LoadbalancerId = exampleLoadBalancer.Id,
        Protocol = "Tcp",
        FrontendPort = 3389,
        BackendPort = 3389,
        FrontendIpConfigurationName = "PublicIPAddress",
    });

});

package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/lb"
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/network"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		examplePublicIp, err := network.NewPublicIp(ctx, "examplePublicIp", &network.PublicIpArgs{
			Location:          pulumi.String("West US"),
			ResourceGroupName: exampleResourceGroup.Name,
			AllocationMethod:  pulumi.String("Static"),
		})
		if err != nil {
			return err
		}
		exampleLoadBalancer, err := lb.NewLoadBalancer(ctx, "exampleLoadBalancer", &lb.LoadBalancerArgs{
			Location:          pulumi.String("West US"),
			ResourceGroupName: exampleResourceGroup.Name,
			FrontendIpConfigurations: lb.LoadBalancerFrontendIpConfigurationArray{
				&lb.LoadBalancerFrontendIpConfigurationArgs{
					Name:              pulumi.String("PublicIPAddress"),
					PublicIpAddressId: examplePublicIp.ID(),
				},
			},
		})
		if err != nil {
			return err
		}
		_, err = lb.NewRule(ctx, "exampleRule", &lb.RuleArgs{
			LoadbalancerId:              exampleLoadBalancer.ID(),
			Protocol:                    pulumi.String("Tcp"),
			FrontendPort:                pulumi.Int(3389),
			BackendPort:                 pulumi.Int(3389),
			FrontendIpConfigurationName: pulumi.String("PublicIPAddress"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.network.PublicIp;
import com.pulumi.azure.network.PublicIpArgs;
import com.pulumi.azure.lb.LoadBalancer;
import com.pulumi.azure.lb.LoadBalancerArgs;
import com.pulumi.azure.lb.inputs.LoadBalancerFrontendIpConfigurationArgs;
import com.pulumi.azure.lb.Rule;
import com.pulumi.azure.lb.RuleArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()        
            .location("West Europe")
            .build());

        var examplePublicIp = new PublicIp("examplePublicIp", PublicIpArgs.builder()        
            .location("West US")
            .resourceGroupName(exampleResourceGroup.name())
            .allocationMethod("Static")
            .build());

        var exampleLoadBalancer = new LoadBalancer("exampleLoadBalancer", LoadBalancerArgs.builder()        
            .location("West US")
            .resourceGroupName(exampleResourceGroup.name())
            .frontendIpConfigurations(LoadBalancerFrontendIpConfigurationArgs.builder()
                .name("PublicIPAddress")
                .publicIpAddressId(examplePublicIp.id())
                .build())
            .build());

        var exampleRule = new Rule("exampleRule", RuleArgs.builder()        
            .loadbalancerId(exampleLoadBalancer.id())
            .protocol("Tcp")
            .frontendPort(3389)
            .backendPort(3389)
            .frontendIpConfigurationName("PublicIPAddress")
            .build());

    }
}

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_public_ip = azure.network.PublicIp("examplePublicIp",
    location="West US",
    resource_group_name=example_resource_group.name,
    allocation_method="Static")
example_load_balancer = azure.lb.LoadBalancer("exampleLoadBalancer",
    location="West US",
    resource_group_name=example_resource_group.name,
    frontend_ip_configurations=[azure.lb.LoadBalancerFrontendIpConfigurationArgs(
        name="PublicIPAddress",
        public_ip_address_id=example_public_ip.id,
    )])
example_rule = azure.lb.Rule("exampleRule",
    loadbalancer_id=example_load_balancer.id,
    protocol="Tcp",
    frontend_port=3389,
    backend_port=3389,
    frontend_ip_configuration_name="PublicIPAddress")

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const examplePublicIp = new azure.network.PublicIp("examplePublicIp", {
    location: "West US",
    resourceGroupName: exampleResourceGroup.name,
    allocationMethod: "Static",
});
const exampleLoadBalancer = new azure.lb.LoadBalancer("exampleLoadBalancer", {
    location: "West US",
    resourceGroupName: exampleResourceGroup.name,
    frontendIpConfigurations: [{
        name: "PublicIPAddress",
        publicIpAddressId: examplePublicIp.id,
    }],
});
const exampleRule = new azure.lb.Rule("exampleRule", {
    loadbalancerId: exampleLoadBalancer.id,
    protocol: "Tcp",
    frontendPort: 3389,
    backendPort: 3389,
    frontendIpConfigurationName: "PublicIPAddress",
});

resources:
  exampleResourceGroup:
    type: azure:core:ResourceGroup
    properties:
      location: West Europe
  examplePublicIp:
    type: azure:network:PublicIp
    properties:
      location: West US
      resourceGroupName: ${exampleResourceGroup.name}
      allocationMethod: Static
  exampleLoadBalancer:
    type: azure:lb:LoadBalancer
    properties:
      location: West US
      resourceGroupName: ${exampleResourceGroup.name}
      frontendIpConfigurations:
        - name: PublicIPAddress
          publicIpAddressId: ${examplePublicIp.id}
  exampleRule:
    type: azure:lb:Rule
    properties:
      loadbalancerId: ${exampleLoadBalancer.id}
      protocol: Tcp
      frontendPort: 3389
      backendPort: 3389
      frontendIpConfigurationName: PublicIPAddress

Create Rule Resource

new Rule(name: string, args: RuleArgs, opts?: CustomResourceOptions);
@overload
def Rule(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         backend_address_pool_ids: Optional[Sequence[str]] = None,
         backend_port: Optional[int] = None,
         disable_outbound_snat: Optional[bool] = None,
         enable_floating_ip: Optional[bool] = None,
         enable_tcp_reset: Optional[bool] = None,
         frontend_ip_configuration_name: Optional[str] = None,
         frontend_port: Optional[int] = None,
         idle_timeout_in_minutes: Optional[int] = None,
         load_distribution: Optional[str] = None,
         loadbalancer_id: Optional[str] = None,
         name: Optional[str] = None,
         probe_id: Optional[str] = None,
         protocol: Optional[str] = None)
@overload
def Rule(resource_name: str,
         args: RuleArgs,
         opts: Optional[ResourceOptions] = None)
func NewRule(ctx *Context, name string, args RuleArgs, opts ...ResourceOption) (*Rule, error)
public Rule(string name, RuleArgs args, CustomResourceOptions? opts = null)
public Rule(String name, RuleArgs args)
public Rule(String name, RuleArgs args, CustomResourceOptions options)

type: azure:lb:Rule
properties: # The arguments to resource properties.
options: # 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.
resource_name str
The unique name of the resource.
args RuleArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control 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.
name String
The unique name of the resource.
args RuleArgs
The arguments to resource properties.
options 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 Architecture and Concepts 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. Changing this forces a new resource to be created.

Protocol string

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

BackendAddressPoolIds List<string>

A list of 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?

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. Changing this forces a new resource to be created.

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. Changing this forces a new resource to be created.

Protocol string

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

BackendAddressPoolIds []string

A list of 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?

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. Changing this forces a new resource to be created.

ProbeId string

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

backendPort Integer

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 Integer

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. Changing this forces a new resource to be created.

protocol String

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

backendAddressPoolIds List<String>

A list of 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?

idleTimeoutInMinutes Integer

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. Changing this forces a new resource to be created.

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. Changing this forces a new resource to be created.

protocol string

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

backendAddressPoolIds string[]

A list of 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?

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. Changing this forces a new resource to be created.

probeId string

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

backend_port int

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

loadbalancer_id str

The ID of the Load Balancer in which to create the Rule. Changing this forces a new resource to be created.

protocol str

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

backend_address_pool_ids Sequence[str]

A list of 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?

idle_timeout_in_minutes int

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. Changing this forces a new resource to be created.

probe_id str

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. Changing this forces a new resource to be created.

protocol String

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

backendAddressPoolIds List<String>

A list of 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?

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. Changing this forces a new resource to be created.

probeId String

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.

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.

frontendIpConfigurationId String
id String

The provider-assigned unique ID for this managed resource.

Look up 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
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        backend_address_pool_ids: Optional[Sequence[str]] = None,
        backend_port: Optional[int] = None,
        disable_outbound_snat: Optional[bool] = None,
        enable_floating_ip: Optional[bool] = None,
        enable_tcp_reset: Optional[bool] = None,
        frontend_ip_configuration_id: Optional[str] = None,
        frontend_ip_configuration_name: Optional[str] = None,
        frontend_port: Optional[int] = None,
        idle_timeout_in_minutes: Optional[int] = None,
        load_distribution: Optional[str] = None,
        loadbalancer_id: Optional[str] = None,
        name: Optional[str] = None,
        probe_id: Optional[str] = None,
        protocol: Optional[str] = None) -> Rule
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)
public static Rule get(String name, Output<String> id, RuleState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
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.
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:
BackendAddressPoolIds List<string>

A list of 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?

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. Changing this forces a new resource to be created.

Name string

Specifies the name of the LB Rule. Changing this forces a new resource to be created.

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.

BackendAddressPoolIds []string

A list of 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?

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. Changing this forces a new resource to be created.

Name string

Specifies the name of the LB Rule. Changing this forces a new resource to be created.

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.

backendAddressPoolIds List<String>

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

backendPort Integer

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?

frontendIpConfigurationId String
frontendIpConfigurationName String

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

frontendPort Integer

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 Integer

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. Changing this forces a new resource to be created.

name String

Specifies the name of the LB Rule. Changing this forces a new resource to be created.

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.

backendAddressPoolIds string[]

A list of 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?

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. Changing this forces a new resource to be created.

name string

Specifies the name of the LB Rule. Changing this forces a new resource to be created.

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.

backend_address_pool_ids Sequence[str]

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

backend_port int

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?

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

idle_timeout_in_minutes int

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. Changing this forces a new resource to be created.

name str

Specifies the name of the LB Rule. Changing this forces a new resource to be created.

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.

backendAddressPoolIds List<String>

A list of 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?

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. Changing this forces a new resource to be created.

name String

Specifies the name of the LB Rule. Changing this forces a new resource to be created.

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.

Import

Load Balancer Rules can be imported using the resource id, e.g.

 $ pulumi import azure:lb/rule:Rule example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.Network/loadBalancers/lb1/loadBalancingRules/rule1

Package Details

Repository
Azure Classic pulumi/pulumi-azure
License
Apache-2.0
Notes

This Pulumi package is based on the azurerm Terraform Provider.