Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. lb
  5. BackendAddressPool

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

azure.lb.BackendAddressPool

Explore with Pulumi AI

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

Manages a Load Balancer Backend Address Pool.

NOTE: When using this resource, the Load Balancer needs to have a FrontEnd IP Configuration 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", {
    loadbalancerId: exampleLoadBalancer.id,
    name: "BackEndAddressPool",
});
Copy
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=[{
        "name": "PublicIPAddress",
        "public_ip_address_id": example_public_ip.id,
    }])
example_backend_address_pool = azure.lb.BackendAddressPool("example",
    loadbalancer_id=example_load_balancer.id,
    name="BackEndAddressPool")
Copy
package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/lb"
	"github.com/pulumi/pulumi-azure/sdk/v6/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
		}
		_, err = lb.NewBackendAddressPool(ctx, "example", &lb.BackendAddressPoolArgs{
			LoadbalancerId: exampleLoadBalancer.ID(),
			Name:           pulumi.String("BackEndAddressPool"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
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()
    {
        LoadbalancerId = exampleLoadBalancer.Id,
        Name = "BackEndAddressPool",
    });

});
Copy
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 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()
            .loadbalancerId(exampleLoadBalancer.id())
            .name("BackEndAddressPool")
            .build());

    }
}
Copy
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:
      loadbalancerId: ${exampleLoadBalancer.id}
      name: BackEndAddressPool
Copy

Create BackendAddressPool Resource

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

Constructor syntax

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

@overload
def BackendAddressPool(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       loadbalancer_id: Optional[str] = None,
                       name: Optional[str] = None,
                       synchronous_mode: Optional[str] = None,
                       tunnel_interfaces: Optional[Sequence[BackendAddressPoolTunnelInterfaceArgs]] = None,
                       virtual_network_id: Optional[str] = None)
func NewBackendAddressPool(ctx *Context, name string, args BackendAddressPoolArgs, opts ...ResourceOption) (*BackendAddressPool, error)
public BackendAddressPool(string name, BackendAddressPoolArgs args, CustomResourceOptions? opts = null)
public BackendAddressPool(String name, BackendAddressPoolArgs args)
public BackendAddressPool(String name, BackendAddressPoolArgs args, CustomResourceOptions options)

type: azure:lb:BackendAddressPool
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. BackendAddressPoolArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. BackendAddressPoolArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. BackendAddressPoolArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. BackendAddressPoolArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. BackendAddressPoolArgs
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 backendAddressPoolResource = new Azure.Lb.BackendAddressPool("backendAddressPoolResource", new()
{
    LoadbalancerId = "string",
    Name = "string",
    SynchronousMode = "string",
    TunnelInterfaces = new[]
    {
        new Azure.Lb.Inputs.BackendAddressPoolTunnelInterfaceArgs
        {
            Identifier = 0,
            Port = 0,
            Protocol = "string",
            Type = "string",
        },
    },
    VirtualNetworkId = "string",
});
Copy
example, err := lb.NewBackendAddressPool(ctx, "backendAddressPoolResource", &lb.BackendAddressPoolArgs{
	LoadbalancerId:  pulumi.String("string"),
	Name:            pulumi.String("string"),
	SynchronousMode: pulumi.String("string"),
	TunnelInterfaces: lb.BackendAddressPoolTunnelInterfaceArray{
		&lb.BackendAddressPoolTunnelInterfaceArgs{
			Identifier: pulumi.Int(0),
			Port:       pulumi.Int(0),
			Protocol:   pulumi.String("string"),
			Type:       pulumi.String("string"),
		},
	},
	VirtualNetworkId: pulumi.String("string"),
})
Copy
var backendAddressPoolResource = new BackendAddressPool("backendAddressPoolResource", BackendAddressPoolArgs.builder()
    .loadbalancerId("string")
    .name("string")
    .synchronousMode("string")
    .tunnelInterfaces(BackendAddressPoolTunnelInterfaceArgs.builder()
        .identifier(0)
        .port(0)
        .protocol("string")
        .type("string")
        .build())
    .virtualNetworkId("string")
    .build());
