3.1.5.5.4 inboundNatRules

The inboundNatRules resource is used to configure the load balancer to apply Network Address Translation (NAT) of inbound traffic.

It is invoked through the following URI.

 https://<url>/networking/v1/loadBalancers/{parentResourceId}/inboundNatRules/{resourceId}

url: The address or name of the REST server of the Network Controller.

parentResourceId: the identifier for the specific ancestor resource within the resource type. See section 2.2.3.3 for more details.

resourceId: the identifier for the specific descendant resource within the resource type. See section 2.2.3.4 for more details.

Note  The server MAY support additional versions, besides v1 in the URI.

The following HTTP methods can be performed on this resource.

HTTP method

Section

Description

PUT

3.1.5.5.4.1.1

Create a new inboundNatRules resource or update an existing inboundNatRules resource.

GET

3.1.5.5.4.1.2

Get one inboundNatRules resource.

GET ALL

3.1.5.5.4.1.3

List all inboundNatRules resources in the Network Controller.

DELETE

3.1.5.5.4.1.4

Deletes a inboundNatRules resource.

The following property elements are valid.

Element name

Type

Description

etag

Read-only

Specified in Common JSON Elements, section 2.2.2.

provisioningState

Read-only

Specified in Common JSON Elements, section 2.2.2.

frontendIPConfigurations

Required

Indicates an array of references to frontendIPConfigurations resources.

protocol

Required

Indicates the inbound transport protocol for the external endpoint. Valid values include UDP, TCP, GRE, ESP, or ALL.  ALL indicates a wildcard.

frontendPort

Optional

The port for the external endpoint. Any port number can be specified, but the port numbers specified for each role in the service MUST be unique. Possible values range between 1 and 65535, inclusive.

This parameter MUST be specified if protocol is TCP or UDP.

backendPort

Optional

Indicates a port used for internal connections on the endpoint. The localPort attribute maps the external port on the endpoint to an internal port on a role. This is useful in scenarios where a role has to communicate to an internal component on a port that is different from the one that is exposed externally.

Possible values range between 1 and 65535, inclusive.

This parameter is required if the protocol is TCP or UDP.

enableFloatingIP

Optional

This specifies that a floating IP (VIP) will be used on the available servers behind a loadBalancer. Floating IP will be forwarded by the loadBalancer to the backend server. The back-end server will be configured with that VIP, a datacenter IP and weakhost forwarding.

Floating IP configuration is required if you are using the SQL AlwaysOn Availability Group feature. This setting can't be changed after you create the endpoint.

idleTimeoutInMinutes

Optional

Indicates the timeout for the TCP idle connection in the inbound direction, i.e. a connection initiated by an internet client to a VIP. The value can be set between 4 and 30 minutes. The default value is 4 minutes.

backendIPConfiguration

Optional

Indicates a reference to backendAddressPools resource.  Traffic sent to frontendPort of each of the frontendIPConfigurations is forwarded to the backend IP.

enableTcpReset

Optional

Enables TCP connection reset when the flow times out due to inactivity. The default value is false.

This property is supported with URI version v4 or later.