1. Packages
  2. Azure Classic
  3. API Docs
  4. lb
  5. Rule

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
azure logo

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

    Manages a Load Balancer Rule.

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

    Example Usage

    using Pulumi;
    using Azure = Pulumi.Azure;
    
    class MyStack : Stack
    {
        public MyStack()
        {
            var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new Azure.Core.ResourceGroupArgs
            {
                Location = "West Europe",
            });
            var examplePublicIp = new Azure.Network.PublicIp("examplePublicIp", new Azure.Network.PublicIpArgs
            {
                Location = "West US",
                ResourceGroupName = exampleResourceGroup.Name,
                AllocationMethod = "Static",
            });
            var exampleLoadBalancer = new Azure.Lb.LoadBalancer("exampleLoadBalancer", new Azure.Lb.LoadBalancerArgs
            {
                Location = "West US",
                ResourceGroupName = exampleResourceGroup.Name,
                FrontendIpConfigurations = 
                {
                    new Azure.Lb.Inputs.LoadBalancerFrontendIpConfigurationArgs
                    {
                        Name = "PublicIPAddress",
                        PublicIpAddressId = examplePublicIp.Id,
                    },
                },
            });
            var exampleRule = new Azure.Lb.Rule("exampleRule", new Azure.Lb.RuleArgs
            {
                ResourceGroupName = exampleResourceGroup.Name,
                LoadbalancerId = exampleLoadBalancer.Id,
                Protocol = "Tcp",
                FrontendPort = 3389,
                BackendPort = 3389,
                FrontendIpConfigurationName = "PublicIPAddress",
            });
        }
    
    }
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/core"
    	"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/lb"
    	"github.com/pulumi/pulumi-azure/sdk/v4/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{
    			ResourceGroupName:           exampleResourceGroup.Name,
    			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
    	})
    }
    

    Example coming soon!

    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", {
        resourceGroupName: exampleResourceGroup.name,
        loadbalancerId: exampleLoadBalancer.id,
        protocol: "Tcp",
        frontendPort: 3389,
        backendPort: 3389,
        frontendIpConfigurationName: "PublicIPAddress",
    });
    
    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",
        resource_group_name=example_resource_group.name,
        loadbalancer_id=example_load_balancer.id,
        protocol="Tcp",
        frontend_port=3389,
        backend_port=3389,
        frontend_ip_configuration_name="PublicIPAddress")
    

    Example coming soon!

    Create Rule Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Rule(name: string, args: RuleArgs, opts?: CustomResourceOptions);
    @overload
    def Rule(resource_name: str,
             args: RuleArgs,
             opts: Optional[ResourceOptions] = None)
    
    @overload
    def Rule(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             frontend_ip_configuration_name: Optional[str] = None,
             resource_group_name: Optional[str] = None,
             backend_port: Optional[int] = None,
             protocol: Optional[str] = None,
             loadbalancer_id: Optional[str] = None,
             frontend_port: Optional[int] = None,
             disable_outbound_snat: Optional[bool] = None,
             enable_tcp_reset: Optional[bool] = None,
             idle_timeout_in_minutes: Optional[int] = None,
             load_distribution: Optional[str] = None,
             enable_floating_ip: Optional[bool] = None,
             name: Optional[str] = None,
             probe_id: Optional[str] = None,
             backend_address_pool_id: Optional[str] = None,
             backend_address_pool_ids: Optional[Sequence[str]] = 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.
    
    

    Parameters

    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.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var ruleResource = new Azure.Lb.Rule("ruleResource", new()
    {
        FrontendIpConfigurationName = "string",
        ResourceGroupName = "string",
        BackendPort = 0,
        Protocol = "string",
        LoadbalancerId = "string",
        FrontendPort = 0,
        DisableOutboundSnat = false,
        EnableTcpReset = false,
        IdleTimeoutInMinutes = 0,
        LoadDistribution = "string",
        EnableFloatingIp = false,
        Name = "string",
        ProbeId = "string",
        BackendAddressPoolIds = new[]
        {
            "string",
        },
    });
    
    example, err := lb.NewRule(ctx, "ruleResource", &lb.RuleArgs{
    	FrontendIpConfigurationName: pulumi.String("string"),
    	ResourceGroupName:           pulumi.String("string"),
    	BackendPort:                 pulumi.Int(0),
    	Protocol:                    pulumi.String("string"),
    	LoadbalancerId:              pulumi.String("string"),
    	FrontendPort:                pulumi.Int(0),
    	DisableOutboundSnat:         pulumi.Bool(false),
    	EnableTcpReset:              pulumi.Bool(false),
    	IdleTimeoutInMinutes:        pulumi.Int(0),
    	LoadDistribution:            pulumi.String("string"),
    	EnableFloatingIp:            pulumi.Bool(false),
    	Name:                        pulumi.String("string"),
    	ProbeId:                     pulumi.String("string"),
    	BackendAddressPoolIds: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    })
    
    var ruleResource = new Rule("ruleResource", RuleArgs.builder()
        .frontendIpConfigurationName("string")
        .resourceGroupName("string")
        .backendPort(0)
        .protocol("string")
        .loadbalancerId("string")
        .frontendPort(0)
        .disableOutboundSnat(false)
        .enableTcpReset(false)
        .idleTimeoutInMinutes(0)
        .loadDistribution("string")
        .enableFloatingIp(false)
        .name("string")
        .probeId("string")
        .backendAddressPoolIds("string")
        .build());
    
    rule_resource = azure.lb.Rule("ruleResource",
        frontend_ip_configuration_name="string",
        resource_group_name="string",
        backend_port=0,
        protocol="string",
        loadbalancer_id="string",
        frontend_port=0,
        disable_outbound_snat=False,
        enable_tcp_reset=False,
        idle_timeout_in_minutes=0,
        load_distribution="string",
        enable_floating_ip=False,
        name="string",
        probe_id="string",
        backend_address_pool_ids=["string"])
    
    const ruleResource = new azure.lb.Rule("ruleResource", {
        frontendIpConfigurationName: "string",
        resourceGroupName: "string",
        backendPort: 0,
        protocol: "string",
        loadbalancerId: "string",
        frontendPort: 0,
        disableOutboundSnat: false,
        enableTcpReset: false,
        idleTimeoutInMinutes: 0,
        loadDistribution: "string",
        enableFloatingIp: false,
        name: "string",
        probeId: "string",
        backendAddressPoolIds: ["string"],
    });
    
    type: azure:lb:Rule
    properties:
        backendAddressPoolIds:
            - string
        backendPort: 0
        disableOutboundSnat: false
        enableFloatingIp: false
        enableTcpReset: false
        frontendIpConfigurationName: string
        frontendPort: 0
        idleTimeoutInMinutes: 0
        loadDistribution: string
        loadbalancerId: string
        name: string
        probeId: string
        protocol: string
        resourceGroupName: string
    

    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

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    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

    Deprecated: This property has been deprecated by backend_address_pool_ids and will be removed in the next major version of the provider

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

    Deprecated: This property has been deprecated by backend_address_pool_ids and will be removed in the next major version of the provider

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

    Deprecated: This property has been deprecated by backend_address_pool_ids and will be removed in the next major version of the provider

    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? Defaults to false.
    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.
    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

    Deprecated: This property has been deprecated by backend_address_pool_ids and will be removed in the next major version of the provider

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

    Deprecated: This property has been deprecated by backend_address_pool_ids and will be removed in the next major version of the provider

    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? Defaults to false.
    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.
    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.
    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

    Deprecated: This property has been deprecated by backend_address_pool_ids and will be removed in the next major version of the provider

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

    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_id: Optional[str] = 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,
            resource_group_name: 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)
    resources:  _:    type: azure:lb:Rule    get:      id: ${id}
    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:
    BackendAddressPoolId string

    Deprecated: This property has been deprecated by backend_address_pool_ids and will be removed in the next major version of the provider

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

    Deprecated: This property has been deprecated by backend_address_pool_ids and will be removed in the next major version of the provider

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

    Deprecated: This property has been deprecated by backend_address_pool_ids and will be removed in the next major version of the provider

    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? Defaults to false.
    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.
    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

    Deprecated: This property has been deprecated by backend_address_pool_ids and will be removed in the next major version of the provider

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

    Deprecated: This property has been deprecated by backend_address_pool_ids and will be removed in the next major version of the provider

    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? 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 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.
    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.
    backendAddressPoolId String

    Deprecated: This property has been deprecated by backend_address_pool_ids and will be removed in the next major version of the provider

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

    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
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Viewing docs for Azure v4.42.0 (Older version)
    published on Monday, Mar 9, 2026 by Pulumi
      Try Pulumi Cloud free. Your team will thank you.