Copy
backend_address_pool_resource = azure.lb.BackendAddressPool("backendAddressPoolResource",
    loadbalancer_id="string",
    name="string",
    synchronous_mode="string",
    tunnel_interfaces=[{
        "identifier": 0,
        "port": 0,
        "protocol": "string",
        "type": "string",
    }],
    virtual_network_id="string")
Copy
const backendAddressPoolResource = new azure.lb.BackendAddressPool("backendAddressPoolResource", {
    loadbalancerId: "string",
    name: "string",
    synchronousMode: "string",
    tunnelInterfaces: [{
        identifier: 0,
        port: 0,
        protocol: "string",
        type: "string",
    }],
    virtualNetworkId: "string",
});
Copy
type: azure:lb:BackendAddressPool
properties:
    loadbalancerId: string
    name: string
    synchronousMode: string
    tunnelInterfaces:
        - identifier: 0
          port: 0
          protocol: string
          type: string
    virtualNetworkId: string
Copy

BackendAddressPool Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

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

The BackendAddressPool resource accepts the following input properties:

LoadbalancerId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the Load Balancer in which to create the Backend Address Pool. Changing this forces a new resource to be created.
Name Changes to this property will trigger replacement. string
Specifies the name of the Backend Address Pool. Changing this forces a new resource to be created.
SynchronousMode Changes to this property will trigger replacement. string

The backend address synchronous mode for the Backend Address Pool. Possible values are Automatic and Manual. This is required with virtual_network_id. Changing this forces a new resource to be created.

NOTE: The synchronous_mode can set only for Load Balancer with Standard SKU.

TunnelInterfaces List<BackendAddressPoolTunnelInterface>
One or more tunnel_interface blocks as defined below.
VirtualNetworkId string
The ID of the Virtual Network within which the Backend Address Pool should exist.
LoadbalancerId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the Load Balancer in which to create the Backend Address Pool. Changing this forces a new resource to be created.
Name Changes to this property will trigger replacement. string
Specifies the name of the Backend Address Pool. Changing this forces a new resource to be created.
SynchronousMode Changes to this property will trigger replacement. string

The backend address synchronous mode for the Backend Address Pool. Possible values are Automatic and Manual. This is required with virtual_network_id. Changing this forces a new resource to be created.

NOTE: The synchronous_mode can set only for Load Balancer with Standard SKU.

TunnelInterfaces []BackendAddressPoolTunnelInterfaceArgs
One or more tunnel_interface blocks as defined below.
VirtualNetworkId string
The ID of the Virtual Network within which the Backend Address Pool should exist.
loadbalancerId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the Load Balancer in which to create the Backend Address Pool. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. String
Specifies the name of the Backend Address Pool. Changing this forces a new resource to be created.
synchronousMode Changes to this property will trigger replacement. String

The backend address synchronous mode for the Backend Address Pool. Possible values are Automatic and Manual. This is required with virtual_network_id. Changing this forces a new resource to be created.

NOTE: The synchronous_mode can set only for Load Balancer with Standard SKU.

tunnelInterfaces List<BackendAddressPoolTunnelInterface>
One or more tunnel_interface blocks as defined below.
virtualNetworkId String
The ID of the Virtual Network within which the Backend Address Pool should exist.
loadbalancerId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the Load Balancer in which to create the Backend Address Pool. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. string
Specifies the name of the Backend Address Pool. Changing this forces a new resource to be created.
synchronousMode Changes to this property will trigger replacement. string

The backend address synchronous mode for the Backend Address Pool. Possible values are Automatic and Manual. This is required with virtual_network_id. Changing this forces a new resource to be created.

NOTE: The synchronous_mode can set only for Load Balancer with Standard SKU.

