InboundNatPool Class

Package:

com.microsoft.azure.management.batch

Maven Artifact:

com.microsoft.azure:azure-mgmt-batch:1.41.4

• java.lang.Object
• • com.microsoft.azure.management.batch.InboundNatPool

public class InboundNatPool

A inbound NAT pool that can be used to address specific ports on compute nodes in a Batch pool externally.

Constructor Summary

Constructor	Description
InboundNatPool()

Method Summary

Modifier and Type	Method and Description
int	backendPort() Get this must be unique within a Batch pool.
int	frontendPortRangeEnd() Get acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved by the Batch service.
int	frontendPortRangeStart() Get acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved.
java.lang.String	name() Get the name must be unique within a Batch pool, can contain letters, numbers, underscores, periods, and hyphens.
java.util.List<NetworkSecurityGroupRule>	networkSecurityGroupRules() Get the maximum number of rules that can be specified across all the endpoints on a Batch pool is 25.
InboundEndpointProtocol	protocol() Get possible values include: 'TCP', 'UDP'.
InboundNatPool	withBackendPort(int backendPort) Set this must be unique within a Batch pool.
InboundNatPool	withFrontendPortRangeEnd(int frontendPortRangeEnd) Set acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved by the Batch service.
InboundNatPool	withFrontendPortRangeStart(int frontendPortRangeStart) Set acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved.
InboundNatPool	withName(String name) Set the name must be unique within a Batch pool, can contain letters, numbers, underscores, periods, and hyphens.
InboundNatPool	withNetworkSecurityGroupRules(List<NetworkSecurityGroupRule> networkSecurityGroupRules) Set the maximum number of rules that can be specified across all the endpoints on a Batch pool is 25.
InboundNatPool	withProtocol(InboundEndpointProtocol protocol) Set possible values include: 'TCP', 'UDP'.

Methods inherited from java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Constructor Details

InboundNatPool

public InboundNatPool()

Method Details

backendPort

public int backendPort()

Get this must be unique within a Batch pool. Acceptable values are between 1 and 65535 except for 22, 3389, 29876 and 29877 as these are reserved. If any reserved values are provided the request fails with HTTP status code 400.

Returns:

the backendPort value

frontendPortRangeEnd

public int frontendPortRangeEnd()

Get acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved by the Batch service. All ranges within a pool must be distinct and cannot overlap. If any reserved or overlapping values are provided the request fails with HTTP status code 400.

Returns:

the frontendPortRangeEnd value

frontendPortRangeStart

public int frontendPortRangeStart()

Get acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved. All ranges within a pool must be distinct and cannot overlap. If any reserved or overlapping values are provided the request fails with HTTP status code 400.

Returns:

the frontendPortRangeStart value

name

public String name()

Get the name must be unique within a Batch pool, can contain letters, numbers, underscores, periods, and hyphens. Names must start with a letter or number, must end with a letter, number, or underscore, and cannot exceed 77 characters. If any invalid values are provided the request fails with HTTP status code 400.

Returns:

the name value

networkSecurityGroupRules

public List networkSecurityGroupRules()

Get the maximum number of rules that can be specified across all the endpoints on a Batch pool is 25. If no network security group rules are specified, a default rule will be created to allow inbound access to the specified backendPort. If the maximum number of network security group rules is exceeded the request fails with HTTP status code 400.

Returns:

the networkSecurityGroupRules value

protocol

public InboundEndpointProtocol protocol()

Get possible values include: 'TCP', 'UDP'.

Returns:

the protocol value

withBackendPort

public InboundNatPool withBackendPort(int backendPort)

Set this must be unique within a Batch pool. Acceptable values are between 1 and 65535 except for 22, 3389, 29876 and 29877 as these are reserved. If any reserved values are provided the request fails with HTTP status code 400.

Parameters:

backendPort - the backendPort value to set

Returns:

the InboundNatPool object itself.

withFrontendPortRangeEnd

public InboundNatPool withFrontendPortRangeEnd(int frontendPortRangeEnd)

Set acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved by the Batch service. All ranges within a pool must be distinct and cannot overlap. If any reserved or overlapping values are provided the request fails with HTTP status code 400.

Parameters:

frontendPortRangeEnd - the frontendPortRangeEnd value to set

Returns:

the InboundNatPool object itself.

withFrontendPortRangeStart

public InboundNatPool withFrontendPortRangeStart(int frontendPortRangeStart)

Set acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved. All ranges within a pool must be distinct and cannot overlap. If any reserved or overlapping values are provided the request fails with HTTP status code 400.

Parameters:

frontendPortRangeStart - the frontendPortRangeStart value to set

Returns:

the InboundNatPool object itself.

withName

public InboundNatPool withName(String name)

Set the name must be unique within a Batch pool, can contain letters, numbers, underscores, periods, and hyphens. Names must start with a letter or number, must end with a letter, number, or underscore, and cannot exceed 77 characters. If any invalid values are provided the request fails with HTTP status code 400.

Parameters:

name - the name value to set

Returns:

the InboundNatPool object itself.

withNetworkSecurityGroupRules

public InboundNatPool withNetworkSecurityGroupRules(List networkSecurityGroupRules)

Set the maximum number of rules that can be specified across all the endpoints on a Batch pool is 25. If no network security group rules are specified, a default rule will be created to allow inbound access to the specified backendPort. If the maximum number of network security group rules is exceeded the request fails with HTTP status code 400.

Parameters:

networkSecurityGroupRules - the networkSecurityGroupRules value to set

Returns:

the InboundNatPool object itself.

withProtocol

public InboundNatPool withProtocol(InboundEndpointProtocol protocol)

Set possible values include: 'TCP', 'UDP'.

Parameters:

protocol - the protocol value to set

Returns:

the InboundNatPool object itself.