InboundNatRule (Microsoft Azure SDK for Network Management 0.9.7 API)

java.lang.Object
- com.microsoft.azure.management.network.models.ResourceId
- - com.microsoft.azure.management.network.models.ChildResource
  - - com.microsoft.azure.management.network.models.InboundNatRule

public class InboundNatRule
extends ChildResource

Inbound NAT rule of the loadbalancer

Constructor Summary

Constructors
Constructor and Description
`InboundNatRule()` Initializes a new instance of the InboundNatRule class.
`InboundNatRule(String protocol, int frontendPort, boolean enableFloatingIP)` Initializes a new instance of the InboundNatRule class with required arguments.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ResourceId`	`getBackendIPConfiguration()` Optional.
`int`	`getBackendPort()` Optional.
`ResourceId`	`getFrontendIPConfiguration()` Optional.
`int`	`getFrontendPort()` Required.
`Integer`	`getIdleTimeoutInMinutes()` Optional.
`String`	`getProtocol()` Required.
`String`	`getProvisioningState()` Optional.
`boolean`	`isEnableFloatingIP()` Required.
`void`	`setBackendIPConfiguration(ResourceId backendIPConfigurationValue)` Optional.
`void`	`setBackendPort(int backendPortValue)` Optional.
`void`	`setEnableFloatingIP(boolean enableFloatingIPValue)` Required.
`void`	`setFrontendIPConfiguration(ResourceId frontendIPConfigurationValue)` Optional.
`void`	`setFrontendPort(int frontendPortValue)` Required.
`void`	`setIdleTimeoutInMinutes(Integer idleTimeoutInMinutesValue)` Optional.
`void`	`setProtocol(String protocolValue)` Required.
`void`	`setProvisioningState(String provisioningStateValue)` Optional.

Methods inherited from class com.microsoft.azure.management.network.models.ChildResource
getEtag, getName, setEtag, setName

Methods inherited from class com.microsoft.azure.management.network.models.ResourceId
getId, setId

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - InboundNatRule
```
public InboundNatRule()
```
    Initializes a new instance of the InboundNatRule class.
  - InboundNatRule
```
public InboundNatRule(String protocol,
                      int frontendPort,
                      boolean enableFloatingIP)
