Class: Azure::Batch::Mgmt::V2018_12_01::Models::InboundNatPool

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2018-12-01/generated/azure_mgmt_batch/models/inbound_nat_pool.rb

Overview

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#backend_port ⇒ Integer

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:

  • (Integer) —

    The port number on the compute node. This must be



34
35
36
 
# File 'lib/2018-12-01/generated/azure_mgmt_batch/models/inbound_nat_pool.rb', line 34

def backend_port
  @backend_port
end

#frontend_port_range_end ⇒ Integer

that will be used to provide inbound access to the backendPort on individual compute nodes. 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:

  • (Integer) —

    The last port number in the range of external ports



52
53
54
 
# File 'lib/2018-12-01/generated/azure_mgmt_batch/models/inbound_nat_pool.rb', line 52

def frontend_port_range_end
  @frontend_port_range_end
end

#frontend_port_range_start ⇒ Integer

that will be used to provide inbound access to the backendPort on individual compute nodes. 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:

  • (Integer) —

    The first port number in the range of external ports



43
44
45
 
# File 'lib/2018-12-01/generated/azure_mgmt_batch/models/inbound_nat_pool.rb', line 43

def frontend_port_range_start
  @frontend_port_range_start
end

#name ⇒ String

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:

  • (String) —

    The name of the endpoint. The name must be unique



23
24
25
 
# File 'lib/2018-12-01/generated/azure_mgmt_batch/models/inbound_nat_pool.rb', line 23

def name
  @name
end

#network_security_group_rules ⇒ Array<NetworkSecurityGroupRule>

group rules that will be applied to the endpoint. The maximum number of rules that can be specified across all the endpoints on a Batch pool is

  1. 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:



61
62
63
 
# File 'lib/2018-12-01/generated/azure_mgmt_batch/models/inbound_nat_pool.rb', line 61

def network_security_group_rules
  @network_security_group_rules
end

#protocol ⇒ InboundEndpointProtocol

Possible values include: ‘TCP’, ‘UDP’

Returns:



27
28
29
 
# File 'lib/2018-12-01/generated/azure_mgmt_batch/models/inbound_nat_pool.rb', line 27

def protocol
  @protocol
end

Class Method Details

.mapper ⇒ Object

Mapper for InboundNatPool class as Ruby Hash. This will be used for serialization/deserialization.



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/2018-12-01/generated/azure_mgmt_batch/models/inbound_nat_pool.rb', line 68

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'InboundNatPool',
    type: {
      name: 'Composite',
      class_name: 'InboundNatPool',
      model_properties: {
        name: {
          client_side_validation: true,
          required: true,
          serialized_name: 'name',
          type: {
            name: 'String'
          }
        },
        protocol: {
          client_side_validation: true,
          required: true,
          serialized_name: 'protocol',
          type: {
            name: 'Enum',
            module: 'InboundEndpointProtocol'
          }
        },
        backend_port: {
          client_side_validation: true,
          required: true,
          serialized_name: 'backendPort',
          type: {
            name: 'Number'
          }
        },
        frontend_port_range_start: {
          client_side_validation: true,
          required: true,
          serialized_name: 'frontendPortRangeStart',
          type: {
            name: 'Number'
          }
        },
        frontend_port_range_end: {
          client_side_validation: true,
          required: true,
          serialized_name: 'frontendPortRangeEnd',
          type: {
            name: 'Number'
          }
        },
        network_security_group_rules: {
          client_side_validation: true,
          required: false,
          serialized_name: 'networkSecurityGroupRules',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'NetworkSecurityGroupRuleElementType',
                type: {
                  name: 'Composite',
                  class_name: 'NetworkSecurityGroupRule'
                }
            }
          }
        }
      }
    }
  }
end