We recommend using Azure Native.
azure.lb.LoadBalancer
Explore with Pulumi AI
Manages a Load Balancer Resource.
Example Usage
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
return await Deployment.RunAsync(() =>
{
var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new()
{
Location = "West Europe",
});
var examplePublicIp = new Azure.Network.PublicIp("examplePublicIp", new()
{
Location = exampleResourceGroup.Location,
ResourceGroupName = exampleResourceGroup.Name,
AllocationMethod = "Static",
});
var exampleLoadBalancer = new Azure.Lb.LoadBalancer("exampleLoadBalancer", new()
{
Location = exampleResourceGroup.Location,
ResourceGroupName = exampleResourceGroup.Name,
FrontendIpConfigurations = new[]
{
new Azure.Lb.Inputs.LoadBalancerFrontendIpConfigurationArgs
{
Name = "PublicIPAddress",
PublicIpAddressId = examplePublicIp.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 {
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: exampleResourceGroup.Location,
ResourceGroupName: exampleResourceGroup.Name,
AllocationMethod: pulumi.String("Static"),
})
if err != nil {
return err
}
_, err = lb.NewLoadBalancer(ctx, "exampleLoadBalancer", &lb.LoadBalancerArgs{
Location: exampleResourceGroup.Location,
ResourceGroupName: exampleResourceGroup.Name,
FrontendIpConfigurations: lb.LoadBalancerFrontendIpConfigurationArray{
&lb.LoadBalancerFrontendIpConfigurationArgs{
Name: pulumi.String("PublicIPAddress"),
PublicIpAddressId: examplePublicIp.ID(),
},
},
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.network.PublicIp;
import com.pulumi.azure.network.PublicIpArgs;
import com.pulumi.azure.lb.LoadBalancer;
import com.pulumi.azure.lb.LoadBalancerArgs;
import com.pulumi.azure.lb.inputs.LoadBalancerFrontendIpConfigurationArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()
.location("West Europe")
.build());
var examplePublicIp = new PublicIp("examplePublicIp", PublicIpArgs.builder()
.location(exampleResourceGroup.location())
.resourceGroupName(exampleResourceGroup.name())
.allocationMethod("Static")
.build());
var exampleLoadBalancer = new LoadBalancer("exampleLoadBalancer", LoadBalancerArgs.builder()
.location(exampleResourceGroup.location())
.resourceGroupName(exampleResourceGroup.name())
.frontendIpConfigurations(LoadBalancerFrontendIpConfigurationArgs.builder()
.name("PublicIPAddress")
.publicIpAddressId(examplePublicIp.id())
.build())
.build());
}
}
import pulumi
import pulumi_azure as azure
example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_public_ip = azure.network.PublicIp("examplePublicIp",
location=example_resource_group.location,
resource_group_name=example_resource_group.name,
allocation_method="Static")
example_load_balancer = azure.lb.LoadBalancer("exampleLoadBalancer",
location=example_resource_group.location,
resource_group_name=example_resource_group.name,
frontend_ip_configurations=[azure.lb.LoadBalancerFrontendIpConfigurationArgs(
name="PublicIPAddress",
public_ip_address_id=example_public_ip.id,
)])
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: exampleResourceGroup.location,
resourceGroupName: exampleResourceGroup.name,
allocationMethod: "Static",
});
const exampleLoadBalancer = new azure.lb.LoadBalancer("exampleLoadBalancer", {
location: exampleResourceGroup.location,
resourceGroupName: exampleResourceGroup.name,
frontendIpConfigurations: [{
name: "PublicIPAddress",
publicIpAddressId: examplePublicIp.id,
}],
});
resources:
exampleResourceGroup:
type: azure:core:ResourceGroup
properties:
location: West Europe
examplePublicIp:
type: azure:network:PublicIp
properties:
location: ${exampleResourceGroup.location}
resourceGroupName: ${exampleResourceGroup.name}
allocationMethod: Static
exampleLoadBalancer:
type: azure:lb:LoadBalancer
properties:
location: ${exampleResourceGroup.location}
resourceGroupName: ${exampleResourceGroup.name}
frontendIpConfigurations:
- name: PublicIPAddress
publicIpAddressId: ${examplePublicIp.id}
Create LoadBalancer Resource
new LoadBalancer(name: string, args: LoadBalancerArgs, opts?: CustomResourceOptions);
@overload
def LoadBalancer(resource_name: 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,
resource_group_name: Optional[str] = None,
sku: Optional[str] = None,
sku_tier: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None)
@overload
def LoadBalancer(resource_name: str,
args: LoadBalancerArgs,
opts: Optional[ResourceOptions] = 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.
- 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.
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:
- Resource
Group stringName The name of the Resource Group in which to create the Load Balancer. Changing this forces a new resource to be created.
- Edge
Zone 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.
- Frontend
Ip List<Pulumi.Configurations Azure. Lb. Inputs. Load Balancer Frontend Ip Configuration> 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
andGateway
. Defaults toBasic
. Changing this forces a new resource to be created.NOTE: The
Microsoft.Network/AllowGatewayLoadBalancer
feature is required to be registered in order to use theGateway
SKU. The feature can only be registered by the Azure service team, please submit an Azure support ticket for that.- Sku
Tier string sku_tier
- (Optional) The SKU tier of this Load Balancer. Possible values areGlobal
andRegional
. Defaults toRegional
. Changing this forces a new resource to be created.- Dictionary<string, string>
A mapping of tags to assign to the resource.
- Resource
Group stringName The name of the Resource Group in which to create the Load Balancer. Changing this forces a new resource to be created.
- Edge
Zone 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.
- Frontend
Ip []LoadConfigurations Balancer Frontend Ip Configuration Args 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
andGateway
. Defaults toBasic
. Changing this forces a new resource to be created.NOTE: The
Microsoft.Network/AllowGatewayLoadBalancer
feature is required to be registered in order to use theGateway
SKU. The feature can only be registered by the Azure service team, please submit an Azure support ticket for that.- Sku
Tier string sku_tier
- (Optional) The SKU tier of this Load Balancer. Possible values areGlobal
andRegional
. Defaults toRegional
. Changing this forces a new resource to be created.- map[string]string
A mapping of tags to assign to the resource.
- resource
Group StringName The name of the Resource Group in which to create the Load Balancer. Changing this forces a new resource to be created.
- edge
Zone 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.
- frontend
Ip List<LoadConfigurations Balancer Frontend Ip Configuration> 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
andGateway
. Defaults toBasic
. Changing this forces a new resource to be created.NOTE: The
Microsoft.Network/AllowGatewayLoadBalancer
feature is required to be registered in order to use theGateway
SKU. The feature can only be registered by the Azure service team, please submit an Azure support ticket for that.- sku
Tier String sku_tier
- (Optional) The SKU tier of this Load Balancer. Possible values areGlobal
andRegional
. Defaults toRegional
. Changing this forces a new resource to be created.- Map<String,String>
A mapping of tags to assign to the resource.
- resource
Group stringName The name of the Resource Group in which to create the Load Balancer. Changing this forces a new resource to be created.
- edge
Zone 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.
- frontend
Ip LoadConfigurations Balancer Frontend Ip Configuration[] 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
andGateway
. Defaults toBasic
. Changing this forces a new resource to be created.NOTE: The
Microsoft.Network/AllowGatewayLoadBalancer
feature is required to be registered in order to use theGateway
SKU. The feature can only be registered by the Azure service team, please submit an Azure support ticket for that.- sku
Tier string sku_tier
- (Optional) The SKU tier of this Load Balancer. Possible values areGlobal
andRegional
. Defaults toRegional
. Changing this forces a new resource to be created.- {[key: string]: string}
A mapping of tags to assign to the resource.
- resource_
group_ strname 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_ Sequence[Loadconfigurations Balancer Frontend Ip Configuration Args] 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
andGateway
. Defaults toBasic
. Changing this forces a new resource to be created.NOTE: The
Microsoft.Network/AllowGatewayLoadBalancer
feature is required to be registered in order to use theGateway
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 areGlobal
andRegional
. Defaults toRegional
. Changing this forces a new resource to be created.- Mapping[str, str]
A mapping of tags to assign to the resource.
- resource
Group StringName The name of the Resource Group in which to create the Load Balancer. Changing this forces a new resource to be created.
- edge
Zone 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.
- frontend
Ip List<Property Map>Configurations 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
andGateway
. Defaults toBasic
. Changing this forces a new resource to be created.NOTE: The
Microsoft.Network/AllowGatewayLoadBalancer
feature is required to be registered in order to use theGateway
SKU. The feature can only be registered by the Azure service team, please submit an Azure support ticket for that.- sku
Tier String sku_tier
- (Optional) The SKU tier of this Load Balancer. Possible values areGlobal
andRegional
. Defaults toRegional
. Changing this forces a new resource to be created.- 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.
- Private
Ip stringAddress 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 List<string>Addresses 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.
- Private
Ip stringAddress 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 []stringAddresses 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.
- private
Ip StringAddress 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 List<String>Addresses 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.
- private
Ip stringAddress 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 string[]Addresses 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_ straddress 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_ Sequence[str]addresses 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.
- private
Ip StringAddress 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 List<String>Addresses 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.
- Edge
Zone 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.
- Frontend
Ip List<Pulumi.Configurations Azure. Lb. Inputs. Load Balancer Frontend Ip Configuration> 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.
- Private
Ip stringAddress 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 List<string>Addresses The list of private IP address assigned to the load balancer in
frontend_ip_configuration
blocks, if any.- Resource
Group stringName 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
andGateway
. Defaults toBasic
. Changing this forces a new resource to be created.NOTE: The
Microsoft.Network/AllowGatewayLoadBalancer
feature is required to be registered in order to use theGateway
SKU. The feature can only be registered by the Azure service team, please submit an Azure support ticket for that.- Sku
Tier string sku_tier
- (Optional) The SKU tier of this Load Balancer. Possible values areGlobal
andRegional
. Defaults toRegional
. Changing this forces a new resource to be created.- Dictionary<string, string>
A mapping of tags to assign to the resource.
- Edge
Zone 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.
- Frontend
Ip []LoadConfigurations Balancer Frontend Ip Configuration Args 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.
- Private
Ip stringAddress 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 []stringAddresses The list of private IP address assigned to the load balancer in
frontend_ip_configuration
blocks, if any.- Resource
Group stringName 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
andGateway
. Defaults toBasic
. Changing this forces a new resource to be created.NOTE: The
Microsoft.Network/AllowGatewayLoadBalancer
feature is required to be registered in order to use theGateway
SKU. The feature can only be registered by the Azure service team, please submit an Azure support ticket for that.- Sku
Tier string sku_tier
- (Optional) The SKU tier of this Load Balancer. Possible values areGlobal
andRegional
. Defaults toRegional
. Changing this forces a new resource to be created.- map[string]string
A mapping of tags to assign to the resource.
- edge
Zone 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.
- frontend
Ip List<LoadConfigurations Balancer Frontend Ip Configuration> 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.
- private
Ip StringAddress 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 List<String>Addresses The list of private IP address assigned to the load balancer in
frontend_ip_configuration
blocks, if any.- resource
Group StringName 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
andGateway
. Defaults toBasic
. Changing this forces a new resource to be created.NOTE: The
Microsoft.Network/AllowGatewayLoadBalancer
feature is required to be registered in order to use theGateway
SKU. The feature can only be registered by the Azure service team, please submit an Azure support ticket for that.- sku
Tier String sku_tier
- (Optional) The SKU tier of this Load Balancer. Possible values areGlobal
andRegional
. Defaults toRegional
. Changing this forces a new resource to be created.- Map<String,String>
A mapping of tags to assign to the resource.
- edge
Zone 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.
- frontend
Ip LoadConfigurations Balancer Frontend Ip Configuration[] 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.
- private
Ip stringAddress 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 string[]Addresses The list of private IP address assigned to the load balancer in
frontend_ip_configuration
blocks, if any.- resource
Group stringName 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
andGateway
. Defaults toBasic
. Changing this forces a new resource to be created.NOTE: The
Microsoft.Network/AllowGatewayLoadBalancer
feature is required to be registered in order to use theGateway
SKU. The feature can only be registered by the Azure service team, please submit an Azure support ticket for that.- sku
Tier string sku_tier
- (Optional) The SKU tier of this Load Balancer. Possible values areGlobal
andRegional
. Defaults toRegional
. Changing this forces a new resource to be created.- {[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_ Sequence[Loadconfigurations Balancer Frontend Ip Configuration Args] 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_ straddress 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_ Sequence[str]addresses The list of private IP address assigned to the load balancer in
frontend_ip_configuration
blocks, if any.- resource_
group_ strname 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
andGateway
. Defaults toBasic
. Changing this forces a new resource to be created.NOTE: The
Microsoft.Network/AllowGatewayLoadBalancer
feature is required to be registered in order to use theGateway
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 areGlobal
andRegional
. Defaults toRegional
. Changing this forces a new resource to be created.- Mapping[str, str]
A mapping of tags to assign to the resource.
- edge
Zone 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.
- frontend
Ip List<Property Map>Configurations 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.
- private
Ip StringAddress 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 List<String>Addresses The list of private IP address assigned to the load balancer in
frontend_ip_configuration
blocks, if any.- resource
Group StringName 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
andGateway
. Defaults toBasic
. Changing this forces a new resource to be created.NOTE: The
Microsoft.Network/AllowGatewayLoadBalancer
feature is required to be registered in order to use theGateway
SKU. The feature can only be registered by the Azure service team, please submit an Azure support ticket for that.- sku
Tier String sku_tier
- (Optional) The SKU tier of this Load Balancer. Possible values areGlobal
andRegional
. Defaults toRegional
. Changing this forces a new resource to be created.- 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.
- Gateway
Load stringBalancer Frontend Ip Configuration Id The Frontend IP Configuration ID of a Gateway SKU Load Balancer.
- Id string
The id of the Frontend IP Configuration.
- Inbound
Nat List<string>Rules The list of IDs of inbound rules that use this frontend IP.
- Load
Balancer List<string>Rules The list of IDs of load balancing rules that use this frontend IP.
- Outbound
Rules List<string> The list of IDs outbound rules that use this frontend IP.
- Private
Ip stringAddress 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 stringAddress Allocation The allocation method for the Private IP Address used by this Load Balancer. Possible values as
Dynamic
andStatic
.- Private
Ip stringAddress Version The version of IP that the Private IP Address is. Possible values are
IPv4
orIPv6
.- Public
Ip stringAddress Id The ID of a Public IP Address which should be associated with the Load Balancer.
- Public
Ip stringPrefix Id 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 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.
- Gateway
Load stringBalancer Frontend Ip Configuration Id The Frontend IP Configuration ID of a Gateway SKU Load Balancer.
- Id string
The id of the Frontend IP Configuration.
- Inbound
Nat []stringRules The list of IDs of inbound rules that use this frontend IP.
- Load
Balancer []stringRules The list of IDs of load balancing rules that use this frontend IP.
- Outbound
Rules []string The list of IDs outbound rules that use this frontend IP.
- Private
Ip stringAddress 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 stringAddress Allocation The allocation method for the Private IP Address used by this Load Balancer. Possible values as
Dynamic
andStatic
.- Private
Ip stringAddress Version The version of IP that the Private IP Address is. Possible values are
IPv4
orIPv6
.- Public
Ip stringAddress Id The ID of a Public IP Address which should be associated with the Load Balancer.
- Public
Ip stringPrefix Id 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 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.
- gateway
Load StringBalancer Frontend Ip Configuration Id The Frontend IP Configuration ID of a Gateway SKU Load Balancer.
- id String
The id of the Frontend IP Configuration.
- inbound
Nat List<String>Rules The list of IDs of inbound rules that use this frontend IP.
- load
Balancer List<String>Rules The list of IDs of load balancing rules that use this frontend IP.
- outbound
Rules List<String> The list of IDs outbound rules that use this frontend IP.
- private
Ip StringAddress 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 StringAddress Allocation The allocation method for the Private IP Address used by this Load Balancer. Possible values as
Dynamic
andStatic
.- private
Ip StringAddress Version The version of IP that the Private IP Address is. Possible values are
IPv4
orIPv6
.- public
Ip StringAddress Id The ID of a Public IP Address which should be associated with the Load Balancer.
- public
Ip StringPrefix Id 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 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.
- gateway
Load stringBalancer Frontend Ip Configuration Id The Frontend IP Configuration ID of a Gateway SKU Load Balancer.
- id string
The id of the Frontend IP Configuration.
- inbound
Nat string[]Rules The list of IDs of inbound rules that use this frontend IP.
- load
Balancer string[]Rules The list of IDs of load balancing rules that use this frontend IP.
- outbound
Rules string[] The list of IDs outbound rules that use this frontend IP.
- private
Ip stringAddress 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 stringAddress Allocation The allocation method for the Private IP Address used by this Load Balancer. Possible values as
Dynamic
andStatic
.- private
Ip stringAddress Version The version of IP that the Private IP Address is. Possible values are
IPv4
orIPv6
.- public
Ip stringAddress Id The ID of a Public IP Address which should be associated with the Load Balancer.
- public
Ip stringPrefix Id 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 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_ strbalancer_ frontend_ ip_ configuration_ id The Frontend IP Configuration ID of a Gateway SKU Load Balancer.
- id str
The id of the Frontend IP Configuration.
- inbound_
nat_ Sequence[str]rules The list of IDs of inbound rules that use this frontend IP.
- load_
balancer_ Sequence[str]rules 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_ straddress 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_ straddress_ allocation The allocation method for the Private IP Address used by this Load Balancer. Possible values as
Dynamic
andStatic
.- private_
ip_ straddress_ version The version of IP that the Private IP Address is. Possible values are
IPv4
orIPv6
.- public_
ip_ straddress_ id The ID of a Public IP Address which should be associated with the Load Balancer.
- public_
ip_ strprefix_ id 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.
- gateway
Load StringBalancer Frontend Ip Configuration Id The Frontend IP Configuration ID of a Gateway SKU Load Balancer.
- id String
The id of the Frontend IP Configuration.
- inbound
Nat List<String>Rules The list of IDs of inbound rules that use this frontend IP.
- load
Balancer List<String>Rules The list of IDs of load balancing rules that use this frontend IP.
- outbound
Rules List<String> The list of IDs outbound rules that use this frontend IP.
- private
Ip StringAddress 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 StringAddress Allocation The allocation method for the Private IP Address used by this Load Balancer. Possible values as
Dynamic
andStatic
.- private
Ip StringAddress Version The version of IP that the Private IP Address is. Possible values are
IPv4
orIPv6
.- public
Ip StringAddress Id The ID of a Public IP Address which should be associated with the Load Balancer.
- public
Ip StringPrefix Id 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 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
Package Details
- Repository
- Azure Classic pulumi/pulumi-azure
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
azurerm
Terraform Provider.