Azure Classic

Pulumi Official
Package maintained by Pulumi
v5.14.0 published on Thursday, Jul 28, 2022 by Pulumi

BackendAddressPoolAddress

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/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 {
		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
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.network.NetworkFunctions;
import com.pulumi.azure.devtest.inputs.GetVirtualNetworkArgs;
import com.pulumi.azure.lb.LbFunctions;
import com.pulumi.azure.lb.inputs.GetLBArgs;
import com.pulumi.azure.lb.inputs.GetBackendAddressPoolArgs;
import com.pulumi.azure.lb.BackendAddressPoolAddress;
import com.pulumi.azure.lb.BackendAddressPoolAddressArgs;
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) {
        final var exampleVirtualNetwork = NetworkFunctions.getVirtualNetwork(GetVirtualNetworkArgs.builder()
            .name("example-network")
            .resourceGroupName("example-resources")
            .build());

        final var exampleLB = LbFunctions.getLB(GetLBArgs.builder()
            .name("example-lb")
            .resourceGroupName("example-resources")
            .build());

        final var exampleBackendAddressPool = LbFunctions.getBackendAddressPool(GetBackendAddressPoolArgs.builder()
            .name("first")
            .loadbalancerId(exampleLB.applyValue(getLBResult -> getLBResult.id()))
            .build());

        var exampleBackendAddressPoolAddress = new BackendAddressPoolAddress("exampleBackendAddressPoolAddress", BackendAddressPoolAddressArgs.builder()        
            .backendAddressPoolId(exampleBackendAddressPool.applyValue(getBackendAddressPoolResult -> getBackendAddressPoolResult.id()))
            .virtualNetworkId(exampleVirtualNetwork.applyValue(getVirtualNetworkResult -> getVirtualNetworkResult.id()))
            .ipAddress("10.0.0.1")
            .build());

    }
}
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")
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",
});
resources:
  exampleBackendAddressPoolAddress:
    type: azure:lb:BackendAddressPoolAddress
    properties:
      backendAddressPoolId: ${exampleBackendAddressPool.id}
      virtualNetworkId: ${exampleVirtualNetwork.id}
      ipAddress: 10.0.0.1
variables:
  exampleVirtualNetwork:
    Fn::Invoke:
      Function: azure:network:getVirtualNetwork
      Arguments:
        name: example-network
        resourceGroupName: example-resources
  exampleLB:
    Fn::Invoke:
      Function: azure:lb:getLB
      Arguments:
        name: example-lb
        resourceGroupName: example-resources
  exampleBackendAddressPool:
    Fn::Invoke:
      Function: azure:lb:getBackendAddressPool
      Arguments:
        name: first
        loadbalancerId: ${exampleLB.id}

Create a BackendAddressPoolAddress Resource

new BackendAddressPoolAddress(name: string, args: BackendAddressPoolAddressArgs, opts?: CustomResourceOptions);
@overload
def BackendAddressPoolAddress(resource_name: 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)
@overload
def BackendAddressPoolAddress(resource_name: str,
                              args: BackendAddressPoolAddressArgs,
                              opts: Optional[ResourceOptions] = 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.

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.

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

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.

InboundNatRulePortMappings List<Pulumi.Azure.Lb.Outputs.BackendAddressPoolAddressInboundNatRulePortMapping>

A list of inbound_nat_rule_port_mapping block as defined below.

Id string

The provider-assigned unique ID for this managed resource.

InboundNatRulePortMappings []BackendAddressPoolAddressInboundNatRulePortMapping

A list of inbound_nat_rule_port_mapping block as defined below.

id String

The provider-assigned unique ID for this managed resource.

inboundNatRulePortMappings List<BackendAddressPoolAddressInboundNatRulePortMapping>

A list of inbound_nat_rule_port_mapping block as defined below.

id string

The provider-assigned unique ID for this managed resource.

inboundNatRulePortMappings BackendAddressPoolAddressInboundNatRulePortMapping[]

A list of inbound_nat_rule_port_mapping block as defined below.

id str

The provider-assigned unique ID for this managed resource.

inbound_nat_rule_port_mappings Sequence[BackendAddressPoolAddressInboundNatRulePortMapping]

A list of inbound_nat_rule_port_mapping block as defined below.

id String

The provider-assigned unique ID for this managed resource.

inboundNatRulePortMappings List<Property Map>

A list of inbound_nat_rule_port_mapping block as defined below.

Look up an 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,
        inbound_nat_rule_port_mappings: Optional[Sequence[BackendAddressPoolAddressInboundNatRulePortMappingArgs]] = 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)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
