-
Notifications
You must be signed in to change notification settings - Fork 255
/
com.azure.resourcemanager.batch.models.InboundNatPool.yml
186 lines (186 loc) · 16.9 KB
/
com.azure.resourcemanager.batch.models.InboundNatPool.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
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
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
### YamlMime:JavaType
uid: "com.azure.resourcemanager.batch.models.InboundNatPool"
fullName: "com.azure.resourcemanager.batch.models.InboundNatPool"
name: "InboundNatPool"
nameWithType: "InboundNatPool"
summary: "A inbound NAT pool that can be used to address specific ports on compute nodes in a Batch pool externally."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
methodsRef:
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public final class **InboundNatPool**"
constructors:
- uid: "com.azure.resourcemanager.batch.models.InboundNatPool.InboundNatPool()"
fullName: "com.azure.resourcemanager.batch.models.InboundNatPool.InboundNatPool()"
name: "InboundNatPool()"
nameWithType: "InboundNatPool.InboundNatPool()"
syntax: "public InboundNatPool()"
methods:
- uid: "com.azure.resourcemanager.batch.models.InboundNatPool.backendPort()"
fullName: "com.azure.resourcemanager.batch.models.InboundNatPool.backendPort()"
name: "backendPort()"
nameWithType: "InboundNatPool.backendPort()"
summary: "Get the backend<wbr>Port property: The port number on the compute node."
syntax: "public int backendPort()"
desc: "Get the backendPort property: The port number on the compute node. 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:
description: "the backendPort value."
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.batch.models.InboundNatPool.frontendPortRangeEnd()"
fullName: "com.azure.resourcemanager.batch.models.InboundNatPool.frontendPortRangeEnd()"
name: "frontendPortRangeEnd()"
nameWithType: "InboundNatPool.frontendPortRangeEnd()"
summary: "Get the frontend<wbr>Port<wbr>Range<wbr>End property: The last port number in the range of external ports that will be used to provide inbound access to the backend<wbr>Port on individual compute nodes."
syntax: "public int frontendPortRangeEnd()"
desc: "Get the frontendPortRangeEnd property: The last port number in the range of external ports 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:
description: "the frontendPortRangeEnd value."
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.batch.models.InboundNatPool.frontendPortRangeStart()"
fullName: "com.azure.resourcemanager.batch.models.InboundNatPool.frontendPortRangeStart()"
name: "frontendPortRangeStart()"
nameWithType: "InboundNatPool.frontendPortRangeStart()"
summary: "Get the frontend<wbr>Port<wbr>Range<wbr>Start property: The first port number in the range of external ports that will be used to provide inbound access to the backend<wbr>Port on individual compute nodes."
syntax: "public int frontendPortRangeStart()"
desc: "Get the frontendPortRangeStart property: The first port number in the range of external ports 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:
description: "the frontendPortRangeStart value."
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.batch.models.InboundNatPool.name()"
fullName: "com.azure.resourcemanager.batch.models.InboundNatPool.name()"
name: "name()"
nameWithType: "InboundNatPool.name()"
summary: "Get the name property: The name of the endpoint."
syntax: "public String name()"
desc: "Get the name property: The name of the endpoint. 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:
description: "the name value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.batch.models.InboundNatPool.networkSecurityGroupRules()"
fullName: "com.azure.resourcemanager.batch.models.InboundNatPool.networkSecurityGroupRules()"
name: "networkSecurityGroupRules()"
nameWithType: "InboundNatPool.networkSecurityGroupRules()"
summary: "Get the network<wbr>Security<wbr>Group<wbr>Rules property: A list of network security group rules that will be applied to the endpoint."
syntax: "public List<NetworkSecurityGroupRule> networkSecurityGroupRules()"
desc: "Get the networkSecurityGroupRules property: A list of network security 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 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:
description: "the networkSecurityGroupRules value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.resourcemanager.batch.models.NetworkSecurityGroupRule?alt=com.azure.resourcemanager.batch.models.NetworkSecurityGroupRule&text=NetworkSecurityGroupRule\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.resourcemanager.batch.models.InboundNatPool.protocol()"
fullName: "com.azure.resourcemanager.batch.models.InboundNatPool.protocol()"
name: "protocol()"
nameWithType: "InboundNatPool.protocol()"
summary: "Get the protocol property: The protocol of the endpoint."
syntax: "public InboundEndpointProtocol protocol()"
desc: "Get the protocol property: The protocol of the endpoint."
returns:
description: "the protocol value."
type: "<xref href=\"com.azure.resourcemanager.batch.models.InboundEndpointProtocol?alt=com.azure.resourcemanager.batch.models.InboundEndpointProtocol&text=InboundEndpointProtocol\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.batch.models.InboundNatPool.validate()"
fullName: "com.azure.resourcemanager.batch.models.InboundNatPool.validate()"
name: "validate()"
nameWithType: "InboundNatPool.validate()"
summary: "Validates the instance."
syntax: "public void validate()"
desc: "Validates the instance."
- uid: "com.azure.resourcemanager.batch.models.InboundNatPool.withBackendPort(int)"
fullName: "com.azure.resourcemanager.batch.models.InboundNatPool.withBackendPort(int backendPort)"
name: "withBackendPort(int backendPort)"
nameWithType: "InboundNatPool.withBackendPort(int backendPort)"
summary: "Set the backend<wbr>Port property: The port number on the compute node."
parameters:
- description: "the backendPort value to set."
name: "backendPort"
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
syntax: "public InboundNatPool withBackendPort(int backendPort)"
desc: "Set the backendPort property: The port number on the compute node. 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:
description: "the InboundNatPool object itself."
type: "<xref href=\"com.azure.resourcemanager.batch.models.InboundNatPool?alt=com.azure.resourcemanager.batch.models.InboundNatPool&text=InboundNatPool\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.batch.models.InboundNatPool.withFrontendPortRangeEnd(int)"
fullName: "com.azure.resourcemanager.batch.models.InboundNatPool.withFrontendPortRangeEnd(int frontendPortRangeEnd)"
name: "withFrontendPortRangeEnd(int frontendPortRangeEnd)"
nameWithType: "InboundNatPool.withFrontendPortRangeEnd(int frontendPortRangeEnd)"
summary: "Set the frontend<wbr>Port<wbr>Range<wbr>End property: The last port number in the range of external ports that will be used to provide inbound access to the backend<wbr>Port on individual compute nodes."
parameters:
- description: "the frontendPortRangeEnd value to set."
name: "frontendPortRangeEnd"
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
syntax: "public InboundNatPool withFrontendPortRangeEnd(int frontendPortRangeEnd)"
desc: "Set the frontendPortRangeEnd property: The last port number in the range of external ports 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:
description: "the InboundNatPool object itself."
type: "<xref href=\"com.azure.resourcemanager.batch.models.InboundNatPool?alt=com.azure.resourcemanager.batch.models.InboundNatPool&text=InboundNatPool\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.batch.models.InboundNatPool.withFrontendPortRangeStart(int)"
fullName: "com.azure.resourcemanager.batch.models.InboundNatPool.withFrontendPortRangeStart(int frontendPortRangeStart)"
name: "withFrontendPortRangeStart(int frontendPortRangeStart)"
nameWithType: "InboundNatPool.withFrontendPortRangeStart(int frontendPortRangeStart)"
summary: "Set the frontend<wbr>Port<wbr>Range<wbr>Start property: The first port number in the range of external ports that will be used to provide inbound access to the backend<wbr>Port on individual compute nodes."
parameters:
- description: "the frontendPortRangeStart value to set."
name: "frontendPortRangeStart"
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
syntax: "public InboundNatPool withFrontendPortRangeStart(int frontendPortRangeStart)"
desc: "Set the frontendPortRangeStart property: The first port number in the range of external ports 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:
description: "the InboundNatPool object itself."
type: "<xref href=\"com.azure.resourcemanager.batch.models.InboundNatPool?alt=com.azure.resourcemanager.batch.models.InboundNatPool&text=InboundNatPool\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.batch.models.InboundNatPool.withName(java.lang.String)"
fullName: "com.azure.resourcemanager.batch.models.InboundNatPool.withName(String name)"
name: "withName(String name)"
nameWithType: "InboundNatPool.withName(String name)"
summary: "Set the name property: The name of the endpoint."
parameters:
- description: "the name value to set."
name: "name"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public InboundNatPool withName(String name)"
desc: "Set the name property: The name of the endpoint. 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:
description: "the InboundNatPool object itself."
type: "<xref href=\"com.azure.resourcemanager.batch.models.InboundNatPool?alt=com.azure.resourcemanager.batch.models.InboundNatPool&text=InboundNatPool\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.batch.models.InboundNatPool.withNetworkSecurityGroupRules(java.util.List<com.azure.resourcemanager.batch.models.NetworkSecurityGroupRule>)"
fullName: "com.azure.resourcemanager.batch.models.InboundNatPool.withNetworkSecurityGroupRules(List<NetworkSecurityGroupRule> networkSecurityGroupRules)"
name: "withNetworkSecurityGroupRules(List<NetworkSecurityGroupRule> networkSecurityGroupRules)"
nameWithType: "InboundNatPool.withNetworkSecurityGroupRules(List<NetworkSecurityGroupRule> networkSecurityGroupRules)"
summary: "Set the network<wbr>Security<wbr>Group<wbr>Rules property: A list of network security group rules that will be applied to the endpoint."
parameters:
- description: "the networkSecurityGroupRules value to set."
name: "networkSecurityGroupRules"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.resourcemanager.batch.models.NetworkSecurityGroupRule?alt=com.azure.resourcemanager.batch.models.NetworkSecurityGroupRule&text=NetworkSecurityGroupRule\" data-throw-if-not-resolved=\"False\" />>"
syntax: "public InboundNatPool withNetworkSecurityGroupRules(List<NetworkSecurityGroupRule> networkSecurityGroupRules)"
desc: "Set the networkSecurityGroupRules property: A list of network security 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 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:
description: "the InboundNatPool object itself."
type: "<xref href=\"com.azure.resourcemanager.batch.models.InboundNatPool?alt=com.azure.resourcemanager.batch.models.InboundNatPool&text=InboundNatPool\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.batch.models.InboundNatPool.withProtocol(com.azure.resourcemanager.batch.models.InboundEndpointProtocol)"
fullName: "com.azure.resourcemanager.batch.models.InboundNatPool.withProtocol(InboundEndpointProtocol protocol)"
name: "withProtocol(InboundEndpointProtocol protocol)"
nameWithType: "InboundNatPool.withProtocol(InboundEndpointProtocol protocol)"
summary: "Set the protocol property: The protocol of the endpoint."
parameters:
- description: "the protocol value to set."
name: "protocol"
type: "<xref href=\"com.azure.resourcemanager.batch.models.InboundEndpointProtocol?alt=com.azure.resourcemanager.batch.models.InboundEndpointProtocol&text=InboundEndpointProtocol\" data-throw-if-not-resolved=\"False\" />"
syntax: "public InboundNatPool withProtocol(InboundEndpointProtocol protocol)"
desc: "Set the protocol property: The protocol of the endpoint."
returns:
description: "the InboundNatPool object itself."
type: "<xref href=\"com.azure.resourcemanager.batch.models.InboundNatPool?alt=com.azure.resourcemanager.batch.models.InboundNatPool&text=InboundNatPool\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "A inbound NAT pool that can be used to address specific ports on compute nodes in a Batch pool externally."
metadata: {}
package: "com.azure.resourcemanager.batch.models"
artifact: com.azure.resourcemanager:azure-resourcemanager-batch:1.0.0