-
Notifications
You must be signed in to change notification settings - Fork 264
/
VirtualMachineConfiguration.xml
365 lines (365 loc) · 21.4 KB
/
VirtualMachineConfiguration.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
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
<Type Name="VirtualMachineConfiguration" FullName="Microsoft.Azure.Batch.VirtualMachineConfiguration">
<TypeSignature Language="C#" Value="public class VirtualMachineConfiguration" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit VirtualMachineConfiguration extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Batch.VirtualMachineConfiguration" />
<TypeSignature Language="VB.NET" Value="Public Class VirtualMachineConfiguration" />
<TypeSignature Language="F#" Value="type VirtualMachineConfiguration = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>14.0.0.0</AssemblyVersion>
<AssemblyVersion>15.0.0.0</AssemblyVersion>
<AssemblyVersion>15.1.0.0</AssemblyVersion>
<AssemblyVersion>15.3.0.0</AssemblyVersion>
<AssemblyVersion>15.4.0.0</AssemblyVersion>
<AssemblyVersion>16.0.0.0</AssemblyVersion>
<AssemblyVersion>16.1.0.0</AssemblyVersion>
<AssemblyVersion>16.2.0.0</AssemblyVersion>
<AssemblyVersion>16.3.0.0</AssemblyVersion>
<AssemblyVersion>16.3.1.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
The configuration for compute nodes in a pool based on the Azure Virtual Machines infrastructure.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected VirtualMachineConfiguration ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.VirtualMachineConfiguration.#ctor" />
<MemberSignature Language="VB.NET" Value="Protected Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.3.1.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>
Default constructor to support mocking the <see cref="T:Microsoft.Azure.Batch.VirtualMachineConfiguration" /> class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public VirtualMachineConfiguration (Microsoft.Azure.Batch.ImageReference imageReference, string nodeAgentSkuId);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class Microsoft.Azure.Batch.ImageReference imageReference, string nodeAgentSkuId) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.VirtualMachineConfiguration.#ctor(Microsoft.Azure.Batch.ImageReference,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (imageReference As ImageReference, nodeAgentSkuId As String)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.Batch.VirtualMachineConfiguration : Microsoft.Azure.Batch.ImageReference * string -> Microsoft.Azure.Batch.VirtualMachineConfiguration" Usage="new Microsoft.Azure.Batch.VirtualMachineConfiguration (imageReference, nodeAgentSkuId)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.3.1.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="imageReference" Type="Microsoft.Azure.Batch.ImageReference" />
<Parameter Name="nodeAgentSkuId" Type="System.String" />
</Parameters>
<Docs>
<param name="imageReference">A reference to the Azure Virtual Machines Marketplace Image or the custom Virtual Machine Image to use.</param>
<param name="nodeAgentSkuId">The SKU of Batch Node Agent to be provisioned on the compute node.</param>
<summary>
Initializes a new instance of the <see cref="T:Microsoft.Azure.Batch.VirtualMachineConfiguration" /> class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ContainerConfiguration">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Batch.ContainerConfiguration ContainerConfiguration { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Azure.Batch.ContainerConfiguration ContainerConfiguration" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.VirtualMachineConfiguration.ContainerConfiguration" />
<MemberSignature Language="VB.NET" Value="Public Property ContainerConfiguration As ContainerConfiguration" />
<MemberSignature Language="F#" Value="member this.ContainerConfiguration : Microsoft.Azure.Batch.ContainerConfiguration with get, set" Usage="Microsoft.Azure.Batch.VirtualMachineConfiguration.ContainerConfiguration" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.3.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Batch.ContainerConfiguration</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the container configuration for the pool.
</summary>
<value>To be added.</value>
<remarks>
If specified, setup is performed on each node in the pool to allow tasks to run in containers. All regular tasks
and job manager tasks run on this pool must specify <see cref="T:Microsoft.Azure.Batch.TaskContainerSettings" />, and all other tasks
may specify it.
</remarks>
</Docs>
</Member>
<Member MemberName="DataDisks">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IList<Microsoft.Azure.Batch.DataDisk> DataDisks { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1<class Microsoft.Azure.Batch.DataDisk> DataDisks" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.VirtualMachineConfiguration.DataDisks" />
<MemberSignature Language="VB.NET" Value="Public Property DataDisks As IList(Of DataDisk)" />
<MemberSignature Language="F#" Value="member this.DataDisks : System.Collections.Generic.IList<Microsoft.Azure.Batch.DataDisk> with get, set" Usage="Microsoft.Azure.Batch.VirtualMachineConfiguration.DataDisks" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.3.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IList<Microsoft.Azure.Batch.DataDisk></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the configuration for data disks attached to the Compute Nodes in the pool.
</summary>
<value>To be added.</value>
<remarks>
This property must be specified if the Compute Nodes in the pool need to have empty data disks attached to them.
This cannot be updated.
</remarks>
</Docs>
</Member>
<Member MemberName="DiskEncryptionConfiguration">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Batch.DiskEncryptionConfiguration DiskEncryptionConfiguration { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Azure.Batch.DiskEncryptionConfiguration DiskEncryptionConfiguration" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.VirtualMachineConfiguration.DiskEncryptionConfiguration" />
<MemberSignature Language="VB.NET" Value="Public Property DiskEncryptionConfiguration As DiskEncryptionConfiguration" />
<MemberSignature Language="F#" Value="member this.DiskEncryptionConfiguration : Microsoft.Azure.Batch.DiskEncryptionConfiguration with get, set" Usage="Microsoft.Azure.Batch.VirtualMachineConfiguration.DiskEncryptionConfiguration" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.3.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Batch.DiskEncryptionConfiguration</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the disk encryption configuration for the pool.
</summary>
<value>To be added.</value>
<remarks>
If specified, encryption is performed on each node in the pool during node provisioning.
</remarks>
</Docs>
</Member>
<Member MemberName="Extensions">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IList<Microsoft.Azure.Batch.VMExtension> Extensions { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1<class Microsoft.Azure.Batch.VMExtension> Extensions" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.VirtualMachineConfiguration.Extensions" />
<MemberSignature Language="VB.NET" Value="Public Property Extensions As IList(Of VMExtension)" />
<MemberSignature Language="F#" Value="member this.Extensions : System.Collections.Generic.IList<Microsoft.Azure.Batch.VMExtension> with get, set" Usage="Microsoft.Azure.Batch.VirtualMachineConfiguration.Extensions" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.3.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IList<Microsoft.Azure.Batch.VMExtension></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the virtual machine extension for the pool.
</summary>
<value>To be added.</value>
<remarks>
If specified, the extensions mentioned in this configuration will be installed on each node.
</remarks>
</Docs>
</Member>
<Member MemberName="ImageReference">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Batch.ImageReference ImageReference { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Azure.Batch.ImageReference ImageReference" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.VirtualMachineConfiguration.ImageReference" />
<MemberSignature Language="VB.NET" Value="Public Property ImageReference As ImageReference" />
<MemberSignature Language="F#" Value="member this.ImageReference : Microsoft.Azure.Batch.ImageReference with get, set" Usage="Microsoft.Azure.Batch.VirtualMachineConfiguration.ImageReference" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.3.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Batch.ImageReference</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets a reference to the Azure Virtual Machines Marketplace Image or the custom Virtual Machine Image
to use.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="LicenseType">
<MemberSignature Language="C#" Value="public string LicenseType { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string LicenseType" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.VirtualMachineConfiguration.LicenseType" />
<MemberSignature Language="VB.NET" Value="Public Property LicenseType As String" />
<MemberSignature Language="F#" Value="member this.LicenseType : string with get, set" Usage="Microsoft.Azure.Batch.VirtualMachineConfiguration.LicenseType" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.3.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the type of on-premises license to be used when deploying the operating system.
</summary>
<value>To be added.</value>
<remarks>
This only applies to images that contain the Windows operating system, and should only be used when you hold
valid on-premises licenses for the nodes which will be deployed. If omitted, no on-premises licensing discount
is applied. Values are: 'Windows_Server' - The on-premises license is for Windows Server. 'Windows_Client' -
The on-premises license is for Windows Client.
</remarks>
</Docs>
</Member>
<Member MemberName="NodeAgentSkuId">
<MemberSignature Language="C#" Value="public string NodeAgentSkuId { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string NodeAgentSkuId" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.VirtualMachineConfiguration.NodeAgentSkuId" />
<MemberSignature Language="VB.NET" Value="Public Property NodeAgentSkuId As String" />
<MemberSignature Language="F#" Value="member this.NodeAgentSkuId : string with get, set" Usage="Microsoft.Azure.Batch.VirtualMachineConfiguration.NodeAgentSkuId" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.3.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the SKU of Batch Node Agent to be provisioned on the compute node.
</summary>
<value>To be added.</value>
<remarks>
The Batch node agent is a program that runs on each node in the pool, and provides the command-and-control interface
between the node and the Batch service. There are different implementations of the node agent, known as SKUs,
for different operating systems.
</remarks>
</Docs>
</Member>
<Member MemberName="NodePlacementConfiguration">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Batch.NodePlacementConfiguration NodePlacementConfiguration { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Azure.Batch.NodePlacementConfiguration NodePlacementConfiguration" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.VirtualMachineConfiguration.NodePlacementConfiguration" />
<MemberSignature Language="VB.NET" Value="Public Property NodePlacementConfiguration As NodePlacementConfiguration" />
<MemberSignature Language="F#" Value="member this.NodePlacementConfiguration : Microsoft.Azure.Batch.NodePlacementConfiguration with get, set" Usage="Microsoft.Azure.Batch.VirtualMachineConfiguration.NodePlacementConfiguration" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.3.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Batch.NodePlacementConfiguration</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the node placement configuration for the pool.
</summary>
<value>To be added.</value>
<remarks>
This configuration will specify rules on how nodes in the pool will be physically allocated.
</remarks>
</Docs>
</Member>
<Member MemberName="OSDisk">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Batch.OSDisk OSDisk { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Azure.Batch.OSDisk OSDisk" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.VirtualMachineConfiguration.OSDisk" />
<MemberSignature Language="VB.NET" Value="Public Property OSDisk As OSDisk" />
<MemberSignature Language="F#" Value="member this.OSDisk : Microsoft.Azure.Batch.OSDisk with get, set" Usage="Microsoft.Azure.Batch.VirtualMachineConfiguration.OSDisk" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.3.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Batch.OSDisk</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets settings for the operating system disk of the Virtual Machine.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SecurityProfile">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Batch.SecurityProfile SecurityProfile { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Azure.Batch.SecurityProfile SecurityProfile" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.VirtualMachineConfiguration.SecurityProfile" />
<MemberSignature Language="VB.NET" Value="Public Property SecurityProfile As SecurityProfile" />
<MemberSignature Language="F#" Value="member this.SecurityProfile : Microsoft.Azure.Batch.SecurityProfile with get, set" Usage="Microsoft.Azure.Batch.VirtualMachineConfiguration.SecurityProfile" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.3.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Batch.SecurityProfile</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets specifies the security profile settings for the virtual machine or virtual machine scale set.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ServiceArtifactReference">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Batch.ServiceArtifactReference ServiceArtifactReference { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Azure.Batch.ServiceArtifactReference ServiceArtifactReference" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.VirtualMachineConfiguration.ServiceArtifactReference" />
<MemberSignature Language="VB.NET" Value="Public Property ServiceArtifactReference As ServiceArtifactReference" />
<MemberSignature Language="F#" Value="member this.ServiceArtifactReference : Microsoft.Azure.Batch.ServiceArtifactReference with get, set" Usage="Microsoft.Azure.Batch.VirtualMachineConfiguration.ServiceArtifactReference" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.3.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Batch.ServiceArtifactReference</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets specifies the service artifact reference id used to set same image version for all virtual machines
in the scale set when using 'latest' image version.
</summary>
<value>To be added.</value>
<remarks>
The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName}
</remarks>
</Docs>
</Member>
<Member MemberName="WindowsConfiguration">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Batch.WindowsConfiguration WindowsConfiguration { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Azure.Batch.WindowsConfiguration WindowsConfiguration" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.VirtualMachineConfiguration.WindowsConfiguration" />
<MemberSignature Language="VB.NET" Value="Public Property WindowsConfiguration As WindowsConfiguration" />
<MemberSignature Language="F#" Value="member this.WindowsConfiguration : Microsoft.Azure.Batch.WindowsConfiguration with get, set" Usage="Microsoft.Azure.Batch.VirtualMachineConfiguration.WindowsConfiguration" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.3.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Batch.WindowsConfiguration</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets windows operating system settings on the Virtual Machine. This property must not be specified if
the ImageReference property specifies a Linux OS image.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>