tunnelInterfaces BackendAddressPoolTunnelInterface[]
One or more tunnel_interface blocks as defined below.
virtualNetworkId string
The ID of the Virtual Network within which the Backend Address Pool should exist.
loadbalancer_id
This property is required.
Changes to this property will trigger replacement.
str
The ID of the Load Balancer in which to create the Backend Address Pool. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. str
Specifies the name of the Backend Address Pool. Changing this forces a new resource to be created.
synchronous_mode Changes to this property will trigger replacement. str

The backend address synchronous mode for the Backend Address Pool. Possible values are Automatic and Manual. This is required with virtual_network_id. Changing this forces a new resource to be created.

NOTE: The synchronous_mode can set only for Load Balancer with Standard SKU.

tunnel_interfaces Sequence[BackendAddressPoolTunnelInterfaceArgs]
One or more tunnel_interface blocks as defined below.
virtual_network_id str
The ID of the Virtual Network within which the Backend Address Pool should exist.
loadbalancerId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the Load Balancer in which to create the Backend Address Pool. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. String
Specifies the name of the Backend Address Pool. Changing this forces a new resource to be created.
synchronousMode Changes to this property will trigger replacement. String

The backend address synchronous mode for the Backend Address Pool. Possible values are Automatic and Manual. This is required with virtual_network_id. Changing this forces a new resource to be created.

NOTE: The synchronous_mode can set only for Load Balancer with Standard SKU.

tunnelInterfaces List<Property Map>
One or more tunnel_interface blocks as defined below.
virtualNetworkId String
The ID of the Virtual Network within which the Backend Address Pool should exist.

Outputs

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

BackendIpConfigurations List<string>
The Backend IP Configurations associated with this Backend Address Pool.
Id string
The provider-assigned unique ID for this managed resource.
InboundNatRules List<string>
An array of the Load Balancing Inbound NAT Rules associated with this Backend Address Pool.
LoadBalancingRules List<string>
The Load Balancing Rules associated with this Backend Address Pool.
OutboundRules List<string>
An array of the Load Balancing Outbound Rules associated with this Backend Address Pool.
BackendIpConfigurations []string
The Backend IP Configurations associated with this Backend Address Pool.
Id string
The provider-assigned unique ID for this managed resource.
InboundNatRules []string
An array of the Load Balancing Inbound NAT Rules associated with this Backend Address Pool.
LoadBalancingRules []string
The Load Balancing Rules associated with this Backend Address Pool.
OutboundRules []string
An array of the Load Balancing Outbound Rules associated with this Backend Address Pool.
backendIpConfigurations List<String>
The Backend IP Configurations associated with this Backend Address Pool.
id String
The provider-assigned unique ID for this managed resource.
inboundNatRules List<String>
An array of the Load Balancing Inbound NAT Rules associated with this Backend Address Pool.
loadBalancingRules List<String>
The Load Balancing Rules associated with this Backend Address Pool.
outboundRules List<String>
An array of the Load Balancing Outbound Rules associated with this Backend Address Pool.
backendIpConfigurations string[]
The Backend IP Configurations associated with this Backend Address Pool.
id string
The provider-assigned unique ID for this managed resource.
inboundNatRules string[]
An array of the Load Balancing Inbound NAT Rules associated with this Backend Address Pool.
loadBalancingRules string[]
The Load Balancing Rules associated with this Backend Address Pool.
outboundRules string[]
An array of the Load Balancing Outbound Rules associated with this Backend Address Pool.
backend_ip_configurations Sequence[str]
The Backend IP Configurations associated with this Backend Address Pool.
id str
The provider-assigned unique ID for this managed resource.
inbound_nat_rules Sequence[str]
An array of the Load Balancing Inbound NAT Rules associated with this Backend Address Pool.
load_balancing_rules Sequence[str]
The Load Balancing Rules associated with this Backend Address Pool.
outbound_rules Sequence[str]
An array of the Load Balancing Outbound Rules associated with this Backend Address Pool.
backendIpConfigurations List<String>
The Backend IP Configurations associated with this Backend Address Pool.
id String
The provider-assigned unique ID for this managed resource.
inboundNatRules List<String>
An array of the Load Balancing Inbound NAT Rules associated with this Backend Address Pool.
loadBalancingRules List<String>
The Load Balancing Rules associated with this Backend Address Pool.
outboundRules List<String>
An array of the Load Balancing Outbound Rules associated with this Backend Address Pool.

