/
InboundNatPool.xml
311 lines (311 loc) · 18 KB
/
InboundNatPool.xml
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
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
<Type Name="InboundNatPool" FullName="Microsoft.Azure.Management.Batch.Models.InboundNatPool">
<TypeSignature Language="C#" Value="public class InboundNatPool" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit InboundNatPool extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Management.Batch.Models.InboundNatPool" />
<TypeSignature Language="VB.NET" Value="Public Class InboundNatPool" />
<TypeSignature Language="F#" Value="type InboundNatPool = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.Batch</AssemblyName>
<AssemblyVersion>13.0.0.0</AssemblyVersion>
<AssemblyVersion>14.0.0.0</AssemblyVersion>
<AssemblyVersion>14.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
A inbound NAT pool that can be used to address specific ports on
compute nodes in a Batch pool externally.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public InboundNatPool ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Management.Batch.Models.InboundNatPool.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.Batch</AssemblyName>
<AssemblyVersion>14.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>
Initializes a new instance of the InboundNatPool class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public InboundNatPool (string name, Microsoft.Azure.Management.Batch.Models.InboundEndpointProtocol protocol, int backendPort, int frontendPortRangeStart, int frontendPortRangeEnd, System.Collections.Generic.IList<Microsoft.Azure.Management.Batch.Models.NetworkSecurityGroupRule> networkSecurityGroupRules = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string name, valuetype Microsoft.Azure.Management.Batch.Models.InboundEndpointProtocol protocol, int32 backendPort, int32 frontendPortRangeStart, int32 frontendPortRangeEnd, class System.Collections.Generic.IList`1<class Microsoft.Azure.Management.Batch.Models.NetworkSecurityGroupRule> networkSecurityGroupRules) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Management.Batch.Models.InboundNatPool.#ctor(System.String,Microsoft.Azure.Management.Batch.Models.InboundEndpointProtocol,System.Int32,System.Int32,System.Int32,System.Collections.Generic.IList{Microsoft.Azure.Management.Batch.Models.NetworkSecurityGroupRule})" />
<MemberSignature Language="VB.NET" Value="Public Sub New (name As String, protocol As InboundEndpointProtocol, backendPort As Integer, frontendPortRangeStart As Integer, frontendPortRangeEnd As Integer, Optional networkSecurityGroupRules As IList(Of NetworkSecurityGroupRule) = Nothing)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.Management.Batch.Models.InboundNatPool : string * Microsoft.Azure.Management.Batch.Models.InboundEndpointProtocol * int * int * int * System.Collections.Generic.IList<Microsoft.Azure.Management.Batch.Models.NetworkSecurityGroupRule> -> Microsoft.Azure.Management.Batch.Models.InboundNatPool" Usage="new Microsoft.Azure.Management.Batch.Models.InboundNatPool (name, protocol, backendPort, frontendPortRangeStart, frontendPortRangeEnd, networkSecurityGroupRules)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.Batch</AssemblyName>
<AssemblyVersion>14.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="name" Type="System.String" />
<Parameter Name="protocol" Type="Microsoft.Azure.Management.Batch.Models.InboundEndpointProtocol" />
<Parameter Name="backendPort" Type="System.Int32" />
<Parameter Name="frontendPortRangeStart" Type="System.Int32" />
<Parameter Name="frontendPortRangeEnd" Type="System.Int32" />
<Parameter Name="networkSecurityGroupRules" Type="System.Collections.Generic.IList<Microsoft.Azure.Management.Batch.Models.NetworkSecurityGroupRule>" />
</Parameters>
<Docs>
<param name="name">The name of the endpoint.</param>
<param name="protocol">The protocol of the endpoint.</param>
<param name="backendPort">The port number on the compute
node.</param>
<param name="frontendPortRangeStart">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.</param>
<param name="frontendPortRangeEnd">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.</param>
<param name="networkSecurityGroupRules">A list of network security
group rules that will be applied to the endpoint.</param>
<summary>
Initializes a new instance of the InboundNatPool class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="BackendPort">
<MemberSignature Language="C#" Value="public int BackendPort { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 BackendPort" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.Batch.Models.InboundNatPool.BackendPort" />
<MemberSignature Language="VB.NET" Value="Public Property BackendPort As Integer" />
<MemberSignature Language="F#" Value="member this.BackendPort : int with get, set" Usage="Microsoft.Azure.Management.Batch.Models.InboundNatPool.BackendPort" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.Batch</AssemblyName>
<AssemblyVersion>14.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="backendPort")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="backendPort")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the port number on the compute node.
</summary>
<value>To be added.</value>
<remarks>
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.
</remarks>
</Docs>
</Member>
<Member MemberName="FrontendPortRangeEnd">
<MemberSignature Language="C#" Value="public int FrontendPortRangeEnd { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 FrontendPortRangeEnd" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.Batch.Models.InboundNatPool.FrontendPortRangeEnd" />
<MemberSignature Language="VB.NET" Value="Public Property FrontendPortRangeEnd As Integer" />
<MemberSignature Language="F#" Value="member this.FrontendPortRangeEnd : int with get, set" Usage="Microsoft.Azure.Management.Batch.Models.InboundNatPool.FrontendPortRangeEnd" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.Batch</AssemblyName>
<AssemblyVersion>14.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="frontendPortRangeEnd")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="frontendPortRangeEnd")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets 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.
</summary>
<value>To be added.</value>
<remarks>
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.
</remarks>
</Docs>
</Member>
<Member MemberName="FrontendPortRangeStart">
<MemberSignature Language="C#" Value="public int FrontendPortRangeStart { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 FrontendPortRangeStart" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.Batch.Models.InboundNatPool.FrontendPortRangeStart" />
<MemberSignature Language="VB.NET" Value="Public Property FrontendPortRangeStart As Integer" />
<MemberSignature Language="F#" Value="member this.FrontendPortRangeStart : int with get, set" Usage="Microsoft.Azure.Management.Batch.Models.InboundNatPool.FrontendPortRangeStart" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.Batch</AssemblyName>
<AssemblyVersion>14.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="frontendPortRangeStart")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="frontendPortRangeStart")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets 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.
</summary>
<value>To be added.</value>
<remarks>
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.
</remarks>
</Docs>
</Member>
<Member MemberName="Name">
<MemberSignature Language="C#" Value="public string Name { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Name" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.Batch.Models.InboundNatPool.Name" />
<MemberSignature Language="VB.NET" Value="Public Property Name As String" />
<MemberSignature Language="F#" Value="member this.Name : string with get, set" Usage="Microsoft.Azure.Management.Batch.Models.InboundNatPool.Name" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.Batch</AssemblyName>
<AssemblyVersion>14.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="name")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="name")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the name of the endpoint.
</summary>
<value>To be added.</value>
<remarks>
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.
</remarks>
</Docs>
</Member>
<Member MemberName="NetworkSecurityGroupRules">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IList<Microsoft.Azure.Management.Batch.Models.NetworkSecurityGroupRule> NetworkSecurityGroupRules { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1<class Microsoft.Azure.Management.Batch.Models.NetworkSecurityGroupRule> NetworkSecurityGroupRules" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.Batch.Models.InboundNatPool.NetworkSecurityGroupRules" />
<MemberSignature Language="VB.NET" Value="Public Property NetworkSecurityGroupRules As IList(Of NetworkSecurityGroupRule)" />
<MemberSignature Language="F#" Value="member this.NetworkSecurityGroupRules : System.Collections.Generic.IList<Microsoft.Azure.Management.Batch.Models.NetworkSecurityGroupRule> with get, set" Usage="Microsoft.Azure.Management.Batch.Models.InboundNatPool.NetworkSecurityGroupRules" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.Batch</AssemblyName>
<AssemblyVersion>14.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="networkSecurityGroupRules")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="networkSecurityGroupRules")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Collections.Generic.IList<Microsoft.Azure.Management.Batch.Models.NetworkSecurityGroupRule></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets a list of network security group rules that will be
applied to the endpoint.
</summary>
<value>To be added.</value>
<remarks>
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.
</remarks>
</Docs>
</Member>
<Member MemberName="Protocol">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Management.Batch.Models.InboundEndpointProtocol Protocol { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Microsoft.Azure.Management.Batch.Models.InboundEndpointProtocol Protocol" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.Batch.Models.InboundNatPool.Protocol" />
<MemberSignature Language="VB.NET" Value="Public Property Protocol As InboundEndpointProtocol" />
<MemberSignature Language="F#" Value="member this.Protocol : Microsoft.Azure.Management.Batch.Models.InboundEndpointProtocol with get, set" Usage="Microsoft.Azure.Management.Batch.Models.InboundNatPool.Protocol" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.Batch</AssemblyName>
<AssemblyVersion>14.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="protocol")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="protocol")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Microsoft.Azure.Management.Batch.Models.InboundEndpointProtocol</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the protocol of the endpoint.
</summary>
<value>To be added.</value>
<remarks>
Possible values include: 'TCP', 'UDP'
</remarks>
</Docs>
</Member>
<Member MemberName="Validate">
<MemberSignature Language="C#" Value="public virtual void Validate ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Validate() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Management.Batch.Models.InboundNatPool.Validate" />
<MemberSignature Language="VB.NET" Value="Public Overridable Sub Validate ()" />
<MemberSignature Language="F#" Value="abstract member Validate : unit -> unit
override this.Validate : unit -> unit" Usage="inboundNatPool.Validate " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.Batch</AssemblyName>
<AssemblyVersion>14.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Validate the object.
</summary>
<remarks>To be added.</remarks>
<exception cref="T:Microsoft.Rest.ValidationException">
Thrown if validation fails
</exception>
</Docs>
</Member>
</Members>
</Type>