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

We recommend using Azure Native.

Azure Classic v5.81.0 published on Monday, Jun 24, 2024 by Pulumi

azure.lb.OutboundRule

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.81.0 published on Monday, Jun 24, 2024 by Pulumi

    Manages a Load Balancer Outbound Rule.

    NOTE When using this resource, the Load Balancer needs to have a FrontEnd IP Configuration and a Backend Address Pool Attached.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    
    const example = new azure.core.ResourceGroup("example", {
        name: "LoadBalancerRG",
        location: "West Europe",
    });
    const examplePublicIp = new azure.network.PublicIp("example", {
        name: "PublicIPForLB",
        location: example.location,
        resourceGroupName: example.name,
        allocationMethod: "Static",
    });
    const exampleLoadBalancer = new azure.lb.LoadBalancer("example", {
        name: "TestLoadBalancer",
        location: example.location,
        resourceGroupName: example.name,
        frontendIpConfigurations: [{
            name: "PublicIPAddress",
            publicIpAddressId: examplePublicIp.id,
        }],
    });
    const exampleBackendAddressPool = new azure.lb.BackendAddressPool("example", {
        name: "example",
        loadbalancerId: exampleLoadBalancer.id,
    });
    const exampleOutboundRule = new azure.lb.OutboundRule("example", {
        name: "OutboundRule",
        loadbalancerId: exampleLoadBalancer.id,
        protocol: "Tcp",
        backendAddressPoolId: exampleBackendAddressPool.id,
        frontendIpConfigurations: [{
            name: "PublicIPAddress",
        }],
    });
    
    import pulumi
    import pulumi_azure as azure
    
    example = azure.core.ResourceGroup("example",
        name="LoadBalancerRG",
        location="West Europe")
    example_public_ip = azure.network.PublicIp("example",
        name="PublicIPForLB",
        location=example.location,
        resource_group_name=example.name,
        allocation_method="Static")
    example_load_balancer = azure.lb.LoadBalancer("example",
        name="TestLoadBalancer",
        location=example.location,
        resource_group_name=example.name,
        frontend_ip_configurations=[azure.lb.LoadBalancerFrontendIpConfigurationArgs(
            name="PublicIPAddress",
            public_ip_address_id=example_public_ip.id,
        )])
    example_backend_address_pool = azure.lb.BackendAddressPool("example",
        name="example",
        loadbalancer_id=example_load_balancer.id)
    example_outbound_rule = azure.lb.OutboundRule("example",
        name="OutboundRule",
        loadbalancer_id=example_load_balancer.id,
        protocol="Tcp",
        backend_address_pool_id=example_backend_address_pool.id,
        frontend_ip_configurations=[azure.lb.OutboundRuleFrontendIpConfigurationArgs(
            name="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 {
    		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
    			Name:     pulumi.String("LoadBalancerRG"),
    			Location: pulumi.String("West Europe"),
    		})
    		if err != nil {
    			return err
    		}
    		examplePublicIp, err := network.NewPublicIp(ctx, "example", &network.PublicIpArgs{
    			Name:              pulumi.String("PublicIPForLB"),
    			Location:          example.Location,
    			ResourceGroupName: example.Name,
    			AllocationMethod:  pulumi.String("Static"),
    		})
    		if err != nil {
    			return err
    		}
    		exampleLoadBalancer, err := lb.NewLoadBalancer(ctx, "example", &lb.LoadBalancerArgs{
    			Name:              pulumi.String("TestLoadBalancer"),
    			Location:          example.Location,
    			ResourceGroupName: example.Name,
    			FrontendIpConfigurations: lb.LoadBalancerFrontendIpConfigurationArray{
    				&lb.LoadBalancerFrontendIpConfigurationArgs{
    					Name:              pulumi.String("PublicIPAddress"),
    					PublicIpAddressId: examplePublicIp.ID(),
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		exampleBackendAddressPool, err := lb.NewBackendAddressPool(ctx, "example", &lb.BackendAddressPoolArgs{
    			Name:           pulumi.String("example"),
    			LoadbalancerId: exampleLoadBalancer.ID(),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = lb.NewOutboundRule(ctx, "example", &lb.OutboundRuleArgs{
    			Name:                 pulumi.String("OutboundRule"),
    			LoadbalancerId:       exampleLoadBalancer.ID(),
    			Protocol:             pulumi.String("Tcp"),
    			BackendAddressPoolId: exampleBackendAddressPool.ID(),
    			FrontendIpConfigurations: lb.OutboundRuleFrontendIpConfigurationArray{
    				&lb.OutboundRuleFrontendIpConfigurationArgs{
    					Name: pulumi.String("PublicIPAddress"),
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Azure = Pulumi.Azure;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Azure.Core.ResourceGroup("example", new()
        {
            Name = "LoadBalancerRG",
            Location = "West Europe",
        });
    
        var examplePublicIp = new Azure.Network.PublicIp("example", new()
        {
            Name = "PublicIPForLB",
            Location = example.Location,
            ResourceGroupName = example.Name,
            AllocationMethod = "Static",
        });
    
        var exampleLoadBalancer = new Azure.Lb.LoadBalancer("example", new()
        {
            Name = "TestLoadBalancer",
            Location = example.Location,
            ResourceGroupName = example.Name,
            FrontendIpConfigurations = new[]
            {
                new Azure.Lb.Inputs.LoadBalancerFrontendIpConfigurationArgs
                {
                    Name = "PublicIPAddress",
                    PublicIpAddressId = examplePublicIp.Id,
                },
            },
        });
    
        var exampleBackendAddressPool = new Azure.Lb.BackendAddressPool("example", new()
        {
            Name = "example",
            LoadbalancerId = exampleLoadBalancer.Id,
        });
    
        var exampleOutboundRule = new Azure.Lb.OutboundRule("example", new()
        {
            Name = "OutboundRule",
            LoadbalancerId = exampleLoadBalancer.Id,
            Protocol = "Tcp",
            BackendAddressPoolId = exampleBackendAddressPool.Id,
            FrontendIpConfigurations = new[]
            {
                new Azure.Lb.Inputs.OutboundRuleFrontendIpConfigurationArgs
                {
                    Name = "PublicIPAddress",
                },
            },
        });
    
    });
    
    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.BackendAddressPool;
    import com.pulumi.azure.lb.BackendAddressPoolArgs;
    import com.pulumi.azure.lb.OutboundRule;
    import com.pulumi.azure.lb.OutboundRuleArgs;
    import com.pulumi.azure.lb.inputs.OutboundRuleFrontendIpConfigurationArgs;
    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 example = new ResourceGroup("example", ResourceGroupArgs.builder()
                .name("LoadBalancerRG")
                .location("West Europe")
                .build());
    
            var examplePublicIp = new PublicIp("examplePublicIp", PublicIpArgs.builder()
                .name("PublicIPForLB")
                .location(example.location())
                .resourceGroupName(example.name())
                .allocationMethod("Static")
                .build());
    
            var exampleLoadBalancer = new LoadBalancer("exampleLoadBalancer", LoadBalancerArgs.builder()
                .name("TestLoadBalancer")
                .location(example.location())
                .resourceGroupName(example.name())
                .frontendIpConfigurations(LoadBalancerFrontendIpConfigurationArgs.builder()
                    .name("PublicIPAddress")
                    .publicIpAddressId(examplePublicIp.id())
                    .build())
                .build());
    
            var exampleBackendAddressPool = new BackendAddressPool("exampleBackendAddressPool", BackendAddressPoolArgs.builder()
                .name("example")
                .loadbalancerId(exampleLoadBalancer.id())
                .build());
    
            var exampleOutboundRule = new OutboundRule("exampleOutboundRule", OutboundRuleArgs.builder()
                .name("OutboundRule")
                .loadbalancerId(exampleLoadBalancer.id())
                .protocol("Tcp")
                .backendAddressPoolId(exampleBackendAddressPool.id())
                .frontendIpConfigurations(OutboundRuleFrontendIpConfigurationArgs.builder()
                    .name("PublicIPAddress")
                    .build())
                .build());
    
        }
    }
    
    resources:
      example:
        type: azure:core:ResourceGroup
        properties:
          name: LoadBalancerRG
          location: West Europe
      examplePublicIp:
        type: azure:network:PublicIp
        name: example
        properties:
          name: PublicIPForLB
          location: ${example.location}
          resourceGroupName: ${example.name}
          allocationMethod: Static
      exampleLoadBalancer:
        type: azure:lb:LoadBalancer
        name: example
        properties:
          name: TestLoadBalancer
          location: ${example.location}
          resourceGroupName: ${example.name}
          frontendIpConfigurations:
            - name: PublicIPAddress
              publicIpAddressId: ${examplePublicIp.id}
      exampleBackendAddressPool:
        type: azure:lb:BackendAddressPool
        name: example
        properties:
          name: example
          loadbalancerId: ${exampleLoadBalancer.id}
      exampleOutboundRule:
        type: azure:lb:OutboundRule
        name: example
        properties:
          name: OutboundRule
          loadbalancerId: ${exampleLoadBalancer.id}
          protocol: Tcp
          backendAddressPoolId: ${exampleBackendAddressPool.id}
          frontendIpConfigurations:
            - name: PublicIPAddress
    

    Create OutboundRule Resource

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

    Constructor syntax

    new OutboundRule(name: string, args: OutboundRuleArgs, opts?: CustomResourceOptions);
    @overload
    def OutboundRule(resource_name: str,
                     args: OutboundRuleArgs,
                     opts: Optional[ResourceOptions] = None)
    
    @overload
    def OutboundRule(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     backend_address_pool_id: Optional[str] = None,
                     loadbalancer_id: Optional[str] = None,
                     protocol: Optional[str] = None,
                     allocated_outbound_ports: Optional[int] = None,
                     enable_tcp_reset: Optional[bool] = None,
                     frontend_ip_configurations: Optional[Sequence[OutboundRuleFrontendIpConfigurationArgs]] = None,
                     idle_timeout_in_minutes: Optional[int] = None,
                     name: Optional[str] = None)
    func NewOutboundRule(ctx *Context, name string, args OutboundRuleArgs, opts ...ResourceOption) (*OutboundRule, error)
    public OutboundRule(string name, OutboundRuleArgs args, CustomResourceOptions? opts = null)
    public OutboundRule(String name, OutboundRuleArgs args)
    public OutboundRule(String name, OutboundRuleArgs args, CustomResourceOptions options)
    
    type: azure:lb:OutboundRule
    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 OutboundRuleArgs
    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 OutboundRuleArgs
    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 OutboundRuleArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args OutboundRuleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args OutboundRuleArgs
    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 outboundRuleResource = new Azure.Lb.OutboundRule("outboundRuleResource", new()
    {
        BackendAddressPoolId = "string",
        LoadbalancerId = "string",
        Protocol = "string",
        AllocatedOutboundPorts = 0,
        EnableTcpReset = false,
        FrontendIpConfigurations = new[]
        {
            new Azure.Lb.Inputs.OutboundRuleFrontendIpConfigurationArgs
            {
                Name = "string",
                Id = "string",
            },
        },
        IdleTimeoutInMinutes = 0,
        Name = "string",
    });
    
    example, err := lb.NewOutboundRule(ctx, "outboundRuleResource", &lb.OutboundRuleArgs{
    	BackendAddressPoolId:   pulumi.String("string"),
    	LoadbalancerId:         pulumi.String("string"),
    	Protocol:               pulumi.String("string"),
    	AllocatedOutboundPorts: pulumi.Int(0),
    	EnableTcpReset:         pulumi.Bool(false),
    	FrontendIpConfigurations: lb.OutboundRuleFrontendIpConfigurationArray{
    		&lb.OutboundRuleFrontendIpConfigurationArgs{
    			Name: pulumi.String("string"),
    			Id:   pulumi.String("string"),
    		},
    	},
    	IdleTimeoutInMinutes: pulumi.Int(0),
    	Name:                 pulumi.String("string"),
    })
    
    var outboundRuleResource = new OutboundRule("outboundRuleResource", OutboundRuleArgs.builder()
        .backendAddressPoolId("string")
        .loadbalancerId("string")
        .protocol("string")
        .allocatedOutboundPorts(0)
        .enableTcpReset(false)
        .frontendIpConfigurations(OutboundRuleFrontendIpConfigurationArgs.builder()
            .name("string")
            .id("string")
            .build())
        .idleTimeoutInMinutes(0)
        .name("string")
        .build());
    
    outbound_rule_resource = azure.lb.OutboundRule("outboundRuleResource",
        backend_address_pool_id="string",
        loadbalancer_id="string",
        protocol="string",
        allocated_outbound_ports=0,
        enable_tcp_reset=False,
        frontend_ip_configurations=[azure.lb.OutboundRuleFrontendIpConfigurationArgs(
            name="string",
            id="string",
        )],
        idle_timeout_in_minutes=0,
        name="string")
    
    const outboundRuleResource = new azure.lb.OutboundRule("outboundRuleResource", {
        backendAddressPoolId: "string",
        loadbalancerId: "string",
        protocol: "string",
        allocatedOutboundPorts: 0,
        enableTcpReset: false,
        frontendIpConfigurations: [{
            name: "string",
            id: "string",
        }],
        idleTimeoutInMinutes: 0,
        name: "string",
    });
    
    type: azure:lb:OutboundRule
    properties:
        allocatedOutboundPorts: 0
        backendAddressPoolId: string
        enableTcpReset: false
        frontendIpConfigurations:
            - id: string
              name: string
        idleTimeoutInMinutes: 0
        loadbalancerId: string
        name: string
        protocol: string
    

    OutboundRule 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 OutboundRule resource accepts the following input properties:

    BackendAddressPoolId string
    The ID of the Backend Address Pool. Outbound traffic is randomly load balanced across IPs in the backend IPs.
    LoadbalancerId string
    The ID of the Load Balancer in which to create the Outbound Rule. Changing this forces a new resource to be created.
    Protocol string
    The transport protocol for the external endpoint. Possible values are Udp, Tcp or All.
    AllocatedOutboundPorts int
    The number of outbound ports to be used for NAT. Defaults to 1024.
    EnableTcpReset bool
    Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.
    FrontendIpConfigurations List<Pulumi.Azure.Lb.Inputs.OutboundRuleFrontendIpConfiguration>
    One or more frontend_ip_configuration blocks as defined below.
    IdleTimeoutInMinutes int
    The timeout for the TCP idle connection Defaults to 4.
    Name string
    Specifies the name of the Outbound Rule. Changing this forces a new resource to be created.
    BackendAddressPoolId string
    The ID of the Backend Address Pool. Outbound traffic is randomly load balanced across IPs in the backend IPs.
    LoadbalancerId string
    The ID of the Load Balancer in which to create the Outbound Rule. Changing this forces a new resource to be created.
    Protocol string
    The transport protocol for the external endpoint. Possible values are Udp, Tcp or All.
    AllocatedOutboundPorts int
    The number of outbound ports to be used for NAT. Defaults to 1024.
    EnableTcpReset bool
    Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.
    FrontendIpConfigurations []OutboundRuleFrontendIpConfigurationArgs
    One or more frontend_ip_configuration blocks as defined below.
    IdleTimeoutInMinutes int
    The timeout for the TCP idle connection Defaults to 4.
    Name string
    Specifies the name of the Outbound Rule. Changing this forces a new resource to be created.
    backendAddressPoolId String
    The ID of the Backend Address Pool. Outbound traffic is randomly load balanced across IPs in the backend IPs.
    loadbalancerId String
    The ID of the Load Balancer in which to create the Outbound Rule. Changing this forces a new resource to be created.
    protocol String
    The transport protocol for the external endpoint. Possible values are Udp, Tcp or All.
    allocatedOutboundPorts Integer
    The number of outbound ports to be used for NAT. Defaults to 1024.
    enableTcpReset Boolean
    Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.
    frontendIpConfigurations List<OutboundRuleFrontendIpConfiguration>
    One or more frontend_ip_configuration blocks as defined below.
    idleTimeoutInMinutes Integer
    The timeout for the TCP idle connection Defaults to 4.
    name String
    Specifies the name of the Outbound Rule. Changing this forces a new resource to be created.
    backendAddressPoolId string
    The ID of the Backend Address Pool. Outbound traffic is randomly load balanced across IPs in the backend IPs.
    loadbalancerId string
    The ID of the Load Balancer in which to create the Outbound Rule. Changing this forces a new resource to be created.
    protocol string
    The transport protocol for the external endpoint. Possible values are Udp, Tcp or All.
    allocatedOutboundPorts number
    The number of outbound ports to be used for NAT. Defaults to 1024.
    enableTcpReset boolean
    Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.
    frontendIpConfigurations OutboundRuleFrontendIpConfiguration[]
    One or more frontend_ip_configuration blocks as defined below.
    idleTimeoutInMinutes number
    The timeout for the TCP idle connection Defaults to 4.
    name string
    Specifies the name of the Outbound Rule. Changing this forces a new resource to be created.
    backend_address_pool_id str
    The ID of the Backend Address Pool. Outbound traffic is randomly load balanced across IPs in the backend IPs.
    loadbalancer_id str
    The ID of the Load Balancer in which to create the Outbound Rule. Changing this forces a new resource to be created.
    protocol str
    The transport protocol for the external endpoint. Possible values are Udp, Tcp or All.
    allocated_outbound_ports int
    The number of outbound ports to be used for NAT. Defaults to 1024.
    enable_tcp_reset bool
    Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.
    frontend_ip_configurations Sequence[OutboundRuleFrontendIpConfigurationArgs]
    One or more frontend_ip_configuration blocks as defined below.
    idle_timeout_in_minutes int
    The timeout for the TCP idle connection Defaults to 4.
    name str
    Specifies the name of the Outbound Rule. Changing this forces a new resource to be created.
    backendAddressPoolId String
    The ID of the Backend Address Pool. Outbound traffic is randomly load balanced across IPs in the backend IPs.
    loadbalancerId String
    The ID of the Load Balancer in which to create the Outbound Rule. Changing this forces a new resource to be created.
    protocol String
    The transport protocol for the external endpoint. Possible values are Udp, Tcp or All.
    allocatedOutboundPorts Number
    The number of outbound ports to be used for NAT. Defaults to 1024.
    enableTcpReset Boolean
    Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.
    frontendIpConfigurations List<Property Map>
    One or more frontend_ip_configuration blocks as defined below.
    idleTimeoutInMinutes Number
    The timeout for the TCP idle connection Defaults to 4.
    name String
    Specifies the name of the Outbound Rule. Changing this forces a new resource to be created.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing OutboundRule Resource

    Get an existing OutboundRule 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?: OutboundRuleState, opts?: CustomResourceOptions): OutboundRule
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            allocated_outbound_ports: Optional[int] = None,
            backend_address_pool_id: Optional[str] = None,
            enable_tcp_reset: Optional[bool] = None,
            frontend_ip_configurations: Optional[Sequence[OutboundRuleFrontendIpConfigurationArgs]] = None,
            idle_timeout_in_minutes: Optional[int] = None,
            loadbalancer_id: Optional[str] = None,
            name: Optional[str] = None,
            protocol: Optional[str] = None) -> OutboundRule
    func GetOutboundRule(ctx *Context, name string, id IDInput, state *OutboundRuleState, opts ...ResourceOption) (*OutboundRule, error)
    public static OutboundRule Get(string name, Input<string> id, OutboundRuleState? state, CustomResourceOptions? opts = null)
    public static OutboundRule get(String name, Output<String> id, OutboundRuleState 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:
    AllocatedOutboundPorts int
    The number of outbound ports to be used for NAT. Defaults to 1024.
    BackendAddressPoolId string
    The ID of the Backend Address Pool. Outbound traffic is randomly load balanced across IPs in the backend IPs.
    EnableTcpReset bool
    Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.
    FrontendIpConfigurations List<Pulumi.Azure.Lb.Inputs.OutboundRuleFrontendIpConfiguration>
    One or more frontend_ip_configuration blocks as defined below.
    IdleTimeoutInMinutes int
    The timeout for the TCP idle connection Defaults to 4.
    LoadbalancerId string
    The ID of the Load Balancer in which to create the Outbound Rule. Changing this forces a new resource to be created.
    Name string
    Specifies the name of the Outbound Rule. Changing this forces a new resource to be created.
    Protocol string
    The transport protocol for the external endpoint. Possible values are Udp, Tcp or All.
    AllocatedOutboundPorts int
    The number of outbound ports to be used for NAT. Defaults to 1024.
    BackendAddressPoolId string
    The ID of the Backend Address Pool. Outbound traffic is randomly load balanced across IPs in the backend IPs.
    EnableTcpReset bool
    Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.
    FrontendIpConfigurations []OutboundRuleFrontendIpConfigurationArgs
    One or more frontend_ip_configuration blocks as defined below.
    IdleTimeoutInMinutes int
    The timeout for the TCP idle connection Defaults to 4.
    LoadbalancerId string
    The ID of the Load Balancer in which to create the Outbound Rule. Changing this forces a new resource to be created.
    Name string
    Specifies the name of the Outbound Rule. Changing this forces a new resource to be created.
    Protocol string
    The transport protocol for the external endpoint. Possible values are Udp, Tcp or All.
    allocatedOutboundPorts Integer
    The number of outbound ports to be used for NAT. Defaults to 1024.
    backendAddressPoolId String
    The ID of the Backend Address Pool. Outbound traffic is randomly load balanced across IPs in the backend IPs.
    enableTcpReset Boolean
    Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.
    frontendIpConfigurations List<OutboundRuleFrontendIpConfiguration>
    One or more frontend_ip_configuration blocks as defined below.
    idleTimeoutInMinutes Integer
    The timeout for the TCP idle connection Defaults to 4.
    loadbalancerId String
    The ID of the Load Balancer in which to create the Outbound Rule. Changing this forces a new resource to be created.
    name String
    Specifies the name of the Outbound Rule. Changing this forces a new resource to be created.
    protocol String
    The transport protocol for the external endpoint. Possible values are Udp, Tcp or All.
    allocatedOutboundPorts number
    The number of outbound ports to be used for NAT. Defaults to 1024.
    backendAddressPoolId string
    The ID of the Backend Address Pool. Outbound traffic is randomly load balanced across IPs in the backend IPs.
    enableTcpReset boolean
    Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.
    frontendIpConfigurations OutboundRuleFrontendIpConfiguration[]
    One or more frontend_ip_configuration blocks as defined below.
    idleTimeoutInMinutes number
    The timeout for the TCP idle connection Defaults to 4.
    loadbalancerId string
    The ID of the Load Balancer in which to create the Outbound Rule. Changing this forces a new resource to be created.
    name string
    Specifies the name of the Outbound Rule. Changing this forces a new resource to be created.
    protocol string
    The transport protocol for the external endpoint. Possible values are Udp, Tcp or All.
    allocated_outbound_ports int
    The number of outbound ports to be used for NAT. Defaults to 1024.
    backend_address_pool_id str
    The ID of the Backend Address Pool. Outbound traffic is randomly load balanced across IPs in the backend IPs.
    enable_tcp_reset bool
    Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.
    frontend_ip_configurations Sequence[OutboundRuleFrontendIpConfigurationArgs]
    One or more frontend_ip_configuration blocks as defined below.
    idle_timeout_in_minutes int
    The timeout for the TCP idle connection Defaults to 4.
    loadbalancer_id str
    The ID of the Load Balancer in which to create the Outbound Rule. Changing this forces a new resource to be created.
    name str
    Specifies the name of the Outbound Rule. Changing this forces a new resource to be created.
    protocol str
    The transport protocol for the external endpoint. Possible values are Udp, Tcp or All.
    allocatedOutboundPorts Number
    The number of outbound ports to be used for NAT. Defaults to 1024.
    backendAddressPoolId String
    The ID of the Backend Address Pool. Outbound traffic is randomly load balanced across IPs in the backend IPs.
    enableTcpReset Boolean
    Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.
    frontendIpConfigurations List<Property Map>
    One or more frontend_ip_configuration blocks as defined below.
    idleTimeoutInMinutes Number
    The timeout for the TCP idle connection Defaults to 4.
    loadbalancerId String
    The ID of the Load Balancer in which to create the Outbound Rule. Changing this forces a new resource to be created.
    name String
    Specifies the name of the Outbound Rule. Changing this forces a new resource to be created.
    protocol String
    The transport protocol for the external endpoint. Possible values are Udp, Tcp or All.

    Supporting Types

    OutboundRuleFrontendIpConfiguration, OutboundRuleFrontendIpConfigurationArgs

    Name string
    The name of the Frontend IP Configuration.
    Id string
    The ID of the Load Balancer Outbound Rule.
    Name string
    The name of the Frontend IP Configuration.
    Id string
    The ID of the Load Balancer Outbound Rule.
    name String
    The name of the Frontend IP Configuration.
    id String
    The ID of the Load Balancer Outbound Rule.
    name string
    The name of the Frontend IP Configuration.
    id string
    The ID of the Load Balancer Outbound Rule.
    name str
    The name of the Frontend IP Configuration.
    id str
    The ID of the Load Balancer Outbound Rule.
    name String
    The name of the Frontend IP Configuration.
    id String
    The ID of the Load Balancer Outbound Rule.

    Import

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

    $ pulumi import azure:lb/outboundRule:OutboundRule example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.Network/loadBalancers/lb1/outboundRules/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.

    Azure Classic v5.81.0 published on Monday, Jun 24, 2024 by Pulumi