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

We recommend using Azure Native.

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

We recommend using Azure Native.

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

    Manages a Backend Address within a Backend Address Pool.

    Note: Backend Addresses can only be added to a Standard SKU Load Balancer.

    Example Usage

    using Pulumi;
    using Azure = Pulumi.Azure;
    
    class MyStack : Stack
    {
        public MyStack()
        {
            var exampleVirtualNetwork = Output.Create(Azure.Network.GetVirtualNetwork.InvokeAsync(new Azure.Network.GetVirtualNetworkArgs
            {
                Name = "example-network",
                ResourceGroupName = "example-resources",
            }));
            var exampleLB = Output.Create(Azure.Lb.GetLB.InvokeAsync(new Azure.Lb.GetLBArgs
            {
                Name = "example-lb",
                ResourceGroupName = "example-resources",
            }));
            var exampleBackendAddressPool = exampleLB.Apply(exampleLB => Output.Create(Azure.Lb.GetBackendAddressPool.InvokeAsync(new Azure.Lb.GetBackendAddressPoolArgs
            {
                Name = "first",
                LoadbalancerId = exampleLB.Id,
            })));
            var exampleBackendAddressPoolAddress = new Azure.Lb.BackendAddressPoolAddress("exampleBackendAddressPoolAddress", new Azure.Lb.BackendAddressPoolAddressArgs
            {
                BackendAddressPoolId = exampleBackendAddressPool.Apply(exampleBackendAddressPool => exampleBackendAddressPool.Id),
                VirtualNetworkId = exampleVirtualNetwork.Apply(exampleVirtualNetwork => exampleVirtualNetwork.Id),
                IpAddress = "10.0.0.1",
            });
        }
    
    }
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/lb"
    	"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/network"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		exampleVirtualNetwork, err := network.LookupVirtualNetwork(ctx, &network.LookupVirtualNetworkArgs{
    			Name:              "example-network",
    			ResourceGroupName: "example-resources",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		exampleLB, err := lb.GetLB(ctx, &lb.GetLBArgs{
    			Name:              "example-lb",
    			ResourceGroupName: "example-resources",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		exampleBackendAddressPool, err := lb.LookupBackendAddressPool(ctx, &lb.LookupBackendAddressPoolArgs{
    			Name:           "first",
    			LoadbalancerId: exampleLB.Id,
    		}, nil)
    		if err != nil {
    			return err
    		}
    		_, err = lb.NewBackendAddressPoolAddress(ctx, "exampleBackendAddressPoolAddress", &lb.BackendAddressPoolAddressArgs{
    			BackendAddressPoolId: pulumi.String(exampleBackendAddressPool.Id),
    			VirtualNetworkId:     pulumi.String(exampleVirtualNetwork.Id),
    			IpAddress:            pulumi.String("10.0.0.1"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    

    Example coming soon!

    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    
    const exampleVirtualNetwork = azure.network.getVirtualNetwork({
        name: "example-network",
        resourceGroupName: "example-resources",
    });
    const exampleLB = azure.lb.getLB({
        name: "example-lb",
        resourceGroupName: "example-resources",
    });
    const exampleBackendAddressPool = exampleLB.then(exampleLB => azure.lb.getBackendAddressPool({
        name: "first",
        loadbalancerId: exampleLB.id,
    }));
    const exampleBackendAddressPoolAddress = new azure.lb.BackendAddressPoolAddress("exampleBackendAddressPoolAddress", {
        backendAddressPoolId: exampleBackendAddressPool.then(exampleBackendAddressPool => exampleBackendAddressPool.id),
        virtualNetworkId: exampleVirtualNetwork.then(exampleVirtualNetwork => exampleVirtualNetwork.id),
        ipAddress: "10.0.0.1",
    });
    
    import pulumi
    import pulumi_azure as azure
    
    example_virtual_network = azure.network.get_virtual_network(name="example-network",
        resource_group_name="example-resources")
    example_lb = azure.lb.get_lb(name="example-lb",
        resource_group_name="example-resources")
    example_backend_address_pool = azure.lb.get_backend_address_pool(name="first",
        loadbalancer_id=example_lb.id)
    example_backend_address_pool_address = azure.lb.BackendAddressPoolAddress("exampleBackendAddressPoolAddress",
        backend_address_pool_id=example_backend_address_pool.id,
        virtual_network_id=example_virtual_network.id,
        ip_address="10.0.0.1")
    

    Example coming soon!

    Create BackendAddressPoolAddress Resource

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

    Constructor syntax

    new BackendAddressPoolAddress(name: string, args: BackendAddressPoolAddressArgs, opts?: CustomResourceOptions);
    @overload
    def BackendAddressPoolAddress(resource_name: str,
                                  args: BackendAddressPoolAddressArgs,
                                  opts: Optional[ResourceOptions] = None)
    
    @overload
    def BackendAddressPoolAddress(resource_name: str,
                                  opts: Optional[ResourceOptions] = None,
                                  backend_address_pool_id: Optional[str] = None,
                                  ip_address: Optional[str] = None,
                                  virtual_network_id: Optional[str] = None,
                                  name: Optional[str] = None)
    func NewBackendAddressPoolAddress(ctx *Context, name string, args BackendAddressPoolAddressArgs, opts ...ResourceOption) (*BackendAddressPoolAddress, error)
    public BackendAddressPoolAddress(string name, BackendAddressPoolAddressArgs args, CustomResourceOptions? opts = null)
    public BackendAddressPoolAddress(String name, BackendAddressPoolAddressArgs args)
    public BackendAddressPoolAddress(String name, BackendAddressPoolAddressArgs args, CustomResourceOptions options)
    
    type: azure:lb:BackendAddressPoolAddress
    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 BackendAddressPoolAddressArgs
    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 BackendAddressPoolAddressArgs
    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 BackendAddressPoolAddressArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BackendAddressPoolAddressArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BackendAddressPoolAddressArgs
    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 backendAddressPoolAddressResource = new Azure.Lb.BackendAddressPoolAddress("backendAddressPoolAddressResource", new()
    {
        BackendAddressPoolId = "string",
        IpAddress = "string",
        VirtualNetworkId = "string",
        Name = "string",
    });
    
    example, err := lb.NewBackendAddressPoolAddress(ctx, "backendAddressPoolAddressResource", &lb.BackendAddressPoolAddressArgs{
    	BackendAddressPoolId: pulumi.String("string"),
    	IpAddress:            pulumi.String("string"),
    	VirtualNetworkId:     pulumi.String("string"),
    	Name:                 pulumi.String("string"),
    })
    
    var backendAddressPoolAddressResource = new BackendAddressPoolAddress("backendAddressPoolAddressResource", BackendAddressPoolAddressArgs.builder()
        .backendAddressPoolId("string")
        .ipAddress("string")
        .virtualNetworkId("string")
        .name("string")
        .build());
    
    backend_address_pool_address_resource = azure.lb.BackendAddressPoolAddress("backendAddressPoolAddressResource",
        backend_address_pool_id="string",
        ip_address="string",
        virtual_network_id="string",
        name="string")
    
    const backendAddressPoolAddressResource = new azure.lb.BackendAddressPoolAddress("backendAddressPoolAddressResource", {
        backendAddressPoolId: "string",
        ipAddress: "string",
        virtualNetworkId: "string",
        name: "string",
    });
    
    type: azure:lb:BackendAddressPoolAddress
    properties:
        backendAddressPoolId: string
        ipAddress: string
        name: string
        virtualNetworkId: string
    

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

    BackendAddressPoolId string
    The ID of the Backend Address Pool. Changing this forces a new Backend Address Pool Address to be created.
    IpAddress string
    The Static IP Address which should be allocated to this Backend Address Pool.
    VirtualNetworkId string
    The ID of the Virtual Network within which the Backend Address Pool should exist.
    Name string
    The name which should be used for this Backend Address Pool Address. Changing this forces a new Backend Address Pool Address to be created.
    BackendAddressPoolId string
    The ID of the Backend Address Pool. Changing this forces a new Backend Address Pool Address to be created.
    IpAddress string
    The Static IP Address which should be allocated to this Backend Address Pool.
    VirtualNetworkId string
    The ID of the Virtual Network within which the Backend Address Pool should exist.
    Name string
    The name which should be used for this Backend Address Pool Address. Changing this forces a new Backend Address Pool Address to be created.
    backendAddressPoolId String
    The ID of the Backend Address Pool. Changing this forces a new Backend Address Pool Address to be created.
    ipAddress String
    The Static IP Address which should be allocated to this Backend Address Pool.
    virtualNetworkId String
    The ID of the Virtual Network within which the Backend Address Pool should exist.
    name String
    The name which should be used for this Backend Address Pool Address. Changing this forces a new Backend Address Pool Address to be created.
    backendAddressPoolId string
    The ID of the Backend Address Pool. Changing this forces a new Backend Address Pool Address to be created.
    ipAddress string
    The Static IP Address which should be allocated to this Backend Address Pool.
    virtualNetworkId string
    The ID of the Virtual Network within which the Backend Address Pool should exist.
    name string
    The name which should be used for this Backend Address Pool Address. Changing this forces a new Backend Address Pool Address to be created.
    backend_address_pool_id str
    The ID of the Backend Address Pool. Changing this forces a new Backend Address Pool Address to be created.
    ip_address str
    The Static IP Address which should be allocated to this Backend Address Pool.
    virtual_network_id str
    The ID of the Virtual Network within which the Backend Address Pool should exist.
    name str
    The name which should be used for this Backend Address Pool Address. Changing this forces a new Backend Address Pool Address to be created.
    backendAddressPoolId String
    The ID of the Backend Address Pool. Changing this forces a new Backend Address Pool Address to be created.
    ipAddress String
    The Static IP Address which should be allocated to this Backend Address Pool.
    virtualNetworkId String
    The ID of the Virtual Network within which the Backend Address Pool should exist.
    name String
    The name which should be used for this Backend Address Pool Address. Changing this forces a new Backend Address Pool Address to be created.

    Outputs

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

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

    Look up Existing BackendAddressPoolAddress Resource

    Get an existing BackendAddressPoolAddress 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?: BackendAddressPoolAddressState, opts?: CustomResourceOptions): BackendAddressPoolAddress
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            backend_address_pool_id: Optional[str] = None,
            ip_address: Optional[str] = None,
            name: Optional[str] = None,
            virtual_network_id: Optional[str] = None) -> BackendAddressPoolAddress
    func GetBackendAddressPoolAddress(ctx *Context, name string, id IDInput, state *BackendAddressPoolAddressState, opts ...ResourceOption) (*BackendAddressPoolAddress, error)
    public static BackendAddressPoolAddress Get(string name, Input<string> id, BackendAddressPoolAddressState? state, CustomResourceOptions? opts = null)
    public static BackendAddressPoolAddress get(String name, Output<String> id, BackendAddressPoolAddressState state, CustomResourceOptions options)
    resources:  _:    type: azure:lb:BackendAddressPoolAddress    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    BackendAddressPoolId string
    The ID of the Backend Address Pool. Changing this forces a new Backend Address Pool Address to be created.
    IpAddress string
    The Static IP Address which should be allocated to this Backend Address Pool.
    Name string
    The name which should be used for this Backend Address Pool Address. Changing this forces a new Backend Address Pool Address to be created.
    VirtualNetworkId string
    The ID of the Virtual Network within which the Backend Address Pool should exist.
    BackendAddressPoolId string
    The ID of the Backend Address Pool. Changing this forces a new Backend Address Pool Address to be created.
    IpAddress string
    The Static IP Address which should be allocated to this Backend Address Pool.
    Name string
    The name which should be used for this Backend Address Pool Address. Changing this forces a new Backend Address Pool Address to be created.
    VirtualNetworkId string
    The ID of the Virtual Network within which the Backend Address Pool should exist.
    backendAddressPoolId String
    The ID of the Backend Address Pool. Changing this forces a new Backend Address Pool Address to be created.
    ipAddress String
    The Static IP Address which should be allocated to this Backend Address Pool.
    name String
    The name which should be used for this Backend Address Pool Address. Changing this forces a new Backend Address Pool Address to be created.
    virtualNetworkId String
    The ID of the Virtual Network within which the Backend Address Pool should exist.
    backendAddressPoolId string
    The ID of the Backend Address Pool. Changing this forces a new Backend Address Pool Address to be created.
    ipAddress string
    The Static IP Address which should be allocated to this Backend Address Pool.
    name string
    The name which should be used for this Backend Address Pool Address. Changing this forces a new Backend Address Pool Address to be created.
    virtualNetworkId string
    The ID of the Virtual Network within which the Backend Address Pool should exist.
    backend_address_pool_id str
    The ID of the Backend Address Pool. Changing this forces a new Backend Address Pool Address to be created.
    ip_address str
    The Static IP Address which should be allocated to this Backend Address Pool.
    name str
    The name which should be used for this Backend Address Pool Address. Changing this forces a new Backend Address Pool Address to be created.
    virtual_network_id str
    The ID of the Virtual Network within which the Backend Address Pool should exist.
    backendAddressPoolId String
    The ID of the Backend Address Pool. Changing this forces a new Backend Address Pool Address to be created.
    ipAddress String
    The Static IP Address which should be allocated to this Backend Address Pool.
    name String
    The name which should be used for this Backend Address Pool Address. Changing this forces a new Backend Address Pool Address to be created.
    virtualNetworkId String
    The ID of the Virtual Network within which the Backend Address Pool should exist.

    Import

    Backend Address Pool Addresses can be imported using the resource id, e.g.

     $ pulumi import azure:lb/backendAddressPoolAddress:BackendAddressPoolAddress example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.Network/loadBalancers/loadBalancer1/backendAddressPools/backendAddressPool1/addresses/address1
    

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

    Package Details

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

    We recommend using Azure Native.

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