InboundNatRuleInner Class

Package:

com.azure.resourcemanager.network.fluent.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-network:2.44.0

• java.lang.Object
• • com.azure.core.management.SubResource
  • • com.azure.resourcemanager.network.fluent.models.InboundNatRuleInner

public final class InboundNatRuleInner
extends SubResource

Inbound NAT rule of the load balancer.

Constructor Summary

Constructor	Description
InboundNatRuleInner()	Creates an instance of InboundNatRuleInner class.

Method Summary

Modifier and Type	Method and Description
SubResource	backendAddressPool() Get the backendAddressPool property: A reference to backendAddressPool resource.
NetworkInterfaceIpConfigurationInner	backendIpConfiguration() Get the backendIpConfiguration property: A reference to a private IP address defined on a network interface of a VM.
Integer	backendPort() Get the backendPort property: The port used for the internal endpoint.
Boolean	enableFloatingIp() Get the enableFloatingIp property: Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group.
Boolean	enableTcpReset() Get the enableTcpReset property: Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination.
String	etag() Get the etag property: A unique read-only string that changes whenever the resource is updated.
static InboundNatRuleInner	fromJson(JsonReader jsonReader) Reads an instance of InboundNatRuleInner from the JsonReader.
SubResource	frontendIpConfiguration() Get the frontendIpConfiguration property: A reference to frontend IP addresses.
Integer	frontendPort() Get the frontendPort property: The port for the external endpoint.
Integer	frontendPortRangeEnd() Get the frontendPortRangeEnd property: The port range end for the external endpoint.
Integer	frontendPortRangeStart() Get the frontendPortRangeStart property: The port range start for the external endpoint.
Integer	idleTimeoutInMinutes() Get the idleTimeoutInMinutes property: The timeout for the TCP idle connection.
String	name() Get the name property: The name of the resource that is unique within the set of inbound NAT rules used by the load balancer.
TransportProtocol	protocol() Get the protocol property: The reference to the transport protocol used by the load balancing rule.
ProvisioningState	provisioningState() Get the provisioningState property: The provisioning state of the inbound NAT rule resource.
JsonWriter	toJson(JsonWriter jsonWriter)
String	type() Get the type property: Type of the resource.
void	validate() Validates the instance.
InboundNatRuleInner	withBackendAddressPool(SubResource backendAddressPool) Set the backendAddressPool property: A reference to backendAddressPool resource.
InboundNatRuleInner	withBackendPort(Integer backendPort) Set the backendPort property: The port used for the internal endpoint.
InboundNatRuleInner	withEnableFloatingIp(Boolean enableFloatingIp) Set the enableFloatingIp property: Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group.
InboundNatRuleInner	withEnableTcpReset(Boolean enableTcpReset) Set the enableTcpReset property: Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination.
InboundNatRuleInner	withFrontendIpConfiguration(SubResource frontendIpConfiguration) Set the frontendIpConfiguration property: A reference to frontend IP addresses.
InboundNatRuleInner	withFrontendPort(Integer frontendPort) Set the frontendPort property: The port for the external endpoint.
InboundNatRuleInner	withFrontendPortRangeEnd(Integer frontendPortRangeEnd) Set the frontendPortRangeEnd property: The port range end for the external endpoint.
InboundNatRuleInner	withFrontendPortRangeStart(Integer frontendPortRangeStart) Set the frontendPortRangeStart property: The port range start for the external endpoint.
InboundNatRuleInner	withId(String id)
InboundNatRuleInner	withIdleTimeoutInMinutes(Integer idleTimeoutInMinutes) Set the idleTimeoutInMinutes property: The timeout for the TCP idle connection.
InboundNatRuleInner	withName(String name) Set the name property: The name of the resource that is unique within the set of inbound NAT rules used by the load balancer.
InboundNatRuleInner	withProtocol(TransportProtocol protocol) Set the protocol property: The reference to the transport protocol used by the load balancing rule.

Methods inherited from SubResource

fromJson id toJson withId

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

InboundNatRuleInner

public InboundNatRuleInner()

Creates an instance of InboundNatRuleInner class.

Method Details

backendAddressPool

public SubResource backendAddressPool()

Get the backendAddressPool property: A reference to backendAddressPool resource.

Returns:

the backendAddressPool value.

backendIpConfiguration

public NetworkInterfaceIpConfigurationInner backendIpConfiguration()

Get the backendIpConfiguration property: 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.

Returns:

the backendIpConfiguration value.

backendPort

public Integer backendPort()

Get the backendPort property: The port used for the internal endpoint. Acceptable values range from 1 to 65535.

Returns:

the backendPort value.

enableFloatingIp

public Boolean enableFloatingIp()

Get the enableFloatingIp property: 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.

Returns:

the enableFloatingIp value.

enableTcpReset

public Boolean enableTcpReset()

Get the enableTcpReset property: 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.

Returns:

the enableTcpReset value.

etag

public String etag()

Get the etag property: A unique read-only string that changes whenever the resource is updated.

Returns:

the etag value.

fromJson

public static InboundNatRuleInner fromJson(JsonReader jsonReader)

Reads an instance of InboundNatRuleInner from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of InboundNatRuleInner if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If an error occurs while reading the InboundNatRuleInner.

frontendIpConfiguration

public SubResource frontendIpConfiguration()

Get the frontendIpConfiguration property: A reference to frontend IP addresses.

Returns:

the frontendIpConfiguration value.

frontendPort

public Integer frontendPort()

Get the frontendPort property: 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.

Returns:

the frontendPort value.

frontendPortRangeEnd

public Integer frontendPortRangeEnd()

Get the frontendPortRangeEnd property: 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.

Returns:

the frontendPortRangeEnd value.

frontendPortRangeStart

public Integer frontendPortRangeStart()

Get the frontendPortRangeStart property: 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.

Returns:

the frontendPortRangeStart value.

idleTimeoutInMinutes

public Integer idleTimeoutInMinutes()

Get the idleTimeoutInMinutes property: 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.

Returns:

the idleTimeoutInMinutes value.

name

public String name()

Get the name property: 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.

Returns:

the name value.

protocol

public TransportProtocol protocol()

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

Returns:

the protocol value.

provisioningState

public ProvisioningState provisioningState()

Get the provisioningState property: The provisioning state of the inbound NAT rule resource.

Returns:

the provisioningState value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

InboundNatRuleInner.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

type

public String type()

Get the type property: Type of the resource.

Returns:

the type value.

validate

public void validate()

Validates the instance.

withBackendAddressPool

public InboundNatRuleInner withBackendAddressPool(SubResource backendAddressPool)

Set the backendAddressPool property: A reference to backendAddressPool resource.

Parameters:

backendAddressPool - the backendAddressPool value to set.

Returns:

the InboundNatRuleInner object itself.

withBackendPort

public InboundNatRuleInner withBackendPort(Integer backendPort)

Set the backendPort property: The port used for the internal endpoint. Acceptable values range from 1 to 65535.

Parameters:

backendPort - the backendPort value to set.

Returns:

the InboundNatRuleInner object itself.

withEnableFloatingIp

public InboundNatRuleInner withEnableFloatingIp(Boolean enableFloatingIp)

Set the enableFloatingIp property: 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.

Parameters:

enableFloatingIp - the enableFloatingIp value to set.

Returns:

the InboundNatRuleInner object itself.

withEnableTcpReset

public InboundNatRuleInner withEnableTcpReset(Boolean enableTcpReset)

Set the enableTcpReset property: 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.

Parameters:

enableTcpReset - the enableTcpReset value to set.

Returns:

the InboundNatRuleInner object itself.

withFrontendIpConfiguration

public InboundNatRuleInner withFrontendIpConfiguration(SubResource frontendIpConfiguration)

Set the frontendIpConfiguration property: A reference to frontend IP addresses.

Parameters:

frontendIpConfiguration - the frontendIpConfiguration value to set.

Returns:

the InboundNatRuleInner object itself.

withFrontendPort

public InboundNatRuleInner withFrontendPort(Integer frontendPort)

Set the frontendPort property: 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.

Parameters:

frontendPort - the frontendPort value to set.

Returns:

the InboundNatRuleInner object itself.

withFrontendPortRangeEnd

public InboundNatRuleInner withFrontendPortRangeEnd(Integer frontendPortRangeEnd)

Set the frontendPortRangeEnd property: 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.

Parameters:

frontendPortRangeEnd - the frontendPortRangeEnd value to set.

Returns:

the InboundNatRuleInner object itself.

withFrontendPortRangeStart

public InboundNatRuleInner withFrontendPortRangeStart(Integer frontendPortRangeStart)

Set the frontendPortRangeStart property: 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.

Parameters:

frontendPortRangeStart - the frontendPortRangeStart value to set.

Returns:

the InboundNatRuleInner object itself.

withId

public InboundNatRuleInner withId(String id)

Overrides:

InboundNatRuleInner.withId(String id)

Parameters:

id

withIdleTimeoutInMinutes

public InboundNatRuleInner withIdleTimeoutInMinutes(Integer idleTimeoutInMinutes)

Set the idleTimeoutInMinutes property: 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.

Parameters:

idleTimeoutInMinutes - the idleTimeoutInMinutes value to set.

Returns:

the InboundNatRuleInner object itself.

withName

public InboundNatRuleInner withName(String name)

Set the name property: 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.

Parameters:

name - the name value to set.

Returns:

the InboundNatRuleInner object itself.

withProtocol

public InboundNatRuleInner withProtocol(TransportProtocol protocol)

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

Parameters:

protocol - the protocol value to set.

Returns:

the InboundNatRuleInner object itself.