BackendAddressPoolId string

The ID of the Backend Address Pool. Changing this forces a new Backend Address Pool Address to be created.

InboundNatRulePortMappings List<Pulumi.Azure.Lb.Inputs.BackendAddressPoolAddressInboundNatRulePortMappingArgs>

A list of inbound_nat_rule_port_mapping block as defined below.

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.

InboundNatRulePortMappings []BackendAddressPoolAddressInboundNatRulePortMappingArgs

A list of inbound_nat_rule_port_mapping block as defined below.

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.

inboundNatRulePortMappings List<BackendAddressPoolAddressInboundNatRulePortMappingArgs>

A list of inbound_nat_rule_port_mapping block as defined below.

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.

inboundNatRulePortMappings BackendAddressPoolAddressInboundNatRulePortMappingArgs[]

A list of inbound_nat_rule_port_mapping block as defined below.

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.

inbound_nat_rule_port_mappings Sequence[BackendAddressPoolAddressInboundNatRulePortMappingArgs]

A list of inbound_nat_rule_port_mapping block as defined below.

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.

inboundNatRulePortMappings List<Property Map>

A list of inbound_nat_rule_port_mapping block as defined below.

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.

Supporting Types

BackendAddressPoolAddressInboundNatRulePortMapping

BackendPort int

The Backend Port of the Load Balancing Inbound NAT Rules associated with this Backend Address Pool Address.

FrontendPort int

The Frontend Port of the Load Balancing Inbound NAT Rules associated with this Backend Address Pool Address.

InboundNatRuleName string

The name of the Load Balancing Inbound NAT Rules associated with this Backend Address Pool Address.

BackendPort int

The Backend Port of the Load Balancing Inbound NAT Rules associated with this Backend Address Pool Address.

FrontendPort int

The Frontend Port of the Load Balancing Inbound NAT Rules associated with this Backend Address Pool Address.

InboundNatRuleName string

The name of the Load Balancing Inbound NAT Rules associated with this Backend Address Pool Address.

backendPort Integer

The Backend Port of the Load Balancing Inbound NAT Rules associated with this Backend Address Pool Address.

frontendPort Integer

The Frontend Port of the Load Balancing Inbound NAT Rules associated with this Backend Address Pool Address.

inboundNatRuleName String

The name of the Load Balancing Inbound NAT Rules associated with this Backend Address Pool Address.

backendPort number

The Backend Port of the Load Balancing Inbound NAT Rules associated with this Backend Address Pool Address.

frontendPort number

The Frontend Port of the Load Balancing Inbound NAT Rules associated with this Backend Address Pool Address.

inboundNatRuleName string

The name of the Load Balancing Inbound NAT Rules associated with this Backend Address Pool Address.

backend_port int

The Backend Port of the Load Balancing Inbound NAT Rules associated with this Backend Address Pool Address.

frontend_port int

The Frontend Port of the Load Balancing Inbound NAT Rules associated with this Backend Address Pool Address.

inbound_nat_rule_name str

The name of the Load Balancing Inbound NAT Rules associated with this Backend Address Pool Address.

backendPort Number

The Backend Port of the Load Balancing Inbound NAT Rules associated with this Backend Address Pool Address.

frontendPort Number

The Frontend Port of the Load Balancing Inbound NAT Rules associated with this Backend Address Pool Address.

inboundNatRuleName String

The name of the Load Balancing Inbound NAT Rules associated with this Backend Address Pool Address.

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

Package Details

Repository
https://github.com/pulumi/pulumi-azure
License
Apache-2.0
Notes

This Pulumi package is based on the azurerm Terraform Provider.