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

We recommend using Azure Native.

Azure Classic v5.73.0 published on Monday, Apr 22, 2024 by Pulumi
pulumi/pulumi-azure

azure.lb.LoadBalancer

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.73.0 published on Monday, Apr 22, 2024 by Pulumi
pulumi/pulumi-azure

    Manages a Load Balancer Resource.

    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,
    }],
});

    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,
    )])

    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
		}
		_, 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
		}
		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,
            },
        },
    });

});

    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 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());

    }
}

    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}

    Create LoadBalancer Resource

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

    Constructor syntax

    new LoadBalancer(name: string, args: LoadBalancerArgs, opts?: CustomResourceOptions);
    @overload
def LoadBalancer(resource_name: str,
                 args: LoadBalancerArgs,
                 opts: Optional[ResourceOptions] = None)

@overload
def LoadBalancer(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 resource_group_name: Optional[str] = None,
                 edge_zone: Optional[str] = None,
                 frontend_ip_configurations: Optional[Sequence[LoadBalancerFrontendIpConfigurationArgs]] = None,
                 location: Optional[str] = None,
                 name: Optional[str] = None,
                 sku: Optional[str] = None,
                 sku_tier: Optional[str] = None,
                 tags: Optional[Mapping[str, str]] = None)
    func NewLoadBalancer(ctx *Context, name string, args LoadBalancerArgs, opts ...ResourceOption) (*LoadBalancer, error)
    public LoadBalancer(string name, LoadBalancerArgs args, CustomResourceOptions? opts = null)
    public LoadBalancer(String name, LoadBalancerArgs args)
