-
Notifications
You must be signed in to change notification settings - Fork 263
/
BatchClient.xml
323 lines (323 loc) · 19 KB
/
BatchClient.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
<Type Name="BatchClient" FullName="Microsoft.Azure.Batch.BatchClient">
<TypeSignature Language="C#" Value="public class BatchClient : IDisposable" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit BatchClient extends System.Object implements class System.IDisposable" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Batch.BatchClient" />
<TypeSignature Language="VB.NET" Value="Public Class BatchClient
Implements IDisposable" />
<TypeSignature Language="F#" Value="type BatchClient = class
 interface IDisposable" />
<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>
<Interface>
<InterfaceName>System.IDisposable</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<summary>
A client for an Azure Batch account, used to access the Batch service.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="ApplicationOperations">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Batch.ApplicationOperations ApplicationOperations { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Azure.Batch.ApplicationOperations ApplicationOperations" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.BatchClient.ApplicationOperations" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property ApplicationOperations As ApplicationOperations" />
<MemberSignature Language="F#" Value="member this.ApplicationOperations : Microsoft.Azure.Batch.ApplicationOperations" Usage="Microsoft.Azure.Batch.BatchClient.ApplicationOperations" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.3.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Batch.ApplicationOperations</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets an <see cref="P:Microsoft.Azure.Batch.BatchClient.ApplicationOperations" /> for performing application-related operations on the associated account.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CertificateOperations">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Batch.CertificateOperations CertificateOperations { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Azure.Batch.CertificateOperations CertificateOperations" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.BatchClient.CertificateOperations" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property CertificateOperations As CertificateOperations" />
<MemberSignature Language="F#" Value="member this.CertificateOperations : Microsoft.Azure.Batch.CertificateOperations" Usage="Microsoft.Azure.Batch.BatchClient.CertificateOperations" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.3.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Batch.CertificateOperations</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets a <see cref="P:Microsoft.Azure.Batch.BatchClient.CertificateOperations" /> for performing certificate-related operations on the associated account.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CustomBehaviors">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IList<Microsoft.Azure.Batch.BatchClientBehavior> CustomBehaviors { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1<class Microsoft.Azure.Batch.BatchClientBehavior> CustomBehaviors" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.BatchClient.CustomBehaviors" />
<MemberSignature Language="VB.NET" Value="Public Property CustomBehaviors As IList(Of BatchClientBehavior)" />
<MemberSignature Language="F#" Value="member this.CustomBehaviors : System.Collections.Generic.IList<Microsoft.Azure.Batch.BatchClientBehavior> with get, set" Usage="Microsoft.Azure.Batch.BatchClient.CustomBehaviors" />
<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.BatchClientBehavior></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets a list of behaviors that modify or customize requests to the Batch service.
</summary>
<value>To be added.</value>
<remarks>
<para>These behaviors are inherited by child objects.</para>
<para>Modifications are applied in the order of the collection. The last write wins.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="Dispose">
<MemberSignature Language="C#" Value="public void Dispose ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Dispose() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.BatchClient.Dispose" />
<MemberSignature Language="VB.NET" Value="Public Sub Dispose ()" />
<MemberSignature Language="F#" Value="abstract member Dispose : unit -> unit
override this.Dispose : unit -> unit" Usage="batchClient.Dispose " />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:System.IDisposable.Dispose</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.3.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Releases the unmanaged resources and disposes of the managed resources used by the <see cref="T:Microsoft.Azure.Batch.BatchClient" />.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Dispose">
<MemberSignature Language="C#" Value="protected virtual void Dispose (bool disposing);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance void Dispose(bool disposing) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.BatchClient.Dispose(System.Boolean)" />
<MemberSignature Language="VB.NET" Value="Protected Overridable Sub Dispose (disposing As Boolean)" />
<MemberSignature Language="F#" Value="abstract member Dispose : bool -> unit
override this.Dispose : bool -> unit" Usage="batchClient.Dispose disposing" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.3.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="disposing" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="disposing">Indicates whether the object is being disposed or finalized. If true, the object is
being disposed and can dispose managed resource. If false, the object is being finalized and should only
release unmanaged resources.</param>
<summary>
Releases unmanaged resources used by the <see cref="T:Microsoft.Azure.Batch.BatchClient" />, and optionally disposes of managed resources.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="JobOperations">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Batch.JobOperations JobOperations { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Azure.Batch.JobOperations JobOperations" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.BatchClient.JobOperations" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property JobOperations As JobOperations" />
<MemberSignature Language="F#" Value="member this.JobOperations : Microsoft.Azure.Batch.JobOperations" Usage="Microsoft.Azure.Batch.BatchClient.JobOperations" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.3.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Batch.JobOperations</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets a <see cref="P:Microsoft.Azure.Batch.BatchClient.JobOperations" /> for performing job-related operations on the associated account.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="JobScheduleOperations">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Batch.JobScheduleOperations JobScheduleOperations { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Azure.Batch.JobScheduleOperations JobScheduleOperations" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.BatchClient.JobScheduleOperations" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property JobScheduleOperations As JobScheduleOperations" />
<MemberSignature Language="F#" Value="member this.JobScheduleOperations : Microsoft.Azure.Batch.JobScheduleOperations" Usage="Microsoft.Azure.Batch.BatchClient.JobScheduleOperations" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.3.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Batch.JobScheduleOperations</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets a <see cref="P:Microsoft.Azure.Batch.BatchClient.JobScheduleOperations" /> for performing job schedule-related operations on the associated account.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Open">
<MemberSignature Language="C#" Value="public static Microsoft.Azure.Batch.BatchClient Open (Microsoft.Azure.Batch.Auth.BatchSharedKeyCredentials credentials);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.Azure.Batch.BatchClient Open(class Microsoft.Azure.Batch.Auth.BatchSharedKeyCredentials credentials) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.BatchClient.Open(Microsoft.Azure.Batch.Auth.BatchSharedKeyCredentials)" />
<MemberSignature Language="VB.NET" Value="Public Shared Function Open (credentials As BatchSharedKeyCredentials) As BatchClient" />
<MemberSignature Language="F#" Value="static member Open : Microsoft.Azure.Batch.Auth.BatchSharedKeyCredentials -> Microsoft.Azure.Batch.BatchClient" Usage="Microsoft.Azure.Batch.BatchClient.Open credentials" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.3.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Batch.BatchClient</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="credentials" Type="Microsoft.Azure.Batch.Auth.BatchSharedKeyCredentials" />
</Parameters>
<Docs>
<param name="credentials">The Batch account credentials.</param>
<summary>
Creates an instance of <see cref="T:Microsoft.Azure.Batch.BatchClient" />.
</summary>
<returns>An instance of <see cref="T:Microsoft.Azure.Batch.Protocol.BatchServiceClient" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Open">
<MemberSignature Language="C#" Value="public static Microsoft.Azure.Batch.BatchClient Open (Microsoft.Azure.Batch.Auth.BatchTokenCredentials credentials);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.Azure.Batch.BatchClient Open(class Microsoft.Azure.Batch.Auth.BatchTokenCredentials credentials) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.BatchClient.Open(Microsoft.Azure.Batch.Auth.BatchTokenCredentials)" />
<MemberSignature Language="VB.NET" Value="Public Shared Function Open (credentials As BatchTokenCredentials) As BatchClient" />
<MemberSignature Language="F#" Value="static member Open : Microsoft.Azure.Batch.Auth.BatchTokenCredentials -> Microsoft.Azure.Batch.BatchClient" Usage="Microsoft.Azure.Batch.BatchClient.Open credentials" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.3.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Batch.BatchClient</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="credentials" Type="Microsoft.Azure.Batch.Auth.BatchTokenCredentials" />
</Parameters>
<Docs>
<param name="credentials">The Azure Active Directory Batch account credentials.</param>
<summary>
Creates an instance of <see cref="T:Microsoft.Azure.Batch.BatchClient" />.
</summary>
<returns>An instance of <see cref="T:Microsoft.Azure.Batch.Protocol.BatchServiceClient" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Open">
<MemberSignature Language="C#" Value="public static Microsoft.Azure.Batch.BatchClient Open (Microsoft.Azure.Batch.Protocol.BatchServiceClient restClient);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.Azure.Batch.BatchClient Open(class Microsoft.Azure.Batch.Protocol.BatchServiceClient restClient) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.BatchClient.Open(Microsoft.Azure.Batch.Protocol.BatchServiceClient)" />
<MemberSignature Language="VB.NET" Value="Public Shared Function Open (restClient As BatchServiceClient) As BatchClient" />
<MemberSignature Language="F#" Value="static member Open : Microsoft.Azure.Batch.Protocol.BatchServiceClient -> Microsoft.Azure.Batch.BatchClient" Usage="Microsoft.Azure.Batch.BatchClient.Open restClient" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.3.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Batch.BatchClient</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="restClient" Type="Microsoft.Azure.Batch.Protocol.BatchServiceClient" />
</Parameters>
<Docs>
<param name="restClient">The instance of <see cref="T:Microsoft.Azure.Batch.Protocol.BatchServiceClient" /> to use for all calls made to the Batch Service. It will not be disposed when BatchClient is disposed.</param>
<summary>
Blocking call that creates an instance of <see cref="T:Microsoft.Azure.Batch.BatchClient" /> associated with the specified <see cref="T:Microsoft.Azure.Batch.Protocol.BatchServiceClient" />.
</summary>
<returns>An instance of <see cref="T:Microsoft.Azure.Batch.Protocol.BatchServiceClient" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="PoolOperations">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Batch.PoolOperations PoolOperations { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Azure.Batch.PoolOperations PoolOperations" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.BatchClient.PoolOperations" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property PoolOperations As PoolOperations" />
<MemberSignature Language="F#" Value="member this.PoolOperations : Microsoft.Azure.Batch.PoolOperations" Usage="Microsoft.Azure.Batch.BatchClient.PoolOperations" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.3.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Batch.PoolOperations</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets a <see cref="P:Microsoft.Azure.Batch.BatchClient.PoolOperations" /> for performing pool-related operations on the associated account.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Utilities">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Batch.Utilities Utilities { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Azure.Batch.Utilities Utilities" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.BatchClient.Utilities" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Utilities As Utilities" />
<MemberSignature Language="F#" Value="member this.Utilities : Microsoft.Azure.Batch.Utilities" Usage="Microsoft.Azure.Batch.BatchClient.Utilities" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.3.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Batch.Utilities</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets a <see cref="P:Microsoft.Azure.Batch.BatchClient.Utilities" /> object containing utility methods for orchestrating multiple Batch operations.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>