NatPool

Manages a Load Balancer NAT pool.

NOTE: This resource cannot be used with with virtual machines, instead use the azure.lb.NatRule resource.
NOTE When using this resource, the Load Balancer needs to have a FrontEnd IP Configuration Attached

Create a NatPool Resource

new NatPool(name: string, args: NatPoolArgs, opts?: CustomResourceOptions);

def NatPool(resource_name, opts=None, backend_port=None, frontend_ip_configuration_name=None, frontend_port_end=None, frontend_port_start=None, loadbalancer_id=None, name=None, protocol=None, resource_group_name=None, __props__=None);

func NewNatPool(ctx *Context, name string, args NatPoolArgs, opts ...ResourceOption) (*NatPool, error)

public NatPool(string name, NatPoolArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args NatPoolArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args NatPoolArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args NatPoolArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

NatPool Resource Properties

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

Inputs

The NatPool resource accepts the following input properties:

BackendPort int: The port used for the internal endpoint. Possible values range between 1 and 65535, inclusive.
FrontendIpConfigurationName string: The name of the frontend IP configuration exposing this rule.
FrontendPortEnd int: The last port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with this Load Balancer. Possible values range between 1 and 65534, inclusive.
FrontendPortStart int: The first port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with this Load Balancer. Possible values range between 1 and 65534, inclusive.
LoadbalancerId string: The ID of the Load Balancer in which to create the NAT pool.
Protocol string: The transport protocol for the external endpoint. Possible values are Udp or Tcp.
ResourceGroupName string: The name of the resource group in which to create the resource.
Name string: Specifies the name of the NAT pool.

BackendPort int: The port used for the internal endpoint. Possible values range between 1 and 65535, inclusive.
FrontendIpConfigurationName string: The name of the frontend IP configuration exposing this rule.
FrontendPortEnd int: The last port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with this Load Balancer. Possible values range between 1 and 65534, inclusive.
FrontendPortStart int: The first port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with this Load Balancer. Possible values range between 1 and 65534, inclusive.
LoadbalancerId string: The ID of the Load Balancer in which to create the NAT pool.
Protocol string: The transport protocol for the external endpoint. Possible values are Udp or Tcp.
ResourceGroupName string: The name of the resource group in which to create the resource.
Name string: Specifies the name of the NAT pool.

backendPort number: The port used for the internal endpoint. Possible values range between 1 and 65535, inclusive.
frontendIpConfigurationName string: The name of the frontend IP configuration exposing this rule.
frontendPortEnd number: The last port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with this Load Balancer. Possible values range between 1 and 65534, inclusive.
frontendPortStart number: The first port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with this Load Balancer. Possible values range between 1 and 65534, inclusive.
loadbalancerId string: The ID of the Load Balancer in which to create the NAT pool.
protocol string: The transport protocol for the external endpoint. Possible values are Udp or Tcp.
resourceGroupName string: The name of the resource group in which to create the resource.
name string: Specifies the name of the NAT pool.

backend_port float: The port used for the internal endpoint. Possible values range between 1 and 65535, inclusive.
frontend_ip_configuration_name str: The name of the frontend IP configuration exposing this rule.
frontend_port_end float: The last port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with this Load Balancer. Possible values range between 1 and 65534, inclusive.
frontend_port_start float: The first port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with this Load Balancer. Possible values range between 1 and 65534, inclusive.
loadbalancer_id str: The ID of the Load Balancer in which to create the NAT pool.
protocol str: The transport protocol for the external endpoint. Possible values are Udp or Tcp.
resource_group_name str: The name of the resource group in which to create the resource.
name str: Specifies the name of the NAT pool.

Outputs

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

FrontendIpConfigurationId string
Id string: The provider-assigned unique ID for this managed resource.

FrontendIpConfigurationId string
Id string: The provider-assigned unique ID for this managed resource.

frontendIpConfigurationId string
id string: The provider-assigned unique ID for this managed resource.

frontend_ip_configuration_id str
id str: The provider-assigned unique ID for this managed resource.

Look up an Existing NatPool Resource

Get an existing NatPool 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?: NatPoolState, opts?: CustomResourceOptions): NatPool

static get(resource_name, id, opts=None, backend_port=None, frontend_ip_configuration_id=None, frontend_ip_configuration_name=None, frontend_port_end=None, frontend_port_start=None, loadbalancer_id=None, name=None, protocol=None, resource_group_name=None, __props__=None);

func GetNatPool(ctx *Context, name string, id IDInput, state *NatPoolState, opts ...ResourceOption) (*NatPool, error)

public static NatPool Get(string name, Input<string> id, NatPoolState? state, CustomResourceOptions? opts = null)

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.

The following state arguments are supported:

BackendPort int: The port used for the internal endpoint. Possible values range between 1 and 65535, inclusive.
FrontendIpConfigurationId string
FrontendIpConfigurationName string: The name of the frontend IP configuration exposing this rule.
FrontendPortEnd int: The last port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with this Load Balancer. Possible values range between 1 and 65534, inclusive.
FrontendPortStart int: The first port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with this Load Balancer. Possible values range between 1 and 65534, inclusive.
LoadbalancerId string: The ID of the Load Balancer in which to create the NAT pool.
Name string: Specifies the name of the NAT pool.
Protocol string: The transport protocol for the external endpoint. Possible values are Udp or Tcp.
ResourceGroupName string: The name of the resource group in which to create the resource.

BackendPort int: The port used for the internal endpoint. Possible values range between 1 and 65535, inclusive.
FrontendIpConfigurationId string
FrontendIpConfigurationName string: The name of the frontend IP configuration exposing this rule.
FrontendPortEnd int: The last port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with this Load Balancer. Possible values range between 1 and 65534, inclusive.
FrontendPortStart int: The first port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with this Load Balancer. Possible values range between 1 and 65534, inclusive.
LoadbalancerId string: The ID of the Load Balancer in which to create the NAT pool.
Name string: Specifies the name of the NAT pool.
Protocol string: The transport protocol for the external endpoint. Possible values are Udp or Tcp.
ResourceGroupName string: The name of the resource group in which to create the resource.

backendPort number: The port used for the internal endpoint. Possible values range between 1 and 65535, inclusive.
frontendIpConfigurationId string
frontendIpConfigurationName string: The name of the frontend IP configuration exposing this rule.
frontendPortEnd number: The last port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with this Load Balancer. Possible values range between 1 and 65534, inclusive.
frontendPortStart number: The first port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with this Load Balancer. Possible values range between 1 and 65534, inclusive.
loadbalancerId string: The ID of the Load Balancer in which to create the NAT pool.
name string: Specifies the name of the NAT pool.
protocol string: The transport protocol for the external endpoint. Possible values are Udp or Tcp.
resourceGroupName string: The name of the resource group in which to create the resource.

backend_port float: The port used for the internal endpoint. Possible values range between 1 and 65535, inclusive.
frontend_ip_configuration_id str
frontend_ip_configuration_name str: The name of the frontend IP configuration exposing this rule.
frontend_port_end float: The last port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with this Load Balancer. Possible values range between 1 and 65534, inclusive.
frontend_port_start float: The first port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with this Load Balancer. Possible values range between 1 and 65534, inclusive.
loadbalancer_id str: The ID of the Load Balancer in which to create the NAT pool.
name str: Specifies the name of the NAT pool.
protocol str: The transport protocol for the external endpoint. Possible values are Udp or Tcp.
resource_group_name str: The name of the resource group in which to create the resource.

Package Details

Repository: https://github.com/pulumi/pulumi-azure
License: Apache-2.0
Notes: This Pulumi package is based on the azurerm Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud