Package com.microsoft.azure.batch.protocol.models

Class InboundNATPool

  • public class InboundNATPool
extends Object
    A inbound NAT Pool that can be used to address specific ports on Compute Nodes in a Batch Pool externally.

    • Constructor Detail

      • InboundNATPool

        public InboundNATPool()

    • Method Detail

      • 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

      • 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.

      • protocol

        public InboundEndpointProtocol protocol()
        Get possible values include: 'tcp', 'udp'.
        Returns:
        the protocol value

      • withProtocol

        public InboundNATPool withProtocol​(InboundEndpointProtocol protocol)
        Set possible values include: 'tcp', 'udp'.
        Parameters:
        protocol - the protocol value to set
        Returns:
        the InboundNATPool object itself.

      • 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

      • 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.

      • 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. Each range must contain at least 40 ports. If any reserved or overlapping values are provided the request fails with HTTP status code 400.
        Returns:
        the frontendPortRangeStart value

      • 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. Each range must contain at least 40 ports. 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.

      • 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. Each range must contain at least 40 ports. If any reserved or overlapping values are provided the request fails with HTTP status code 400.
        Returns:
        the frontendPortRangeEnd value

      • 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. Each range must contain at least 40 ports. 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.

      • networkSecurityGroupRules

        public List<NetworkSecurityGroupRule> 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

      • withNetworkSecurityGroupRules

        public 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. 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.