Share via


InboundNatRulePropertiesFormatOutput interface

Properties of the inbound NAT rule.

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.

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.

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.

protocol

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

provisioningState

The provisioning state of the inbound NAT rule resource.

Property Details

backendAddressPool

A reference to backendAddressPool resource.

backendAddressPool?: SubResourceOutput

Property Value

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.

backendIPConfiguration?: NetworkInterfaceIPConfigurationOutput

Property Value

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

frontendIPConfiguration

A reference to frontend IP addresses.

frontendIPConfiguration?: SubResourceOutput

Property Value

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

protocol

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

protocol?: "Tcp" | "Udp" | "All"

Property Value

"Tcp" | "Udp" | "All"

provisioningState

The provisioning state of the inbound NAT rule resource.

provisioningState?: "Succeeded" | "Updating" | "Deleting" | "Failed"

Property Value

"Succeeded" | "Updating" | "Deleting" | "Failed"