Share via

InboundNatPool Class

  • Reference

Inbound NAT pool of the load balancer.

Variables are only populated by the server, and will be ignored when sending a request.

Constructor

InboundNatPool(*, id: str | None = None, name: str | None = None, frontend_ip_configuration: _models.SubResource | None = None, protocol: str | _models.TransportProtocol | None = None, frontend_port_range_start: int | None = None, frontend_port_range_end: int | None = None, backend_port: int | None = None, idle_timeout_in_minutes: int | None = None, enable_floating_ip: bool | None = None, enable_tcp_reset: bool | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
id
str

Resource ID.

Default value: None
name
str

The name of the resource that is unique within the set of inbound NAT pools used by the load balancer. This name can be used to access the resource.

Default value: None
frontend_ip_configuration
SubResource

A reference to frontend IP addresses.

Default value: None
protocol
str or TransportProtocol

The reference to the transport protocol used by the inbound NAT pool. Known values are: "Udp", "Tcp", and "All".

Default value: None
frontend_port_range_start
int

The first port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with a load balancer. Acceptable values range between 1 and 65534.

Default value: None
frontend_port_range_end
int

The last port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with a load balancer. Acceptable values range between 1 and 65535.

Default value: None
backend_port
int

The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535.

Default value: None
idle_timeout_in_minutes
int

The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.

Default value: None
enable_floating_ip
bool

Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint.

Default value: None
enable_tcp_reset
bool

Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.

Default value: None

Variables

Name Description
id
str

Resource ID.
name
str

The name of the resource that is unique within the set of inbound NAT pools used by the load balancer. This name can be used to access the resource.
etag
str

A unique read-only string that changes whenever the resource is updated.
type
str

Type of the resource.
frontend_ip_configuration
SubResource

A reference to frontend IP addresses.
protocol
str or TransportProtocol

The reference to the transport protocol used by the inbound NAT pool. Known values are: "Udp", "Tcp", and "All".
frontend_port_range_start
int

The first port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with a load balancer. Acceptable values range between 1 and 65534.
frontend_port_range_end
int

The last port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with a load balancer. Acceptable values range between 1 and 65535.
backend_port
int

The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535.
idle_timeout_in_minutes
int

The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.
enable_floating_ip
bool

Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint.
enable_tcp_reset
bool

Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.
provisioning_state
str or ProvisioningState

The provisioning state of the inbound NAT pool resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting".