Share via

InboundNatRule Class

  • Reference

Inbound NAT rule of the load balancer.

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

Inheritance
azure.mgmt.network.models._models_py3.SubResource
InboundNatRule

Constructor

InboundNatRule(*, id: str | None = None, name: str | None = None, frontend_ip_configuration: _models.SubResource | None = None, protocol: str | _models.TransportProtocol | None = None, frontend_port: 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, frontend_port_range_start: int | None = None, frontend_port_range_end: int | None = None, backend_address_pool: _models.SubResource | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
id
str

Resource ID.
name
str

The name of the resource that is unique within the set of inbound NAT rules used by the load balancer. This name can be used to access 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 load balancing rule. Known values are: "Udp", "Tcp", and "All".
frontend_port
int

The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values range from 1 to 65534.
backend_port
int

The port used for the internal endpoint. Acceptable values range from 1 to 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.
frontend_port_range_start
int

The port range start for the external endpoint. This property is used together with BackendAddressPool and FrontendPortRangeEnd. Individual inbound NAT rule port mappings will be created for each backend address from BackendAddressPool. Acceptable values range from 1 to 65534.
frontend_port_range_end
int

The port range end for the external endpoint. This property is used together with BackendAddressPool and FrontendPortRangeStart. Individual inbound NAT rule port mappings will be created for each backend address from BackendAddressPool. Acceptable values range from 1 to 65534.
backend_address_pool
SubResource

A reference to backendAddressPool resource.

Variables

Name Description
id
str

Resource ID.
name
str

The name of the resource that is unique within the set of inbound NAT rules 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.
backend_ip_configuration
NetworkInterfaceIPConfiguration

A reference to a private IP address defined on a network interface of a VM. Traffic sent to the frontend port of each of the frontend IP configurations is forwarded to the backend IP.
protocol
str or TransportProtocol

The reference to the transport protocol used by the load balancing rule. Known values are: "Udp", "Tcp", and "All".
frontend_port
int

The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values range from 1 to 65534.
backend_port
int

The port used for the internal endpoint. Acceptable values range from 1 to 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.
frontend_port_range_start
int

The port range start for the external endpoint. This property is used together with BackendAddressPool and FrontendPortRangeEnd. Individual inbound NAT rule port mappings will be created for each backend address from BackendAddressPool. Acceptable values range from 1 to 65534.
frontend_port_range_end
int

The port range end for the external endpoint. This property is used together with BackendAddressPool and FrontendPortRangeStart. Individual inbound NAT rule port mappings will be created for each backend address from BackendAddressPool. Acceptable values range from 1 to 65534.
backend_address_pool
SubResource

A reference to backendAddressPool resource.
provisioning_state
str or ProvisioningState

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