public LoadBalancer(String name, LoadBalancerArgs args, CustomResourceOptions options)

    type: azure:lb:LoadBalancer
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 LoadBalancerArgs
    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 LoadBalancerArgs
    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 LoadBalancerArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args LoadBalancerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args LoadBalancerArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var loadBalancerResource = new Azure.Lb.LoadBalancer("loadBalancerResource", new()
{
    ResourceGroupName = "string",
    EdgeZone = "string",
    FrontendIpConfigurations = new[]
    {
        new Azure.Lb.Inputs.LoadBalancerFrontendIpConfigurationArgs
        {
            Name = "string",
            PrivateIpAddress = "string",
            InboundNatRules = new[]
            {
                "string",
            },
            LoadBalancerRules = new[]
            {
                "string",
            },
            Id = "string",
            OutboundRules = new[]
            {
                "string",
            },
            GatewayLoadBalancerFrontendIpConfigurationId = "string",
            PrivateIpAddressAllocation = "string",
            PrivateIpAddressVersion = "string",
            PublicIpAddressId = "string",
            PublicIpPrefixId = "string",
            SubnetId = "string",
            Zones = new[]
            {
                "string",
            },
        },
    },
    Location = "string",
    Name = "string",
    Sku = "string",
    SkuTier = "string",
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := lb.NewLoadBalancer(ctx, "loadBalancerResource", &lb.LoadBalancerArgs{
	ResourceGroupName: pulumi.String("string"),
	EdgeZone:          pulumi.String("string"),
	FrontendIpConfigurations: lb.LoadBalancerFrontendIpConfigurationArray{
		&lb.LoadBalancerFrontendIpConfigurationArgs{
			Name:             pulumi.String("string"),
			PrivateIpAddress: pulumi.String("string"),
			InboundNatRules: pulumi.StringArray{
				pulumi.String("string"),
			},
			LoadBalancerRules: pulumi.StringArray{
				pulumi.String("string"),
			},
			Id: pulumi.String("string"),
			OutboundRules: pulumi.StringArray{
				pulumi.String("string"),
			},
			GatewayLoadBalancerFrontendIpConfigurationId: pulumi.String("string"),
			PrivateIpAddressAllocation:                   pulumi.String("string"),
			PrivateIpAddressVersion:                      pulumi.String("string"),
			PublicIpAddressId:                            pulumi.String("string"),
			PublicIpPrefixId:                             pulumi.String("string"),
			SubnetId:                                     pulumi.String("string"),
			Zones: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
	},
	Location: pulumi.String("string"),
	Name:     pulumi.String("string"),
	Sku:      pulumi.String("string"),
	SkuTier:  pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var loadBalancerResource = new LoadBalancer("loadBalancerResource", LoadBalancerArgs.builder()        
    .resourceGroupName("string")
    .edgeZone("string")
    .frontendIpConfigurations(LoadBalancerFrontendIpConfigurationArgs.builder()
        .name("string")
        .privateIpAddress("string")
        .inboundNatRules("string")
        .loadBalancerRules("string")
        .id("string")
        .outboundRules("string")
        .gatewayLoadBalancerFrontendIpConfigurationId("string")
        .privateIpAddressAllocation("string")
        .privateIpAddressVersion("string")
        .publicIpAddressId("string")
        .publicIpPrefixId("string")
        .subnetId("string")
        .zones("string")
        .build())
    .location("string")
    .name("string")
    .sku("string")
    .skuTier("string")
    .tags(Map.of("string", "string"))
    .build());

    load_balancer_resource = azure.lb.LoadBalancer("loadBalancerResource",
    resource_group_name="string",
    edge_zone="string",
    frontend_ip_configurations=[azure.lb.LoadBalancerFrontendIpConfigurationArgs(
        name="string",
        private_ip_address="string",
        inbound_nat_rules=["string"],
        load_balancer_rules=["string"],
        id="string",
        outbound_rules=["string"],
        gateway_load_balancer_frontend_ip_configuration_id="string",
        private_ip_address_allocation="string",
        private_ip_address_version="string",
        public_ip_address_id="string",
        public_ip_prefix_id="string",
        subnet_id="string",
        zones=["string"],
    )],
    location="string",
    name="string",
    sku="string",
    sku_tier="string",
    tags={
        "string": "string",
    })

    const loadBalancerResource = new azure.lb.LoadBalancer("loadBalancerResource", {
    resourceGroupName: "string",
    edgeZone: "string",
    frontendIpConfigurations: [{
        name: "string",
        privateIpAddress: "string",
        inboundNatRules: ["string"],
        loadBalancerRules: ["string"],
        id: "string",
        outboundRules: ["string"],
        gatewayLoadBalancerFrontendIpConfigurationId: "string",
        privateIpAddressAllocation: "string",
        privateIpAddressVersion: "string",
        publicIpAddressId: "string",
        publicIpPrefixId: "string",
        subnetId: "string",
        zones: ["string"],
    }],
    location: "string",
    name: "string",
    sku: "string",
    skuTier: "string",
    tags: {
        string: "string",
    },
});

    type: azure:lb:LoadBalancer
properties:
    edgeZone: string
    frontendIpConfigurations:
        - gatewayLoadBalancerFrontendIpConfigurationId: string
          id: string
          inboundNatRules:
            - string
          loadBalancerRules:
            - string
          name: string
          outboundRules:
            - string
          privateIpAddress: string
          privateIpAddressAllocation: string
          privateIpAddressVersion: string
          publicIpAddressId: string
          publicIpPrefixId: string
          subnetId: string
          zones:
            - string
    location: string
    name: string
    resourceGroupName: string
    sku: string
    skuTier: string
    tags:
        string: string

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

    ResourceGroupName string
    The name of the Resource Group in which to create the Load Balancer. Changing this forces a new resource to be created.
    EdgeZone string
    Specifies the Edge Zone within the Azure Region where this Load Balancer should exist. Changing this forces a new Load Balancer to be created.
    FrontendIpConfigurations List<Pulumi.Azure.Lb.Inputs.LoadBalancerFrontendIpConfiguration>
    One or more frontend_ip_configuration blocks as documented below.
    Location string
    Specifies the supported Azure Region where the Load Balancer should be created. Changing this forces a new resource to be created.
    Name string
    Specifies the name of the Load Balancer. Changing this forces a new resource to be created.
    Sku string

    The SKU of the Azure Load Balancer. Accepted values are Basic, Standard and Gateway. Defaults to Basic. Changing this forces a new resource to be created.

    NOTE: The Microsoft.Network/AllowGatewayLoadBalancer feature is required to be registered in order to use the Gateway SKU. The feature can only be registered by the Azure service team, please submit an Azure support ticket for that.

    SkuTier string
    sku_tier - (Optional) The SKU tier of this Load Balancer. Possible values are Global and Regional. Defaults to Regional. Changing this forces a new resource to be created.
    Tags Dictionary<string, string>
    A mapping of tags to assign to the resource.
    ResourceGroupName string
    The name of the Resource Group in which to create the Load Balancer. Changing this forces a new resource to be created.
    EdgeZone string
    Specifies the Edge Zone within the Azure Region where this Load Balancer should exist. Changing this forces a new Load Balancer to be created.
    FrontendIpConfigurations []LoadBalancerFrontendIpConfigurationArgs
    One or more frontend_ip_configuration blocks as documented below.
    Location string
    Specifies the supported Azure Region where the Load Balancer should be created. Changing this forces a new resource to be created.
    Name string
    Specifies the name of the Load Balancer. Changing this forces a new resource to be created.
    Sku string

    The SKU of the Azure Load Balancer. Accepted values are Basic, Standard and Gateway. Defaults to Basic. Changing this forces a new resource to be created.

    NOTE: The Microsoft.Network/AllowGatewayLoadBalancer feature is required to be registered in order to use the Gateway SKU. The feature can only be registered by the Azure service team, please submit an Azure support ticket for that.

    SkuTier string
    sku_tier - (Optional) The SKU tier of this Load Balancer. Possible values are Global and Regional. Defaults to Regional. Changing this forces a new resource to be created.
    Tags map[string]string
    A mapping of tags to assign to the resource.
    resourceGroupName String
    The name of the Resource Group in which to create the Load Balancer. Changing this forces a new resource to be created.
    edgeZone String
    Specifies the Edge Zone within the Azure Region where this Load Balancer should exist. Changing this forces a new Load Balancer to be created.
    frontendIpConfigurations List<LoadBalancerFrontendIpConfiguration>
    One or more frontend_ip_configuration blocks as documented below.
    location String
    Specifies the supported Azure Region where the Load Balancer should be created. Changing this forces a new resource to be created.
    name String
    Specifies the name of the Load Balancer. Changing this forces a new resource to be created.
    sku String

    The SKU of the Azure Load Balancer. Accepted values are Basic, Standard and Gateway. Defaults to Basic. Changing this forces a new resource to be created.

    NOTE: The Microsoft.Network/AllowGatewayLoadBalancer feature is required to be registered in order to use the Gateway SKU. The feature can only be registered by the Azure service team, please submit an Azure support ticket for that.

    skuTier String
    sku_tier - (Optional) The SKU tier of this Load Balancer. Possible values are Global and Regional. Defaults to Regional. Changing this forces a new resource to be created.
    tags Map<String,String>
    A mapping of tags to assign to the resource.
    resourceGroupName string
    The name of the Resource Group in which to create the Load Balancer. Changing this forces a new resource to be created.
    edgeZone string
    Specifies the Edge Zone within the Azure Region where this Load Balancer should exist. Changing this forces a new Load Balancer to be created.
    frontendIpConfigurations LoadBalancerFrontendIpConfiguration[]
    One or more frontend_ip_configuration blocks as documented below.
    location string
    Specifies the supported Azure Region where the Load Balancer should be created. Changing this forces a new resource to be created.
    name string
    Specifies the name of the Load Balancer. Changing this forces a new resource to be created.
    sku string

    The SKU of the Azure Load Balancer. Accepted values are Basic, Standard and Gateway. Defaults to Basic. Changing this forces a new resource to be created.

    NOTE: The Microsoft.Network/AllowGatewayLoadBalancer feature is required to be registered in order to use the Gateway SKU. The feature can only be registered by the Azure service team, please submit an Azure support ticket for that.

    skuTier string
    sku_tier - (Optional) The SKU tier of this Load Balancer. Possible values are Global and Regional. Defaults to Regional. Changing this forces a new resource to be created.
    tags {[key: string]: string}
    A mapping of tags to assign to the resource.
    resource_group_name str
    The name of the Resource Group in which to create the Load Balancer. Changing this forces a new resource to be created.
    edge_zone str
    Specifies the Edge Zone within the Azure Region where this Load Balancer should exist. Changing this forces a new Load Balancer to be created.
    frontend_ip_configurations Sequence[LoadBalancerFrontendIpConfigurationArgs]
    One or more frontend_ip_configuration blocks as documented below.
    location str
    Specifies the supported Azure Region where the Load Balancer should be created. Changing this forces a new resource to be created.
    name str
    Specifies the name of the Load Balancer. Changing this forces a new resource to be created.
    sku str

    The SKU of the Azure Load Balancer. Accepted values are Basic, Standard and Gateway. Defaults to Basic. Changing this forces a new resource to be created.

    NOTE: The Microsoft.Network/AllowGatewayLoadBalancer feature is required to be registered in order to use the Gateway SKU. The feature can only be registered by the Azure service team, please submit an Azure support ticket for that.

    sku_tier str
    sku_tier - (Optional) The SKU tier of this Load Balancer. Possible values are Global and Regional. Defaults to Regional. Changing this forces a new resource to be created.
    tags Mapping[str, str]
    A mapping of tags to assign to the resource.
    resourceGroupName String
    The name of the Resource Group in which to create the Load Balancer. Changing this forces a new resource to be created.
    edgeZone String
    Specifies the Edge Zone within the Azure Region where this Load Balancer should exist. Changing this forces a new Load Balancer to be created.
    frontendIpConfigurations List<Property Map>
    One or more frontend_ip_configuration blocks as documented below.
    location String
    Specifies the supported Azure Region where the Load Balancer should be created. Changing this forces a new resource to be created.
    name String
    Specifies the name of the Load Balancer. Changing this forces a new resource to be created.
    sku String

    The SKU of the Azure Load Balancer. Accepted values are Basic, Standard and Gateway. Defaults to Basic. Changing this forces a new resource to be created.

    NOTE: The Microsoft.Network/AllowGatewayLoadBalancer feature is required to be registered in order to use the Gateway SKU. The feature can only be registered by the Azure service team, please submit an Azure support ticket for that.

    skuTier String
    sku_tier - (Optional) The SKU tier of this Load Balancer. Possible values are Global and Regional. Defaults to Regional. Changing this forces a new resource to be created.
    tags Map<String>
    A mapping of tags to assign to the resource.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    PrivateIpAddress string
    Private IP Address to assign to the Load Balancer. The last one and first four IPs in any range are reserved and cannot be manually assigned.
    PrivateIpAddresses List<string>
    The list of private IP address assigned to the load balancer in frontend_ip_configuration blocks, if any.
    Id string
    The provider-assigned unique ID for this managed resource.
    PrivateIpAddress string
    Private IP Address to assign to the Load Balancer. The last one and first four IPs in any range are reserved and cannot be manually assigned.
    PrivateIpAddresses []string
    The list of private IP address assigned to the load balancer in frontend_ip_configuration blocks, if any.
    id String
    The provider-assigned unique ID for this managed resource.
    privateIpAddress String
    Private IP Address to assign to the Load Balancer. The last one and first four IPs in any range are reserved and cannot be manually assigned.
    privateIpAddresses List<String>
    The list of private IP address assigned to the load balancer in frontend_ip_configuration blocks, if any.
    id string
    The provider-assigned unique ID for this managed resource.
    privateIpAddress string
    Private IP Address to assign to the Load Balancer. The last one and first four IPs in any range are reserved and cannot be manually assigned.
    privateIpAddresses string[]
    The list of private IP address assigned to the load balancer in frontend_ip_configuration blocks, if any.
    id str
    The provider-assigned unique ID for this managed resource.
    private_ip_address str
    Private IP Address to assign to the Load Balancer. The last one and first four IPs in any range are reserved and cannot be manually assigned.
    private_ip_addresses Sequence[str]
    The list of private IP address assigned to the load balancer in frontend_ip_configuration blocks, if any.
    id String
    The provider-assigned unique ID for this managed resource.
    privateIpAddress String
    Private IP Address to assign to the Load Balancer. The last one and first four IPs in any range are reserved and cannot be manually assigned.
    privateIpAddresses List<String>
    The list of private IP address assigned to the load balancer in frontend_ip_configuration blocks, if any.

    Look up Existing LoadBalancer Resource

    Get an existing LoadBalancer 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?: LoadBalancerState, opts?: CustomResourceOptions): LoadBalancer
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        edge_zone: Optional[str] = None,
        frontend_ip_configurations: Optional[Sequence[LoadBalancerFrontendIpConfigurationArgs]] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        private_ip_address: Optional[str] = None,
        private_ip_addresses: Optional[Sequence[str]] = None,
        resource_group_name: Optional[str] = None,
        sku: Optional[str] = None,
        sku_tier: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None) -> LoadBalancer
    func GetLoadBalancer(ctx *Context, name string, id IDInput, state *LoadBalancerState, opts ...ResourceOption) (*LoadBalancer, error)
    public static LoadBalancer Get(string name, Input<string> id, LoadBalancerState? state, CustomResourceOptions? opts = null)
    public static LoadBalancer get(String name, Output<String> id, LoadBalancerState 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:
    EdgeZone string
    Specifies the Edge Zone within the Azure Region where this Load Balancer should exist. Changing this forces a new Load Balancer to be created.
    FrontendIpConfigurations List<Pulumi.Azure.Lb.Inputs.LoadBalancerFrontendIpConfiguration>
    One or more frontend_ip_configuration blocks as documented below.
    Location string
    Specifies the supported Azure Region where the Load Balancer should be created. Changing this forces a new resource to be created.
    Name string
    Specifies the name of the Load Balancer. Changing this forces a new resource to be created.
    PrivateIpAddress string
    Private IP Address to assign to the Load Balancer. The last one and first four IPs in any range are reserved and cannot be manually assigned.
    PrivateIpAddresses List<string>
    The list of private IP address assigned to the load balancer in frontend_ip_configuration blocks, if any.
    ResourceGroupName string
    The name of the Resource Group in which to create the Load Balancer. Changing this forces a new resource to be created.
    Sku string

    The SKU of the Azure Load Balancer. Accepted values are Basic, Standard and Gateway. Defaults to Basic. Changing this forces a new resource to be created.

    NOTE: The Microsoft.Network/AllowGatewayLoadBalancer feature is required to be registered in order to use the Gateway SKU. The feature can only be registered by the Azure service team, please submit an Azure support ticket for that.

    SkuTier string
    sku_tier - (Optional) The SKU tier of this Load Balancer. Possible values are Global and Regional. Defaults to Regional. Changing this forces a new resource to be created.
    Tags Dictionary<string, string>
    A mapping of tags to assign to the resource.
    EdgeZone string
    Specifies the Edge Zone within the Azure Region where this Load Balancer should exist. Changing this forces a new Load Balancer to be created.
    FrontendIpConfigurations []LoadBalancerFrontendIpConfigurationArgs
    One or more frontend_ip_configuration blocks as documented below.
    Location string
    Specifies the supported Azure Region where the Load Balancer should be created. Changing this forces a new resource to be created.
    Name string
    Specifies the name of the Load Balancer. Changing this forces a new resource to be created.
    PrivateIpAddress string
    Private IP Address to assign to the Load Balancer. The last one and first four IPs in any range are reserved and cannot be manually assigned.
    PrivateIpAddresses []string
    The list of private IP address assigned to the load balancer in frontend_ip_configuration blocks, if any.
    ResourceGroupName string
    The name of the Resource Group in which to create the Load Balancer. Changing this forces a new resource to be created.
    Sku string

    The SKU of the Azure Load Balancer. Accepted values are Basic, Standard and Gateway. Defaults to Basic. Changing this forces a new resource to be created.

    NOTE: The Microsoft.Network/AllowGatewayLoadBalancer feature is required to be registered in order to use the Gateway SKU. The feature can only be registered by the Azure service team, please submit an Azure support ticket for that.

    SkuTier string
    sku_tier - (Optional) The SKU tier of this Load Balancer. Possible values are Global and Regional. Defaults to Regional. Changing this forces a new resource to be created.
    Tags map[string]string
    A mapping of tags to assign to the resource.
    edgeZone String
    Specifies the Edge Zone within the Azure Region where this Load Balancer should exist. Changing this forces a new Load Balancer to be created.
    frontendIpConfigurations List<LoadBalancerFrontendIpConfiguration>
    One or more frontend_ip_configuration blocks as documented below.
    location String
    Specifies the supported Azure Region where the Load Balancer should be created. Changing this forces a new resource to be created.
    name String
    Specifies the name of the Load Balancer. Changing this forces a new resource to be created.
    privateIpAddress String
    Private IP Address to assign to the Load Balancer. The last one and first four IPs in any range are reserved and cannot be manually assigned.
    privateIpAddresses List<String>
    The list of private IP address assigned to the load balancer in frontend_ip_configuration blocks, if any.
    resourceGroupName String
    The name of the Resource Group in which to create the Load Balancer. Changing this forces a new resource to be created.
    sku String

    The SKU of the Azure Load Balancer. Accepted values are Basic, Standard and Gateway. Defaults to Basic. Changing this forces a new resource to be created.

    NOTE: The Microsoft.Network/AllowGatewayLoadBalancer feature is required to be registered in order to use the Gateway SKU. The feature can only be registered by the Azure service team, please submit an Azure support ticket for that.

    skuTier String
    sku_tier - (Optional) The SKU tier of this Load Balancer. Possible values are Global and Regional. Defaults to Regional. Changing this forces a new resource to be created.
    tags Map<String,String>
    A mapping of tags to assign to the resource.
    edgeZone string
    Specifies the Edge Zone within the Azure Region where this Load Balancer should exist. Changing this forces a new Load Balancer to be created.
    frontendIpConfigurations LoadBalancerFrontendIpConfiguration[]
    One or more frontend_ip_configuration blocks as documented below.
    location string
    Specifies the supported Azure Region where the Load Balancer should be created. Changing this forces a new resource to be created.
    name string
    Specifies the name of the Load Balancer. Changing this forces a new resource to be created.
    privateIpAddress string
    Private IP Address to assign to the Load Balancer. The last one and first four IPs in any range are reserved and cannot be manually assigned.
    privateIpAddresses string[]
    The list of private IP address assigned to the load balancer in frontend_ip_configuration blocks, if any.
    resourceGroupName string
    The name of the Resource Group in which to create the Load Balancer. Changing this forces a new resource to be created.
    sku string

    The SKU of the Azure Load Balancer. Accepted values are Basic, Standard and Gateway. Defaults to Basic. Changing this forces a new resource to be created.

    NOTE: The Microsoft.Network/AllowGatewayLoadBalancer feature is required to be registered in order to use the Gateway SKU. The feature can only be registered by the Azure service team, please submit an Azure support ticket for that.

    skuTier string
    sku_tier - (Optional) The SKU tier of this Load Balancer. Possible values are Global and Regional. Defaults to Regional. Changing this forces a new resource to be created.
    tags {[key: string]: string}
    A mapping of tags to assign to the resource.
    edge_zone str
    Specifies the Edge Zone within the Azure Region where this Load Balancer should exist. Changing this forces a new Load Balancer to be created.
    frontend_ip_configurations Sequence[LoadBalancerFrontendIpConfigurationArgs]
    One or more frontend_ip_configuration blocks as documented below.
    location str
    Specifies the supported Azure Region where the Load Balancer should be created. Changing this forces a new resource to be created.
    name str
    Specifies the name of the Load Balancer. Changing this forces a new resource to be created.
    private_ip_address str
    Private IP Address to assign to the Load Balancer. The last one and first four IPs in any range are reserved and cannot be manually assigned.
    private_ip_addresses Sequence[str]
    The list of private IP address assigned to the load balancer in frontend_ip_configuration blocks, if any.
    resource_group_name str
    The name of the Resource Group in which to create the Load Balancer. Changing this forces a new resource to be created.
    sku str

    The SKU of the Azure Load Balancer. Accepted values are Basic, Standard and Gateway. Defaults to Basic. Changing this forces a new resource to be created.

    NOTE: The Microsoft.Network/AllowGatewayLoadBalancer feature is required to be registered in order to use the Gateway SKU. The feature can only be registered by the Azure service team, please submit an Azure support ticket for that.

    sku_tier str
    sku_tier - (Optional) The SKU tier of this Load Balancer. Possible values are Global and Regional. Defaults to Regional. Changing this forces a new resource to be created.
    tags Mapping[str, str]
    A mapping of tags to assign to the resource.
    edgeZone String
    Specifies the Edge Zone within the Azure Region where this Load Balancer should exist. Changing this forces a new Load Balancer to be created.
    frontendIpConfigurations List<Property Map>
    One or more frontend_ip_configuration blocks as documented below.
    location String
    Specifies the supported Azure Region where the Load Balancer should be created. Changing this forces a new resource to be created.
    name String
    Specifies the name of the Load Balancer. Changing this forces a new resource to be created.
    privateIpAddress String
    Private IP Address to assign to the Load Balancer. The last one and first four IPs in any range are reserved and cannot be manually assigned.
    privateIpAddresses List<String>
    The list of private IP address assigned to the load balancer in frontend_ip_configuration blocks, if any.
    resourceGroupName String
    The name of the Resource Group in which to create the Load Balancer. Changing this forces a new resource to be created.
    sku String

    The SKU of the Azure Load Balancer. Accepted values are Basic, Standard and Gateway. Defaults to Basic. Changing this forces a new resource to be created.

    NOTE: The Microsoft.Network/AllowGatewayLoadBalancer feature is required to be registered in order to use the Gateway SKU. The feature can only be registered by the Azure service team, please submit an Azure support ticket for that.

    skuTier String
    sku_tier - (Optional) The SKU tier of this Load Balancer. Possible values are Global and Regional. Defaults to Regional. Changing this forces a new resource to be created.
    tags Map<String>
    A mapping of tags to assign to the resource.

    Supporting Types

    LoadBalancerFrontendIpConfiguration, LoadBalancerFrontendIpConfigurationArgs

    Name string
    Specifies the name of the frontend IP configuration.
    GatewayLoadBalancerFrontendIpConfigurationId string
    The Frontend IP Configuration ID of a Gateway SKU Load Balancer.
    Id string
    The id of the Frontend IP Configuration.
    InboundNatRules List<string>
    The list of IDs of inbound rules that use this frontend IP.
    LoadBalancerRules List<string>
    The list of IDs of load balancing rules that use this frontend IP.
    OutboundRules List<string>
    The list of IDs outbound rules that use this frontend IP.
    PrivateIpAddress string
    Private IP Address to assign to the Load Balancer. The last one and first four IPs in any range are reserved and cannot be manually assigned.
    PrivateIpAddressAllocation string
    The allocation method for the Private IP Address used by this Load Balancer. Possible values as Dynamic and Static.
    PrivateIpAddressVersion string
    The version of IP that the Private IP Address is. Possible values are IPv4 or IPv6.
    PublicIpAddressId string
    The ID of a Public IP Address which should be associated with the Load Balancer.
    PublicIpPrefixId string
    The ID of a Public IP Prefix which should be associated with the Load Balancer. Public IP Prefix can only be used with outbound rules.
    SubnetId string
    The ID of the Subnet which should be associated with the IP Configuration.
    Zones List<string>

    Specifies a list of Availability Zones in which the IP Address for this Load Balancer should be located.

    NOTE: Availability Zones are only supported with a Standard SKU and in select regions at this time.

    Name string
    Specifies the name of the frontend IP configuration.
    GatewayLoadBalancerFrontendIpConfigurationId string
    The Frontend IP Configuration ID of a Gateway SKU Load Balancer.
    Id string
    The id of the Frontend IP Configuration.
    InboundNatRules []string
    The list of IDs of inbound rules that use this frontend IP.
    LoadBalancerRules []string
    The list of IDs of load balancing rules that use this frontend IP.
    OutboundRules []string
    The list of IDs outbound rules that use this frontend IP.
    PrivateIpAddress string
    Private IP Address to assign to the Load Balancer. The last one and first four IPs in any range are reserved and cannot be manually assigned.
    PrivateIpAddressAllocation string
    The allocation method for the Private IP Address used by this Load Balancer. Possible values as Dynamic and Static.
    PrivateIpAddressVersion string
    The version of IP that the Private IP Address is. Possible values are IPv4 or IPv6.
    PublicIpAddressId string
    The ID of a Public IP Address which should be associated with the Load Balancer.
    PublicIpPrefixId string
    The ID of a Public IP Prefix which should be associated with the Load Balancer. Public IP Prefix can only be used with outbound rules.
    SubnetId string
    The ID of the Subnet which should be associated with the IP Configuration.
    Zones []string

    Specifies a list of Availability Zones in which the IP Address for this Load Balancer should be located.

    NOTE: Availability Zones are only supported with a Standard SKU and in select regions at this time.

    name String
    Specifies the name of the frontend IP configuration.
    gatewayLoadBalancerFrontendIpConfigurationId String
    The Frontend IP Configuration ID of a Gateway SKU Load Balancer.
    id String
    The id of the Frontend IP Configuration.
    inboundNatRules List<String>
    The list of IDs of inbound rules that use this frontend IP.
    loadBalancerRules List<String>
    The list of IDs of load balancing rules that use this frontend IP.
    outboundRules List<String>
    The list of IDs outbound rules that use this frontend IP.
    privateIpAddress String
    Private IP Address to assign to the Load Balancer. The last one and first four IPs in any range are reserved and cannot be manually assigned.
    privateIpAddressAllocation String
    The allocation method for the Private IP Address used by this Load Balancer. Possible values as Dynamic and Static.
    privateIpAddressVersion String
    The version of IP that the Private IP Address is. Possible values are IPv4 or IPv6.
    publicIpAddressId String
    The ID of a Public IP Address which should be associated with the Load Balancer.
    publicIpPrefixId String
    The ID of a Public IP Prefix which should be associated with the Load Balancer. Public IP Prefix can only be used with outbound rules.
    subnetId String
    The ID of the Subnet which should be associated with the IP Configuration.
    zones List<String>

    Specifies a list of Availability Zones in which the IP Address for this Load Balancer should be located.

    NOTE: Availability Zones are only supported with a Standard SKU and in select regions at this time.

    name string
    Specifies the name of the frontend IP configuration.
    gatewayLoadBalancerFrontendIpConfigurationId string
    The Frontend IP Configuration ID of a Gateway SKU Load Balancer.
    id string
    The id of the Frontend IP Configuration.
    inboundNatRules string[]
    The list of IDs of inbound rules that use this frontend IP.
    loadBalancerRules string[]
    The list of IDs of load balancing rules that use this frontend IP.
    outboundRules string[]
    The list of IDs outbound rules that use this frontend IP.
    privateIpAddress string
    Private IP Address to assign to the Load Balancer. The last one and first four IPs in any range are reserved and cannot be manually assigned.
    privateIpAddressAllocation string
    The allocation method for the Private IP Address used by this Load Balancer. Possible values as Dynamic and Static.
    privateIpAddressVersion string
    The version of IP that the Private IP Address is. Possible values are IPv4 or IPv6.
    publicIpAddressId string
    The ID of a Public IP Address which should be associated with the Load Balancer.
    publicIpPrefixId string
    The ID of a Public IP Prefix which should be associated with the Load Balancer. Public IP Prefix can only be used with outbound rules.
    subnetId string
    The ID of the Subnet which should be associated with the IP Configuration.
    zones string[]

    Specifies a list of Availability Zones in which the IP Address for this Load Balancer should be located.

    NOTE: Availability Zones are only supported with a Standard SKU and in select regions at this time.

    name str
    Specifies the name of the frontend IP configuration.
    gateway_load_balancer_frontend_ip_configuration_id str
    The Frontend IP Configuration ID of a Gateway SKU Load Balancer.
    id str
    The id of the Frontend IP Configuration.
    inbound_nat_rules Sequence[str]
    The list of IDs of inbound rules that use this frontend IP.
    load_balancer_rules Sequence[str]
    The list of IDs of load balancing rules that use this frontend IP.
    outbound_rules Sequence[str]
    The list of IDs outbound rules that use this frontend IP.
    private_ip_address str
    Private IP Address to assign to the Load Balancer. The last one and first four IPs in any range are reserved and cannot be manually assigned.
    private_ip_address_allocation str
    The allocation method for the Private IP Address used by this Load Balancer. Possible values as Dynamic and Static.
    private_ip_address_version str
    The version of IP that the Private IP Address is. Possible values are IPv4 or IPv6.
    public_ip_address_id str
    The ID of a Public IP Address which should be associated with the Load Balancer.
    public_ip_prefix_id str
    The ID of a Public IP Prefix which should be associated with the Load Balancer. Public IP Prefix can only be used with outbound rules.
    subnet_id str
    The ID of the Subnet which should be associated with the IP Configuration.
    zones Sequence[str]

    Specifies a list of Availability Zones in which the IP Address for this Load Balancer should be located.

    NOTE: Availability Zones are only supported with a Standard SKU and in select regions at this time.

    name String
    Specifies the name of the frontend IP configuration.
    gatewayLoadBalancerFrontendIpConfigurationId String
    The Frontend IP Configuration ID of a Gateway SKU Load Balancer.
    id String
    The id of the Frontend IP Configuration.
    inboundNatRules List<String>
    The list of IDs of inbound rules that use this frontend IP.
    loadBalancerRules List<String>
    The list of IDs of load balancing rules that use this frontend IP.
    outboundRules List<String>
    The list of IDs outbound rules that use this frontend IP.
    privateIpAddress String
    Private IP Address to assign to the Load Balancer. The last one and first four IPs in any range are reserved and cannot be manually assigned.
    privateIpAddressAllocation String
    The allocation method for the Private IP Address used by this Load Balancer. Possible values as Dynamic and Static.
    privateIpAddressVersion String
    The version of IP that the Private IP Address is. Possible values are IPv4 or IPv6.
    publicIpAddressId String
    The ID of a Public IP Address which should be associated with the Load Balancer.
    publicIpPrefixId String
    The ID of a Public IP Prefix which should be associated with the Load Balancer. Public IP Prefix can only be used with outbound rules.
    subnetId String
    The ID of the Subnet which should be associated with the IP Configuration.
    zones List<String>

    Specifies a list of Availability Zones in which the IP Address for this Load Balancer should be located.

    NOTE: Availability Zones are only supported with a Standard SKU and in select regions at this time.

    Import

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

    $ pulumi import azure:lb/loadBalancer:LoadBalancer example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.Network/loadBalancers/lb1

    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.73.0 published on Monday, Apr 22, 2024 by Pulumi
    pulumi/pulumi-azure