Look up Existing BackendAddressPool Resource

Get an existing BackendAddressPool 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?: BackendAddressPoolState, opts?: CustomResourceOptions): BackendAddressPool
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        backend_ip_configurations: Optional[Sequence[str]] = None,
        inbound_nat_rules: Optional[Sequence[str]] = None,
        load_balancing_rules: Optional[Sequence[str]] = None,
        loadbalancer_id: Optional[str] = None,
        name: Optional[str] = None,
        outbound_rules: Optional[Sequence[str]] = None,
        synchronous_mode: Optional[str] = None,
        tunnel_interfaces: Optional[Sequence[BackendAddressPoolTunnelInterfaceArgs]] = None,
        virtual_network_id: Optional[str] = None) -> BackendAddressPool
func GetBackendAddressPool(ctx *Context, name string, id IDInput, state *BackendAddressPoolState, opts ...ResourceOption) (*BackendAddressPool, error)
public static BackendAddressPool Get(string name, Input<string> id, BackendAddressPoolState? state, CustomResourceOptions? opts = null)
public static BackendAddressPool get(String name, Output<String> id, BackendAddressPoolState state, CustomResourceOptions options)
resources:  _:    type: azure:lb:BackendAddressPool    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
BackendIpConfigurations List<string>
The Backend IP Configurations associated with this Backend Address Pool.
InboundNatRules List<string>
An array of the Load Balancing Inbound NAT Rules associated with this Backend Address Pool.
LoadBalancingRules List<string>
The Load Balancing Rules associated with this Backend Address Pool.
LoadbalancerId Changes to this property will trigger replacement. string
The ID of the Load Balancer in which to create the Backend Address Pool. Changing this forces a new resource to be created.
Name Changes to this property will trigger replacement. string
Specifies the name of the Backend Address Pool. Changing this forces a new resource to be created.
OutboundRules List<string>
An array of the Load Balancing Outbound Rules associated with this Backend Address Pool.
SynchronousMode Changes to this property will trigger replacement. string

The backend address synchronous mode for the Backend Address Pool. Possible values are Automatic and Manual. This is required with virtual_network_id. Changing this forces a new resource to be created.

NOTE: The synchronous_mode can set only for Load Balancer with Standard SKU.

TunnelInterfaces List<BackendAddressPoolTunnelInterface>
One or more tunnel_interface blocks as defined below.
VirtualNetworkId string
The ID of the Virtual Network within which the Backend Address Pool should exist.
BackendIpConfigurations []string
The Backend IP Configurations associated with this Backend Address Pool.
InboundNatRules []string
An array of the Load Balancing Inbound NAT Rules associated with this Backend Address Pool.
LoadBalancingRules []string
The Load Balancing Rules associated with this Backend Address Pool.
LoadbalancerId Changes to this property will trigger replacement. string
The ID of the Load Balancer in which to create the Backend Address Pool. Changing this forces a new resource to be created.
Name Changes to this property will trigger replacement. string
Specifies the name of the Backend Address Pool. Changing this forces a new resource to be created.
OutboundRules []string
An array of the Load Balancing Outbound Rules associated with this Backend Address Pool.
SynchronousMode Changes to this property will trigger replacement. string

The backend address synchronous mode for the Backend Address Pool. Possible values are Automatic and Manual. This is required with virtual_network_id. Changing this forces a new resource to be created.

NOTE: The synchronous_mode can set only for Load Balancer with Standard SKU.

