-
Notifications
You must be signed in to change notification settings - Fork 256
/
ImageReference.xml
295 lines (295 loc) · 15.7 KB
/
ImageReference.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
<Type Name="ImageReference" FullName="Microsoft.Azure.Batch.Protocol.Models.ImageReference">
<TypeSignature Language="C#" Value="public class ImageReference" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit ImageReference extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Batch.Protocol.Models.ImageReference" />
<TypeSignature Language="VB.NET" Value="Public Class ImageReference" />
<TypeSignature Language="F#" Value="type ImageReference = 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>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
A reference to an Azure Virtual Machines Marketplace Image or a Azure
Compute Gallery Image. To get the list of all Azure Marketplace Image
references verified by Azure Batch, see the 'List Supported Images'
operation.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ImageReference ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.Protocol.Models.ImageReference.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>
Initializes a new instance of the ImageReference class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ImageReference (string publisher = default, string offer = default, string sku = default, string version = default, string virtualMachineImageId = default, string exactVersion = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string publisher, string offer, string sku, string version, string virtualMachineImageId, string exactVersion) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.Protocol.Models.ImageReference.#ctor(System.String,System.String,System.String,System.String,System.String,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (Optional publisher As String = Nothing, Optional offer As String = Nothing, Optional sku As String = Nothing, Optional version As String = Nothing, Optional virtualMachineImageId As String = Nothing, Optional exactVersion As String = Nothing)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.Batch.Protocol.Models.ImageReference : string * string * string * string * string * string -> Microsoft.Azure.Batch.Protocol.Models.ImageReference" Usage="new Microsoft.Azure.Batch.Protocol.Models.ImageReference (publisher, offer, sku, version, virtualMachineImageId, exactVersion)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="publisher" Type="System.String" />
<Parameter Name="offer" Type="System.String" />
<Parameter Name="sku" Type="System.String" />
<Parameter Name="version" Type="System.String" />
<Parameter Name="virtualMachineImageId" Type="System.String" />
<Parameter Name="exactVersion" Type="System.String" />
</Parameters>
<Docs>
<param name="publisher">The publisher of the Azure Virtual Machines
Marketplace Image.</param>
<param name="offer">The offer type of the Azure Virtual Machines
Marketplace Image.</param>
<param name="sku">The SKU of the Azure Virtual Machines Marketplace
Image.</param>
<param name="version">The version of the Azure Virtual Machines
Marketplace Image.</param>
<param name="virtualMachineImageId">The ARM resource identifier of
the Azure Compute Gallery Image. Compute Nodes in the Pool will be
created using this Image Id. This is of the form
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{VersionId}
or
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}
for always defaulting to the latest image version.</param>
<param name="exactVersion">The specific version of the platform
image or marketplace image used to create the node. This read-only
field differs from 'version' only if the value specified for
'version' when the pool was created was 'latest'.</param>
<summary>
Initializes a new instance of the ImageReference class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ExactVersion">
<MemberSignature Language="C#" Value="public string ExactVersion { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string ExactVersion" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.Protocol.Models.ImageReference.ExactVersion" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property ExactVersion As String" />
<MemberSignature Language="F#" Value="member this.ExactVersion : string" Usage="Microsoft.Azure.Batch.Protocol.Models.ImageReference.ExactVersion" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="exactVersion")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="exactVersion")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the specific version of the platform image or marketplace
image used to create the node. This read-only field differs from
'version' only if the value specified for 'version' when the pool
was created was 'latest'.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Offer">
<MemberSignature Language="C#" Value="public string Offer { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Offer" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.Protocol.Models.ImageReference.Offer" />
<MemberSignature Language="VB.NET" Value="Public Property Offer As String" />
<MemberSignature Language="F#" Value="member this.Offer : string with get, set" Usage="Microsoft.Azure.Batch.Protocol.Models.ImageReference.Offer" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="offer")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="offer")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the offer type of the Azure Virtual Machines
Marketplace Image.
</summary>
<value>To be added.</value>
<remarks>
For example, UbuntuServer or WindowsServer.
</remarks>
</Docs>
</Member>
<Member MemberName="Publisher">
<MemberSignature Language="C#" Value="public string Publisher { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Publisher" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.Protocol.Models.ImageReference.Publisher" />
<MemberSignature Language="VB.NET" Value="Public Property Publisher As String" />
<MemberSignature Language="F#" Value="member this.Publisher : string with get, set" Usage="Microsoft.Azure.Batch.Protocol.Models.ImageReference.Publisher" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="publisher")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="publisher")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the publisher of the Azure Virtual Machines
Marketplace Image.
</summary>
<value>To be added.</value>
<remarks>
For example, Canonical or MicrosoftWindowsServer.
</remarks>
</Docs>
</Member>
<Member MemberName="Sku">
<MemberSignature Language="C#" Value="public string Sku { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Sku" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.Protocol.Models.ImageReference.Sku" />
<MemberSignature Language="VB.NET" Value="Public Property Sku As String" />
<MemberSignature Language="F#" Value="member this.Sku : string with get, set" Usage="Microsoft.Azure.Batch.Protocol.Models.ImageReference.Sku" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="sku")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="sku")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the SKU of the Azure Virtual Machines Marketplace
Image.
</summary>
<value>To be added.</value>
<remarks>
For example, 18.04-LTS or 2019-Datacenter.
</remarks>
</Docs>
</Member>
<Member MemberName="Version">
<MemberSignature Language="C#" Value="public string Version { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Version" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.Protocol.Models.ImageReference.Version" />
<MemberSignature Language="VB.NET" Value="Public Property Version As String" />
<MemberSignature Language="F#" Value="member this.Version : string with get, set" Usage="Microsoft.Azure.Batch.Protocol.Models.ImageReference.Version" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="version")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="version")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the version of the Azure Virtual Machines Marketplace
Image.
</summary>
<value>To be added.</value>
<remarks>
A value of 'latest' can be specified to select the latest version
of an Image. If omitted, the default is 'latest'.
</remarks>
</Docs>
</Member>
<Member MemberName="VirtualMachineImageId">
<MemberSignature Language="C#" Value="public string VirtualMachineImageId { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string VirtualMachineImageId" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.Protocol.Models.ImageReference.VirtualMachineImageId" />
<MemberSignature Language="VB.NET" Value="Public Property VirtualMachineImageId As String" />
<MemberSignature Language="F#" Value="member this.VirtualMachineImageId : string with get, set" Usage="Microsoft.Azure.Batch.Protocol.Models.ImageReference.VirtualMachineImageId" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="virtualMachineImageId")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="virtualMachineImageId")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the ARM resource identifier of the Azure Compute
Gallery Image. Compute Nodes in the Pool will be created using this
Image Id. This is of the form
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{VersionId}
or
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}
for always defaulting to the latest image version.
</summary>
<value>To be added.</value>
<remarks>
This property is mutually exclusive with other ImageReference
properties. The Azure Compute Gallery Image must have replicas in
the same region and must be in the same subscription as the Azure
Batch account. If the image version is not specified in the
imageId, the latest version will be used. For information about the
firewall settings for the Batch Compute Node agent to communicate
with the Batch service see
https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration.
</remarks>
</Docs>
</Member>
</Members>
</Type>