```
    Initializes a new instance of the InboundNatRule class with required arguments.
    
    Parameters:
    
    protocol - Gets or sets the transport potocol for the external endpoint. Possible values are Udp or Tcp
    
    frontendPort - Gets or sets the port for the external endpoint. You can spcify any port number you choose, but the port numbers specified for each role in the service must be unique. Possible values range between 1 and 65535, inclusive
    
    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 Always ON availability Groups in SQL server. This setting can't be changed after you create the endpoint
- Method Detail
  - getBackendIPConfiguration
```
public ResourceId getBackendIPConfiguration()
```
    Optional. Gets or sets a reference to a private ip address defined on a NetworkInterface of a VM. Traffic sent to frontendPort of each of the frontendIPConfigurations is forwarded to the backed IP
    
    Returns:
    
    The BackendIPConfiguration value.
  - setBackendIPConfiguration
```
public void setBackendIPConfiguration(ResourceId backendIPConfigurationValue)
```
    Optional. Gets or sets a reference to a private ip address defined on a NetworkInterface of a VM. Traffic sent to frontendPort of each of the frontendIPConfigurations is forwarded to the backed IP
    
    Parameters:
    
    backendIPConfigurationValue - The BackendIPConfiguration value.
  - getBackendPort
```
public int getBackendPort()
```
    Optional. Gets or sets a port used for internal connections on the endpoint. The localPort attribute maps the eternal port of the endpoint to an internal port on a role. This is useful in scenarios where a role must communicate to an internal compotnent on a port that is different from the one that is exposed externally. If not specified, the value of localPort is the same as the port attribute. Set the value of localPort to '*' to automatically assign an unallocated port that is discoverable using the runtime API
    
    Returns:
    
    The BackendPort value.
  - setBackendPort
```
public void setBackendPort(int backendPortValue)
```
    Optional. Gets or sets a port used for internal connections on the endpoint. The localPort attribute maps the eternal port of the endpoint to an internal port on a role. This is useful in scenarios where a role must communicate to an internal compotnent on a port that is different from the one that is exposed externally. If not specified, the value of localPort is the same as the port attribute. Set the value of localPort to '*' to automatically assign an unallocated port that is discoverable using the runtime API
    
    Parameters:
    
    backendPortValue - The BackendPort value.
  - isEnableFloatingIP
```
public boolean isEnableFloatingIP()
```
    Required. 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 Always ON availability Groups in SQL server. This setting can't be changed after you create the endpoint
    
    Returns:
    
    The EnableFloatingIP value.
  - setEnableFloatingIP
```
public void setEnableFloatingIP(boolean enableFloatingIPValue)
```
    Required. 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 Always ON availability Groups in SQL server. This setting can't be changed after you create the endpoint
    
    Parameters:
    
    enableFloatingIPValue - The EnableFloatingIP value.
  - getFrontendIPConfiguration
```
public ResourceId getFrontendIPConfiguration()
```
    Optional. Gets or sets a reference to frontend IP Addresses
    
    Returns:
    
    The FrontendIPConfiguration value.
  - setFrontendIPConfiguration
```
public void setFrontendIPConfiguration(ResourceId frontendIPConfigurationValue)
```
    Optional. Gets or sets a reference to frontend IP Addresses
    
    Parameters:
    
    frontendIPConfigurationValue - The FrontendIPConfiguration value.
  - getFrontendPort
```
public int getFrontendPort()
```
    Required. Gets or sets the port for the external endpoint. You can spcify any port number you choose, but the port numbers specified for each role in the service must be unique. Possible values range between 1 and 65535, inclusive
    
    Returns:
    
    The FrontendPort value.
  - setFrontendPort
```
public void setFrontendPort(int frontendPortValue)
```
    Required. Gets or sets the port for the external endpoint. You can spcify any port number you choose, but the port numbers specified for each role in the service must be unique. Possible values range between 1 and 65535, inclusive
    
    Parameters:
    
    frontendPortValue - The FrontendPort value.
  - getIdleTimeoutInMinutes
```
public Integer getIdleTimeoutInMinutes()
```
    Optional. Gets or sets the timeout for the Tcp idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This emlement is only used when the protocol is set to Tcp
    
    Returns:
    
    The IdleTimeoutInMinutes value.
  - setIdleTimeoutInMinutes
```
public void setIdleTimeoutInMinutes(Integer idleTimeoutInMinutesValue)
```
    Optional. Gets or sets the timeout for the Tcp idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This emlement is only used when the protocol is set to Tcp
    
    Parameters:
    
    idleTimeoutInMinutesValue - The IdleTimeoutInMinutes value.
  - getProtocol
```
public String getProtocol()
```
    Required. Gets or sets the transport potocol for the external endpoint. Possible values are Udp or Tcp
    
    Returns:
    
    The Protocol value.
  - setProtocol
```
public void setProtocol(String protocolValue)
```
    Required. Gets or sets the transport potocol for the external endpoint. Possible values are Udp or Tcp
    
    Parameters:
    
    protocolValue - The Protocol value.
  - getProvisioningState
```
public String getProvisioningState()
```
    Optional. Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed
    
    Returns:
    
    The ProvisioningState value.
  - setProvisioningState
```
public void setProvisioningState(String provisioningStateValue)
```
    Optional. Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed
    
    Parameters:
    
    provisioningStateValue - The ProvisioningState value.

/** 
* Copyright Microsoft Corporation 
* 
* Licensed under the Apache License, Version 2.0 (the "License"); 
* you may not use this file except in compliance with the License. 
* You may obtain a copy of the License at 
* http://www.apache.org/licenses/LICENSE-2.0 
* 
* Unless required by applicable law or agreed to in writing, software 
* distributed under the License is distributed on an "AS IS" BASIS, 
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
* See the License for the specific language governing permissions and 
* limitations under the License. 
*/

Class InboundNatRule

Constructor Summary

Method Summary

Methods inherited from class com.microsoft.azure.management.network.models.ChildResource

Methods inherited from class com.microsoft.azure.management.network.models.ResourceId

Methods inherited from class java.lang.Object

Constructor Detail

InboundNatRule

InboundNatRule

Method Detail

getBackendIPConfiguration

setBackendIPConfiguration

getBackendPort

setBackendPort

isEnableFloatingIP

setEnableFloatingIP

getFrontendIPConfiguration

setFrontendIPConfiguration

getFrontendPort

setFrontendPort

getIdleTimeoutInMinutes

setIdleTimeoutInMinutes

getProtocol

setProtocol

getProvisioningState

setProvisioningState