Class 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

Inheritance

System.Object

Resource

CustomResource

NatPool

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Azure.Lb

Assembly: Pulumi.Azure.dll

Syntax

public class NatPool : CustomResource

Constructors

NatPool(String, NatPoolArgs, CustomResourceOptions)

Create a NatPool resource with the given unique name, arguments, and options.

Declaration

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

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
NatPoolArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

BackendPort

The port used for the internal endpoint. Possible values range between 1 and 65535, inclusive.

Declaration

public Output<int> BackendPort { get; }

Property Value

Type	Description
Output<System.Int32>

FrontendIpConfigurationId

Declaration

public Output<string> FrontendIpConfigurationId { get; }

Property Value

Type	Description
Output<System.String>

FrontendIpConfigurationName

The name of the frontend IP configuration exposing this rule.

Declaration

public Output<string> FrontendIpConfigurationName { get; }

Property Value

Type	Description
Output<System.String>

FrontendPortEnd

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.

Declaration

public Output<int> FrontendPortEnd { get; }

Property Value

Type	Description
Output<System.Int32>

FrontendPortStart

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.

Declaration

public Output<int> FrontendPortStart { get; }

Property Value

Type	Description
Output<System.Int32>

LoadbalancerId

The ID of the Load Balancer in which to create the NAT pool.

Declaration

public Output<string> LoadbalancerId { get; }

Property Value

Type	Description
Output<System.String>

Name

Specifies the name of the NAT pool.

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

Protocol

The transport protocol for the external endpoint. Possible values are Udp or Tcp.

Declaration

public Output<string> Protocol { get; }

Property Value

Type	Description
Output<System.String>

ResourceGroupName

The name of the resource group in which to create the resource.

Declaration

public Output<string> ResourceGroupName { get; }

Property Value

Type	Description
Output<System.String>

Methods

Get(String, Input<String>, NatPoolState, CustomResourceOptions)

Get an existing NatPool resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration

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

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
NatPoolState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
NatPool