-
Notifications
You must be signed in to change notification settings - Fork 255
/
JobPreparationTask.xml
301 lines (301 loc) · 17.4 KB
/
JobPreparationTask.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
<Type Name="JobPreparationTask" FullName="Microsoft.Azure.Batch.JobPreparationTask">
<TypeSignature Language="C#" Value="public class JobPreparationTask" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit JobPreparationTask extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Batch.JobPreparationTask" />
<TypeSignature Language="VB.NET" Value="Public Class JobPreparationTask" />
<TypeSignature Language="F#" Value="type JobPreparationTask = 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 Job Preparation task to run before any tasks of the job on any given compute node.
</summary>
<remarks>
Batch will retry tasks when a recovery operation is triggered on a compute node. Examples of recovery operations
include (but are not limited to) when an unhealthy compute node is rebooted or a compute node disappeared due to
host failure. Retries due to recovery operations are independent of and are not counted against the <see cref="P:Microsoft.Azure.Batch.TaskConstraints.MaxTaskRetryCount" />. Even if the <see cref="P:Microsoft.Azure.Batch.TaskConstraints.MaxTaskRetryCount" /> is 0, an internal retry due to a recovery operation
may occur. Because of this, all tasks should be idempotent. This means tasks need to tolerate being interrupted and
restarted without causing any corruption or duplicate data. The best practice for long running tasks is to use some
form of checkpointing.
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public JobPreparationTask ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.JobPreparationTask.#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 <see cref="T:Microsoft.Azure.Batch.JobPreparationTask" /> class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public JobPreparationTask (string commandLine);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string commandLine) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.JobPreparationTask.#ctor(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (commandLine As String)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.Batch.JobPreparationTask : string -> Microsoft.Azure.Batch.JobPreparationTask" Usage="new Microsoft.Azure.Batch.JobPreparationTask commandLine" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="commandLine" Type="System.String" />
</Parameters>
<Docs>
<param name="commandLine">The command line of the task.</param>
<summary>
Initializes a new instance of the <see cref="T:Microsoft.Azure.Batch.JobPreparationTask" /> 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.Batch.JobPreparationTask.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.Batch.JobPreparationTask.CommandLine" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the command line of the 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. If the command line
refers to file paths, it should use a relative path (relative to the task working directory), or use the Batch
provided environment variables (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables).
</remarks>
</Docs>
</Member>
<Member MemberName="Constraints">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Batch.TaskConstraints Constraints { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Azure.Batch.TaskConstraints Constraints" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.JobPreparationTask.Constraints" />
<MemberSignature Language="VB.NET" Value="Public Property Constraints As TaskConstraints" />
<MemberSignature Language="F#" Value="member this.Constraints : Microsoft.Azure.Batch.TaskConstraints with get, set" Usage="Microsoft.Azure.Batch.JobPreparationTask.Constraints" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Batch.TaskConstraints</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the execution constraints provided by the user for this Job Preparation task.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ContainerSettings">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Batch.TaskContainerSettings ContainerSettings { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Azure.Batch.TaskContainerSettings ContainerSettings" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.JobPreparationTask.ContainerSettings" />
<MemberSignature Language="VB.NET" Value="Public Property ContainerSettings As TaskContainerSettings" />
<MemberSignature Language="F#" Value="member this.ContainerSettings : Microsoft.Azure.Batch.TaskContainerSettings with get, set" Usage="Microsoft.Azure.Batch.JobPreparationTask.ContainerSettings" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Batch.TaskContainerSettings</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the settings for the container under which the 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.Batch.EnvironmentSetting> EnvironmentSettings { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1<class Microsoft.Azure.Batch.EnvironmentSetting> EnvironmentSettings" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.JobPreparationTask.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.Batch.EnvironmentSetting> with get, set" Usage="Microsoft.Azure.Batch.JobPreparationTask.EnvironmentSettings" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IList<Microsoft.Azure.Batch.EnvironmentSetting></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the collection of EnvironmentSetting instances.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Id">
<MemberSignature Language="C#" Value="public string Id { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Id" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.JobPreparationTask.Id" />
<MemberSignature Language="VB.NET" Value="Public Property Id As String" />
<MemberSignature Language="F#" Value="member this.Id : string with get, set" Usage="Microsoft.Azure.Batch.JobPreparationTask.Id" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the id of the task.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="RerunOnComputeNodeRebootAfterSuccess">
<MemberSignature Language="C#" Value="public bool? RerunOnComputeNodeRebootAfterSuccess { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<bool> RerunOnComputeNodeRebootAfterSuccess" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.JobPreparationTask.RerunOnComputeNodeRebootAfterSuccess" />
<MemberSignature Language="VB.NET" Value="Public Property RerunOnComputeNodeRebootAfterSuccess As Nullable(Of Boolean)" />
<MemberSignature Language="F#" Value="member this.RerunOnComputeNodeRebootAfterSuccess : Nullable<bool> with get, set" Usage="Microsoft.Azure.Batch.JobPreparationTask.RerunOnComputeNodeRebootAfterSuccess" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<System.Boolean></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets whether the Batch service should rerun the Job Preparation task after a compute node reboots.
</summary>
<value>To be added.</value>
<remarks>
The Job Preparation task is always rerun if a compute node is reimaged, or if the Job Preparation task did not
complete (e.g. because the reboot occurred while the task was running). Therefore, you should always write a
Job Preparation task to be idempotent and to behave correctly if run multiple times. If this property is not
specified, a default value of true is assigned by the Batch service.
</remarks>
</Docs>
</Member>
<Member MemberName="ResourceFiles">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IList<Microsoft.Azure.Batch.ResourceFile> ResourceFiles { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1<class Microsoft.Azure.Batch.ResourceFile> ResourceFiles" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.JobPreparationTask.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.Batch.ResourceFile> with get, set" Usage="Microsoft.Azure.Batch.JobPreparationTask.ResourceFiles" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IList<Microsoft.Azure.Batch.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>
There is a maximum size for the list of resource files. When the max size is exceeded, the request will fail
and the response error code will be RequestEntityTooLarge. If this occurs, the collection of resource files must
be reduced in size. This can be achieved using .zip files, Application Packages, or Docker Containers.
</remarks>
</Docs>
</Member>
<Member MemberName="UserIdentity">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Batch.UserIdentity UserIdentity { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Azure.Batch.UserIdentity UserIdentity" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.JobPreparationTask.UserIdentity" />
<MemberSignature Language="VB.NET" Value="Public Property UserIdentity As UserIdentity" />
<MemberSignature Language="F#" Value="member this.UserIdentity : Microsoft.Azure.Batch.UserIdentity with get, set" Usage="Microsoft.Azure.Batch.JobPreparationTask.UserIdentity" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Batch.UserIdentity</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the user identity under which the 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="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.Batch.JobPreparationTask.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.Batch.JobPreparationTask.WaitForSuccess" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<System.Boolean></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets whether the Batch service should wait for the successful completion of the Job Preparation task
before scheduling any tasks on the compute node.
</summary>
<value>To be added.</value>
<remarks>
A Job Preparation task execution is considered successful if its ExitCode is 0. If this property is not specified,
a default value of true is assigned by the Batch service.
</remarks>
</Docs>
</Member>
</Members>
</Type>