Class InboundNatPool

java.lang.Object
com.azure.core.management.SubResource
com.azure.resourcemanager.network.models.InboundNatPool
All Implemented Interfaces:
com.azure.json.JsonSerializable<com.azure.core.management.SubResource>

public final class InboundNatPool extends com.azure.core.management.SubResource
Inbound NAT pool of the load balancer.
  • Constructor Summary

    Constructors
    Constructor
    Description
    Creates an instance of InboundNatPool class.
  • Method Summary

    Modifier and Type
    Method
    Description
    Get the backendPort property: The port used for internal connections on the endpoint.
    Get the enableFloatingIp property: Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group.
    Get the enableTcpReset property: Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination.
    Get the etag property: A unique read-only string that changes whenever the resource is updated.
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of InboundNatPool from the JsonReader.
    com.azure.core.management.SubResource
    Get the frontendIpConfiguration property: A reference to frontend IP addresses.
    Get the frontendPortRangeEnd property: The last port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with a load balancer.
    Get the frontendPortRangeStart property: The first port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with a load balancer.
    Get the idleTimeoutInMinutes property: The timeout for the TCP idle connection.
    Get the name property: The name of the resource that is unique within the set of inbound NAT pools used by the load balancer.
    Get the protocol property: The reference to the transport protocol used by the inbound NAT pool.
    Get the provisioningState property: The provisioning state of the inbound NAT pool resource.
    com.azure.json.JsonWriter
    toJson(com.azure.json.JsonWriter jsonWriter)
    Get the type property: Type of the resource.
    void
    Validates the instance.
    withBackendPort(Integer backendPort)
    Set the backendPort property: The port used for internal connections on the endpoint.
    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.
    withEnableTcpReset(Boolean enableTcpReset)
    Set the enableTcpReset property: Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination.
    withFrontendIpConfiguration(com.azure.core.management.SubResource frontendIpConfiguration)
    Set the frontendIpConfiguration property: A reference to frontend IP addresses.
    withFrontendPortRangeEnd(Integer frontendPortRangeEnd)
    Set the frontendPortRangeEnd property: The last port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with a load balancer.
    withFrontendPortRangeStart(Integer frontendPortRangeStart)
    Set the frontendPortRangeStart property: The first port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with a load balancer.
    withIdleTimeoutInMinutes(Integer idleTimeoutInMinutes)
    Set the idleTimeoutInMinutes property: The timeout for the TCP idle connection.
    Set the name property: The name of the resource that is unique within the set of inbound NAT pools used by the load balancer.
    Set the protocol property: The reference to the transport protocol used by the inbound NAT pool.

    Methods inherited from class com.azure.core.management.SubResource

    id

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface com.azure.json.JsonSerializable

    toJson, toJson, toJsonBytes, toJsonString
  • Constructor Details

    • InboundNatPool

      public InboundNatPool()
      Creates an instance of InboundNatPool class.
  • Method Details

    • name

      public String name()
      Get the name property: The name of the resource that is unique within the set of inbound NAT pools used by the load balancer. This name can be used to access the resource.
      Returns:
      the name value.
    • withName

      public InboundNatPool withName(String name)
      Set the name property: The name of the resource that is unique within the set of inbound NAT pools used by the load balancer. This name can be used to access the resource.
      Parameters:
      name - the name value to set.
      Returns:
      the InboundNatPool object itself.
    • etag

      public String etag()
      Get the etag property: A unique read-only string that changes whenever the resource is updated.
      Returns:
      the etag value.
    • type

      public String type()
      Get the type property: Type of the resource.
      Returns:
      the type value.
    • withId

      public InboundNatPool withId(String id)
      Overrides:
      withId in class com.azure.core.management.SubResource
    • frontendIpConfiguration

      public com.azure.core.management.SubResource frontendIpConfiguration()
      Get the frontendIpConfiguration property: A reference to frontend IP addresses.
      Returns:
      the frontendIpConfiguration value.
    • withFrontendIpConfiguration

      public InboundNatPool withFrontendIpConfiguration(com.azure.core.management.SubResource frontendIpConfiguration)
      Set the frontendIpConfiguration property: A reference to frontend IP addresses.
      Parameters:
      frontendIpConfiguration - the frontendIpConfiguration value to set.
      Returns:
      the InboundNatPool object itself.
    • protocol

      public TransportProtocol protocol()
      Get the protocol property: The reference to the transport protocol used by the inbound NAT pool.
      Returns:
      the protocol value.
    • withProtocol

      public InboundNatPool withProtocol(TransportProtocol protocol)
      Set the protocol property: The reference to the transport protocol used by the inbound NAT pool.
      Parameters:
      protocol - the protocol value to set.
      Returns:
      the InboundNatPool object itself.
    • frontendPortRangeStart

      public Integer frontendPortRangeStart()
      Get the frontendPortRangeStart property: The first port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with a load balancer. Acceptable values range between 1 and 65534.
      Returns:
      the frontendPortRangeStart value.
    • withFrontendPortRangeStart

      public InboundNatPool withFrontendPortRangeStart(Integer frontendPortRangeStart)
      Set the frontendPortRangeStart property: The first port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with a load balancer. Acceptable values range between 1 and 65534.
      Parameters:
      frontendPortRangeStart - the frontendPortRangeStart value to set.
      Returns:
      the InboundNatPool object itself.
    • frontendPortRangeEnd

      public Integer frontendPortRangeEnd()
      Get the frontendPortRangeEnd property: The last port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with a load balancer. Acceptable values range between 1 and 65535.
      Returns:
      the frontendPortRangeEnd value.
    • withFrontendPortRangeEnd

      public InboundNatPool withFrontendPortRangeEnd(Integer frontendPortRangeEnd)
      Set the frontendPortRangeEnd property: The last port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with a load balancer. Acceptable values range between 1 and 65535.
      Parameters:
      frontendPortRangeEnd - the frontendPortRangeEnd value to set.
      Returns:
      the InboundNatPool object itself.
    • backendPort

      public Integer backendPort()
      Get the backendPort property: The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535.
      Returns:
      the backendPort value.
    • withBackendPort

      public InboundNatPool withBackendPort(Integer backendPort)
      Set the backendPort property: The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535.
      Parameters:
      backendPort - the backendPort value to set.
      Returns:
      the InboundNatPool object itself.
    • 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.
    • withIdleTimeoutInMinutes

      public InboundNatPool 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 InboundNatPool object itself.
    • 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.
    • withEnableFloatingIp

      public InboundNatPool 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 InboundNatPool object itself.
    • 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.
    • withEnableTcpReset

      public InboundNatPool 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 InboundNatPool object itself.
    • provisioningState

      public ProvisioningState provisioningState()
      Get the provisioningState property: The provisioning state of the inbound NAT pool resource.
      Returns:
      the provisioningState value.
    • validate

      public void validate()
      Validates the instance.
      Throws:
      IllegalArgumentException - thrown if the instance is not valid.
    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<com.azure.core.management.SubResource>
      Overrides:
      toJson in class com.azure.core.management.SubResource
      Throws:
      IOException
    • fromJson

      public static InboundNatPool fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of InboundNatPool from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of InboundNatPool 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 InboundNatPool.