TunnelInterfaces []BackendAddressPoolTunnelInterfaceArgs
One or more tunnel_interface blocks as defined below.
VirtualNetworkId string
The ID of the Virtual Network within which the Backend Address Pool should exist.
backendIpConfigurations List<String>
The Backend IP Configurations associated with this Backend Address Pool.
inboundNatRules List<String>
An array of the Load Balancing Inbound NAT Rules associated with this Backend Address Pool.
loadBalancingRules List<String>
The Load Balancing Rules associated with this Backend Address Pool.
loadbalancerId Changes to this property will trigger replacement. String
The ID of the Load Balancer in which to create the Backend Address Pool. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. String
Specifies the name of the Backend Address Pool. Changing this forces a new resource to be created.
outboundRules List<String>
An array of the Load Balancing Outbound Rules associated with this Backend Address Pool.
synchronousMode Changes to this property will trigger replacement. String

The backend address synchronous mode for the Backend Address Pool. Possible values are Automatic and Manual. This is required with virtual_network_id. Changing this forces a new resource to be created.

NOTE: The synchronous_mode can set only for Load Balancer with Standard SKU.

tunnelInterfaces List<BackendAddressPoolTunnelInterface>
One or more tunnel_interface blocks as defined below.
virtualNetworkId String
The ID of the Virtual Network within which the Backend Address Pool should exist.
backendIpConfigurations string[]
The Backend IP Configurations associated with this Backend Address Pool.
inboundNatRules string[]
An array of the Load Balancing Inbound NAT Rules associated with this Backend Address Pool.
loadBalancingRules string[]
The Load Balancing Rules associated with this Backend Address Pool.
loadbalancerId Changes to this property will trigger replacement. string
The ID of the Load Balancer in which to create the Backend Address Pool. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. string
Specifies the name of the Backend Address Pool. Changing this forces a new resource to be created.
outboundRules string[]
An array of the Load Balancing Outbound Rules associated with this Backend Address Pool.
synchronousMode Changes to this property will trigger replacement. string

The backend address synchronous mode for the Backend Address Pool. Possible values are Automatic and Manual. This is required with virtual_network_id. Changing this forces a new resource to be created.

NOTE: The synchronous_mode can set only for Load Balancer with Standard SKU.

tunnelInterfaces BackendAddressPoolTunnelInterface[]
One or more tunnel_interface blocks as defined below.
virtualNetworkId string
The ID of the Virtual Network within which the Backend Address Pool should exist.
backend_ip_configurations Sequence[str]
The Backend IP Configurations associated with this Backend Address Pool.
inbound_nat_rules Sequence[str]
An array of the Load Balancing Inbound NAT Rules associated with this Backend Address Pool.
load_balancing_rules Sequence[str]
The Load Balancing Rules associated with this Backend Address Pool.
loadbalancer_id Changes to this property will trigger replacement. str
The ID of the Load Balancer in which to create the Backend Address Pool. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. str
Specifies the name of the Backend Address Pool. Changing this forces a new resource to be created.
outbound_rules Sequence[str]
An array of the Load Balancing Outbound Rules associated with this Backend Address Pool.
synchronous_mode Changes to this property will trigger replacement. str

The backend address synchronous mode for the Backend Address Pool. Possible values are Automatic and Manual. This is required with virtual_network_id. Changing this forces a new resource to be created.

NOTE: The synchronous_mode can set only for Load Balancer with Standard SKU.

tunnel_interfaces Sequence[BackendAddressPoolTunnelInterfaceArgs]
One or more tunnel_interface blocks as defined below.
virtual_network_id str
The ID of the Virtual Network within which the Backend Address Pool should exist.
backendIpConfigurations List<String>
The Backend IP Configurations associated with this Backend Address Pool.
inboundNatRules List<String>
An array of the Load Balancing Inbound NAT Rules associated with this Backend Address Pool.
loadBalancingRules List<String>
The Load Balancing Rules associated with this Backend Address Pool.
loadbalancerId Changes to this property will trigger replacement. String
The ID of the Load Balancer in which to create the Backend Address Pool. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. String
Specifies the name of the Backend Address Pool. Changing this forces a new resource to be created.
outboundRules List<String>
An array of the Load Balancing Outbound Rules associated with this Backend Address Pool.
synchronousMode Changes to this property will trigger replacement. String

