-
Notifications
You must be signed in to change notification settings - Fork 255
/
StartTask.xml
359 lines (359 loc) · 22.3 KB
/
StartTask.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
<Type Name="StartTask" FullName="Microsoft.Azure.Management.Batch.Models.StartTask">
<TypeSignature Language="C#" Value="public class StartTask" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit StartTask extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Management.Batch.Models.StartTask" />
<TypeSignature Language="VB.NET" Value="Public Class StartTask" />
<TypeSignature Language="F#" Value="type StartTask = 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 task which is run when a compute node joins a pool in the Azure Batch
service, or when the compute node is rebooted or reimaged.
</summary>
<remarks>
In some cases the start task may be re-run even though the node was not
rebooted. Due to this, start tasks should be idempotent and exit
gracefully if the setup they're performing has already been done.
Special care should be taken to avoid start tasks which create
breakaway process or install/launch services from the start task
working directory, as this will block Batch from being able to re-run
the start task.
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public StartTask ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Management.Batch.Models.StartTask.#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 StartTask class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public StartTask (string commandLine = default, System.Collections.Generic.IList<Microsoft.Azure.Management.Batch.Models.ResourceFile> resourceFiles = default, System.Collections.Generic.IList<Microsoft.Azure.Management.Batch.Models.EnvironmentSetting> environmentSettings = default, Microsoft.Azure.Management.Batch.Models.UserIdentity userIdentity = default, int? maxTaskRetryCount = default, bool? waitForSuccess = default, Microsoft.Azure.Management.Batch.Models.TaskContainerSettings containerSettings = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string commandLine, class System.Collections.Generic.IList`1<class Microsoft.Azure.Management.Batch.Models.ResourceFile> resourceFiles, class System.Collections.Generic.IList`1<class Microsoft.Azure.Management.Batch.Models.EnvironmentSetting> environmentSettings, class Microsoft.Azure.Management.Batch.Models.UserIdentity userIdentity, valuetype System.Nullable`1<int32> maxTaskRetryCount, valuetype System.Nullable`1<bool> waitForSuccess, class Microsoft.Azure.Management.Batch.Models.TaskContainerSettings containerSettings) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Management.Batch.Models.StartTask.#ctor(System.String,System.Collections.Generic.IList{Microsoft.Azure.Management.Batch.Models.ResourceFile},System.Collections.Generic.IList{Microsoft.Azure.Management.Batch.Models.EnvironmentSetting},Microsoft.Azure.Management.Batch.Models.UserIdentity,System.Nullable{System.Int32},System.Nullable{System.Boolean},Microsoft.Azure.Management.Batch.Models.TaskContainerSettings)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (Optional commandLine As String = Nothing, Optional resourceFiles As IList(Of ResourceFile) = Nothing, Optional environmentSettings As IList(Of EnvironmentSetting) = Nothing, Optional userIdentity As UserIdentity = Nothing, Optional maxTaskRetryCount As Nullable(Of Integer) = Nothing, Optional waitForSuccess As Nullable(Of Boolean) = Nothing, Optional containerSettings As TaskContainerSettings = Nothing)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.Management.Batch.Models.StartTask : string * System.Collections.Generic.IList<Microsoft.Azure.Management.Batch.Models.ResourceFile> * System.Collections.Generic.IList<Microsoft.Azure.Management.Batch.Models.EnvironmentSetting> * Microsoft.Azure.Management.Batch.Models.UserIdentity * Nullable<int> * Nullable<bool> * Microsoft.Azure.Management.Batch.Models.TaskContainerSettings -> Microsoft.Azure.Management.Batch.Models.StartTask" Usage="new Microsoft.Azure.Management.Batch.Models.StartTask (commandLine, resourceFiles, environmentSettings, userIdentity, maxTaskRetryCount, waitForSuccess, containerSettings)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.Batch</AssemblyName>
<AssemblyVersion>14.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="commandLine" Type="System.String" />
<Parameter Name="resourceFiles" Type="System.Collections.Generic.IList<Microsoft.Azure.Management.Batch.Models.ResourceFile>" />
<Parameter Name="environmentSettings" Type="System.Collections.Generic.IList<Microsoft.Azure.Management.Batch.Models.EnvironmentSetting>" />
<Parameter Name="userIdentity" Type="Microsoft.Azure.Management.Batch.Models.UserIdentity" />
<Parameter Name="maxTaskRetryCount" Type="System.Nullable<System.Int32>" />
<Parameter Name="waitForSuccess" Type="System.Nullable<System.Boolean>" />
<Parameter Name="containerSettings" Type="Microsoft.Azure.Management.Batch.Models.TaskContainerSettings" />
</Parameters>
<Docs>
<param name="commandLine">The command line of the start
task.</param>
<param name="resourceFiles">A list of files that the Batch service
will download to the compute node before running the command
line.</param>
<param name="environmentSettings">A list of environment variable
settings for the start task.</param>
<param name="userIdentity">The user identity under which the start
task runs.</param>
<param name="maxTaskRetryCount">The maximum number of times the
task may be retried.</param>
<param name="waitForSuccess">Whether the Batch service should wait
for the start task to complete successfully (that is, to exit with
exit code 0) before scheduling any tasks on the compute
node.</param>
<param name="containerSettings">The settings for the container
under which the start task runs.</param>
<summary>
Initializes a new instance of the StartTask class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CommandLine">
<MemberSignature Language="C#" Value="public string CommandLine { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string CommandLine" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.Batch.Models.StartTask.CommandLine" />
<MemberSignature Language="VB.NET" Value="Public Property CommandLine As String" />
<MemberSignature Language="F#" Value="member this.CommandLine : string with get, set" Usage="Microsoft.Azure.Management.Batch.Models.StartTask.CommandLine" />
<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="commandLine")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="commandLine")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the command line of the start task.
</summary>
<value>To be added.</value>
<remarks>
The command line does not run under a shell, and therefore cannot
take advantage of shell features such as environment variable
expansion. If you want to take advantage of such features, you
should invoke the shell in the command line, for example using "cmd
/c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux.
Required if any other properties of the startTask are specified.
</remarks>
</Docs>
</Member>
<Member MemberName="ContainerSettings">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Management.Batch.Models.TaskContainerSettings ContainerSettings { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Azure.Management.Batch.Models.TaskContainerSettings ContainerSettings" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.Batch.Models.StartTask.ContainerSettings" />
<MemberSignature Language="VB.NET" Value="Public Property ContainerSettings As TaskContainerSettings" />
<MemberSignature Language="F#" Value="member this.ContainerSettings : Microsoft.Azure.Management.Batch.Models.TaskContainerSettings with get, set" Usage="Microsoft.Azure.Management.Batch.Models.StartTask.ContainerSettings" />
<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="containerSettings")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="containerSettings")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Microsoft.Azure.Management.Batch.Models.TaskContainerSettings</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the settings for the container under which the start
task runs.
</summary>
<value>To be added.</value>
<remarks>
When this is specified, all directories recursively below the
AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the
node) are mapped into the container, all task environment variables
are mapped into the container, and the task command line is
executed in the container.
</remarks>
</Docs>
</Member>
<Member MemberName="EnvironmentSettings">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IList<Microsoft.Azure.Management.Batch.Models.EnvironmentSetting> EnvironmentSettings { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1<class Microsoft.Azure.Management.Batch.Models.EnvironmentSetting> EnvironmentSettings" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.Batch.Models.StartTask.EnvironmentSettings" />
<MemberSignature Language="VB.NET" Value="Public Property EnvironmentSettings As IList(Of EnvironmentSetting)" />
<MemberSignature Language="F#" Value="member this.EnvironmentSettings : System.Collections.Generic.IList<Microsoft.Azure.Management.Batch.Models.EnvironmentSetting> with get, set" Usage="Microsoft.Azure.Management.Batch.Models.StartTask.EnvironmentSettings" />
<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="environmentSettings")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="environmentSettings")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Collections.Generic.IList<Microsoft.Azure.Management.Batch.Models.EnvironmentSetting></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets a list of environment variable settings for the start
task.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="MaxTaskRetryCount">
<MemberSignature Language="C#" Value="public int? MaxTaskRetryCount { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<int32> MaxTaskRetryCount" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.Batch.Models.StartTask.MaxTaskRetryCount" />
<MemberSignature Language="VB.NET" Value="Public Property MaxTaskRetryCount As Nullable(Of Integer)" />
<MemberSignature Language="F#" Value="member this.MaxTaskRetryCount : Nullable<int> with get, set" Usage="Microsoft.Azure.Management.Batch.Models.StartTask.MaxTaskRetryCount" />
<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="maxTaskRetryCount")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="maxTaskRetryCount")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<System.Int32></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the maximum number of times the task may be retried.
</summary>
<value>To be added.</value>
<remarks>
The Batch service retries a task if its exit code is nonzero. Note
that this value specifically controls the number of retries. The
Batch service will try the task once, and may then retry up to this
limit. For example, if the maximum retry count is 3, Batch tries
the task up to 4 times (one initial try and 3 retries). If the
maximum retry count is 0, the Batch service does not retry the
task. If the maximum retry count is -1, the Batch service retries
the task without limit.
</remarks>
</Docs>
</Member>
<Member MemberName="ResourceFiles">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IList<Microsoft.Azure.Management.Batch.Models.ResourceFile> ResourceFiles { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1<class Microsoft.Azure.Management.Batch.Models.ResourceFile> ResourceFiles" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.Batch.Models.StartTask.ResourceFiles" />
<MemberSignature Language="VB.NET" Value="Public Property ResourceFiles As IList(Of ResourceFile)" />
<MemberSignature Language="F#" Value="member this.ResourceFiles : System.Collections.Generic.IList<Microsoft.Azure.Management.Batch.Models.ResourceFile> with get, set" Usage="Microsoft.Azure.Management.Batch.Models.StartTask.ResourceFiles" />
<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="resourceFiles")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="resourceFiles")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Collections.Generic.IList<Microsoft.Azure.Management.Batch.Models.ResourceFile></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets a list of files that the Batch service will download
to the compute node before running the command line.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="UserIdentity">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Management.Batch.Models.UserIdentity UserIdentity { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Azure.Management.Batch.Models.UserIdentity UserIdentity" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.Batch.Models.StartTask.UserIdentity" />
<MemberSignature Language="VB.NET" Value="Public Property UserIdentity As UserIdentity" />
<MemberSignature Language="F#" Value="member this.UserIdentity : Microsoft.Azure.Management.Batch.Models.UserIdentity with get, set" Usage="Microsoft.Azure.Management.Batch.Models.StartTask.UserIdentity" />
<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="userIdentity")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="userIdentity")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Microsoft.Azure.Management.Batch.Models.UserIdentity</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the user identity under which the start task runs.
</summary>
<value>To be added.</value>
<remarks>
If omitted, the task runs as a non-administrative user unique to
the task.
</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.StartTask.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="startTask.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>
<Member MemberName="WaitForSuccess">
<MemberSignature Language="C#" Value="public bool? WaitForSuccess { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<bool> WaitForSuccess" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.Batch.Models.StartTask.WaitForSuccess" />
<MemberSignature Language="VB.NET" Value="Public Property WaitForSuccess As Nullable(Of Boolean)" />
<MemberSignature Language="F#" Value="member this.WaitForSuccess : Nullable<bool> with get, set" Usage="Microsoft.Azure.Management.Batch.Models.StartTask.WaitForSuccess" />
<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="waitForSuccess")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="waitForSuccess")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<System.Boolean></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets whether the Batch service should wait for the start
task to complete successfully (that is, to exit with exit code 0)
before scheduling any tasks on the compute node.
</summary>
<value>To be added.</value>
<remarks>
If true and the start task fails on a compute node, the Batch
service retries the start task up to its maximum retry count
(maxTaskRetryCount). If the task has still not completed
successfully after all retries, then the Batch service marks the
compute node unusable, and will not schedule tasks to it. This
condition can be detected via the node state and scheduling error
detail. If false, the Batch service will not wait for the start
task to complete. In this case, other tasks can start executing on
the compute node while the start task is still running; and even if
the start task fails, new tasks will continue to be scheduled on
the node. The default is true.
</remarks>
</Docs>
</Member>
</Members>
</Type>