InboundNatRule interface

Package:

@azure/arm-network

Inbound NAT rule of the load balancer.

Extends

SubResource

Properties

backendAddressPool	A reference to backendAddressPool resource.
backendIPConfiguration	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. NOTE: This property will not be serialized. It can only be populated by the server.
backendPort	The port used for the internal endpoint. Acceptable values range from 1 to 65535.
enableFloatingIP	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.
enableTcpReset	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.
etag	A unique read-only string that changes whenever the resource is updated. NOTE: This property will not be serialized. It can only be populated by the server.
frontendIPConfiguration	A reference to frontend IP addresses.
frontendPort	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.
frontendPortRangeEnd	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.
frontendPortRangeStart	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.
idleTimeoutInMinutes	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.
name	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.
protocol	The reference to the transport protocol used by the load balancing rule.
provisioningState	The provisioning state of the inbound NAT rule resource. NOTE: This property will not be serialized. It can only be populated by the server.
type	Type of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Inherited Properties

id	Resource ID.

Property Details

backendAddressPool

A reference to backendAddressPool resource.

backendAddressPool?: SubResource

Property Value

SubResource

backendIPConfiguration

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. NOTE: This property will not be serialized. It can only be populated by the server.

backendIPConfiguration?: NetworkInterfaceIPConfiguration

Property Value

NetworkInterfaceIPConfiguration

backendPort

The port used for the internal endpoint. Acceptable values range from 1 to 65535.

backendPort?: number

Property Value

number

enableFloatingIP

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.

enableFloatingIP?: boolean

Property Value

boolean

enableTcpReset

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.

enableTcpReset?: boolean

Property Value

boolean

etag

A unique read-only string that changes whenever the resource is updated. NOTE: This property will not be serialized. It can only be populated by the server.

etag?: string

Property Value

string

frontendIPConfiguration

A reference to frontend IP addresses.

frontendIPConfiguration?: SubResource

Property Value

SubResource

frontendPort

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.

frontendPort?: number

Property Value

number

frontendPortRangeEnd

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.

frontendPortRangeEnd?: number

Property Value

number

frontendPortRangeStart

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.

frontendPortRangeStart?: number

Property Value

number

idleTimeoutInMinutes

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.

idleTimeoutInMinutes?: number

Property Value

number

name

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.

name?: string

Property Value

string

protocol

The reference to the transport protocol used by the load balancing rule.

protocol?: string

Property Value

string

provisioningState

The provisioning state of the inbound NAT rule resource. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

type

Type of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited Property Details

id

Resource ID.

id?: string

Property Value

string

Inherited From SubResource.id