The backend address synchronous mode for the Backend Address Pool. Possible values are Automatic and Manual. This is required with virtual_network_id. Changing this forces a new resource to be created.

NOTE: The synchronous_mode can set only for Load Balancer with Standard SKU.

tunnelInterfaces List<Property Map>
One or more tunnel_interface blocks as defined below.
virtualNetworkId String
The ID of the Virtual Network within which the Backend Address Pool should exist.

Supporting Types

BackendAddressPoolTunnelInterface
, BackendAddressPoolTunnelInterfaceArgs

Identifier This property is required. int
The unique identifier of this Gateway Load Balancer Tunnel Interface.
Port This property is required. int
The port number that this Gateway Load Balancer Tunnel Interface listens to.
Protocol This property is required. string
The protocol used for this Gateway Load Balancer Tunnel Interface. Possible values are None, Native and VXLAN.
Type This property is required. string
The traffic type of this Gateway Load Balancer Tunnel Interface. Possible values are None, Internal and External.
Identifier This property is required. int
The unique identifier of this Gateway Load Balancer Tunnel Interface.
Port This property is required. int
The port number that this Gateway Load Balancer Tunnel Interface listens to.
Protocol This property is required. string
The protocol used for this Gateway Load Balancer Tunnel Interface. Possible values are None, Native and VXLAN.
Type This property is required. string
The traffic type of this Gateway Load Balancer Tunnel Interface. Possible values are None, Internal and External.
identifier This property is required. Integer
The unique identifier of this Gateway Load Balancer Tunnel Interface.
port This property is required. Integer
The port number that this Gateway Load Balancer Tunnel Interface listens to.
protocol This property is required. String
The protocol used for this Gateway Load Balancer Tunnel Interface. Possible values are None, Native and VXLAN.
type This property is required. String
The traffic type of this Gateway Load Balancer Tunnel Interface. Possible values are None, Internal and External.
identifier This property is required. number
The unique identifier of this Gateway Load Balancer Tunnel Interface.
port This property is required. number
The port number that this Gateway Load Balancer Tunnel Interface listens to.
protocol This property is required. string
The protocol used for this Gateway Load Balancer Tunnel Interface. Possible values are None, Native and VXLAN.
type This property is required. string
The traffic type of this Gateway Load Balancer Tunnel Interface. Possible values are None, Internal and External.
identifier This property is required. int
The unique identifier of this Gateway Load Balancer Tunnel Interface.
port This property is required. int
The port number that this Gateway Load Balancer Tunnel Interface listens to.
protocol This property is required. str
The protocol used for this Gateway Load Balancer Tunnel Interface. Possible values are None, Native and VXLAN.
type This property is required. str
The traffic type of this Gateway Load Balancer Tunnel Interface. Possible values are None, Internal and External.
identifier This property is required. Number
The unique identifier of this Gateway Load Balancer Tunnel Interface.
port This property is required. Number
The port number that this Gateway Load Balancer Tunnel Interface listens to.
protocol This property is required. String
The protocol used for this Gateway Load Balancer Tunnel Interface. Possible values are None, Native and VXLAN.
type This property is required. String
The traffic type of this Gateway Load Balancer Tunnel Interface. Possible values are None, Internal and External.

Import

Load Balancer Backend Address Pools can be imported using the resource id, e.g.

$ pulumi import azure:lb/backendAddressPool:BackendAddressPool example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.Network/loadBalancers/lb1/backendAddressPools/pool1
Copy

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.

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure