-
Notifications
You must be signed in to change notification settings - Fork 264
/
TaskAddParameter.xml
672 lines (672 loc) · 44.3 KB
/
TaskAddParameter.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
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
<Type Name="TaskAddParameter" FullName="Microsoft.Azure.Batch.Protocol.Models.TaskAddParameter">
<TypeSignature Language="C#" Value="public class TaskAddParameter" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit TaskAddParameter extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Batch.Protocol.Models.TaskAddParameter" />
<TypeSignature Language="VB.NET" Value="Public Class TaskAddParameter" />
<TypeSignature Language="F#" Value="type TaskAddParameter = 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>
An Azure Batch Task to add.
</summary>
<remarks>
Batch will retry Tasks when a recovery operation is triggered on a
Node. Examples of recovery operations include (but are not limited to)
when an unhealthy 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 maxTaskRetryCount. Even if the
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 TaskAddParameter ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.Protocol.Models.TaskAddParameter.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.3.1.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>
Initializes a new instance of the TaskAddParameter class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public TaskAddParameter (string id, string commandLine, string displayName = default, Microsoft.Azure.Batch.Protocol.Models.TaskContainerSettings containerSettings = default, Microsoft.Azure.Batch.Protocol.Models.ExitConditions exitConditions = default, System.Collections.Generic.IList<Microsoft.Azure.Batch.Protocol.Models.ResourceFile> resourceFiles = default, System.Collections.Generic.IList<Microsoft.Azure.Batch.Protocol.Models.OutputFile> outputFiles = default, System.Collections.Generic.IList<Microsoft.Azure.Batch.Protocol.Models.EnvironmentSetting> environmentSettings = default, Microsoft.Azure.Batch.Protocol.Models.AffinityInformation affinityInfo = default, Microsoft.Azure.Batch.Protocol.Models.TaskConstraints constraints = default, int? requiredSlots = default, Microsoft.Azure.Batch.Protocol.Models.UserIdentity userIdentity = default, Microsoft.Azure.Batch.Protocol.Models.MultiInstanceSettings multiInstanceSettings = default, Microsoft.Azure.Batch.Protocol.Models.TaskDependencies dependsOn = default, System.Collections.Generic.IList<Microsoft.Azure.Batch.Protocol.Models.ApplicationPackageReference> applicationPackageReferences = default, Microsoft.Azure.Batch.Protocol.Models.AuthenticationTokenSettings authenticationTokenSettings = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string id, string commandLine, string displayName, class Microsoft.Azure.Batch.Protocol.Models.TaskContainerSettings containerSettings, class Microsoft.Azure.Batch.Protocol.Models.ExitConditions exitConditions, class System.Collections.Generic.IList`1<class Microsoft.Azure.Batch.Protocol.Models.ResourceFile> resourceFiles, class System.Collections.Generic.IList`1<class Microsoft.Azure.Batch.Protocol.Models.OutputFile> outputFiles, class System.Collections.Generic.IList`1<class Microsoft.Azure.Batch.Protocol.Models.EnvironmentSetting> environmentSettings, class Microsoft.Azure.Batch.Protocol.Models.AffinityInformation affinityInfo, class Microsoft.Azure.Batch.Protocol.Models.TaskConstraints constraints, valuetype System.Nullable`1<int32> requiredSlots, class Microsoft.Azure.Batch.Protocol.Models.UserIdentity userIdentity, class Microsoft.Azure.Batch.Protocol.Models.MultiInstanceSettings multiInstanceSettings, class Microsoft.Azure.Batch.Protocol.Models.TaskDependencies dependsOn, class System.Collections.Generic.IList`1<class Microsoft.Azure.Batch.Protocol.Models.ApplicationPackageReference> applicationPackageReferences, class Microsoft.Azure.Batch.Protocol.Models.AuthenticationTokenSettings authenticationTokenSettings) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.Protocol.Models.TaskAddParameter.#ctor(System.String,System.String,System.String,Microsoft.Azure.Batch.Protocol.Models.TaskContainerSettings,Microsoft.Azure.Batch.Protocol.Models.ExitConditions,System.Collections.Generic.IList{Microsoft.Azure.Batch.Protocol.Models.ResourceFile},System.Collections.Generic.IList{Microsoft.Azure.Batch.Protocol.Models.OutputFile},System.Collections.Generic.IList{Microsoft.Azure.Batch.Protocol.Models.EnvironmentSetting},Microsoft.Azure.Batch.Protocol.Models.AffinityInformation,Microsoft.Azure.Batch.Protocol.Models.TaskConstraints,System.Nullable{System.Int32},Microsoft.Azure.Batch.Protocol.Models.UserIdentity,Microsoft.Azure.Batch.Protocol.Models.MultiInstanceSettings,Microsoft.Azure.Batch.Protocol.Models.TaskDependencies,System.Collections.Generic.IList{Microsoft.Azure.Batch.Protocol.Models.ApplicationPackageReference},Microsoft.Azure.Batch.Protocol.Models.AuthenticationTokenSettings)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (id As String, commandLine As String, Optional displayName As String = Nothing, Optional containerSettings As TaskContainerSettings = Nothing, Optional exitConditions As ExitConditions = Nothing, Optional resourceFiles As IList(Of ResourceFile) = Nothing, Optional outputFiles As IList(Of OutputFile) = Nothing, Optional environmentSettings As IList(Of EnvironmentSetting) = Nothing, Optional affinityInfo As AffinityInformation = Nothing, Optional constraints As TaskConstraints = Nothing, Optional requiredSlots As Nullable(Of Integer) = Nothing, Optional userIdentity As UserIdentity = Nothing, Optional multiInstanceSettings As MultiInstanceSettings = Nothing, Optional dependsOn As TaskDependencies = Nothing, Optional applicationPackageReferences As IList(Of ApplicationPackageReference) = Nothing, Optional authenticationTokenSettings As AuthenticationTokenSettings = Nothing)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.Batch.Protocol.Models.TaskAddParameter : string * string * string * Microsoft.Azure.Batch.Protocol.Models.TaskContainerSettings * Microsoft.Azure.Batch.Protocol.Models.ExitConditions * System.Collections.Generic.IList<Microsoft.Azure.Batch.Protocol.Models.ResourceFile> * System.Collections.Generic.IList<Microsoft.Azure.Batch.Protocol.Models.OutputFile> * System.Collections.Generic.IList<Microsoft.Azure.Batch.Protocol.Models.EnvironmentSetting> * Microsoft.Azure.Batch.Protocol.Models.AffinityInformation * Microsoft.Azure.Batch.Protocol.Models.TaskConstraints * Nullable<int> * Microsoft.Azure.Batch.Protocol.Models.UserIdentity * Microsoft.Azure.Batch.Protocol.Models.MultiInstanceSettings * Microsoft.Azure.Batch.Protocol.Models.TaskDependencies * System.Collections.Generic.IList<Microsoft.Azure.Batch.Protocol.Models.ApplicationPackageReference> * Microsoft.Azure.Batch.Protocol.Models.AuthenticationTokenSettings -> Microsoft.Azure.Batch.Protocol.Models.TaskAddParameter" Usage="new Microsoft.Azure.Batch.Protocol.Models.TaskAddParameter (id, commandLine, displayName, containerSettings, exitConditions, resourceFiles, outputFiles, environmentSettings, affinityInfo, constraints, requiredSlots, userIdentity, multiInstanceSettings, dependsOn, applicationPackageReferences, authenticationTokenSettings)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.3.1.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="id" Type="System.String" />
<Parameter Name="commandLine" Type="System.String" />
<Parameter Name="displayName" Type="System.String" />
<Parameter Name="containerSettings" Type="Microsoft.Azure.Batch.Protocol.Models.TaskContainerSettings" />
<Parameter Name="exitConditions" Type="Microsoft.Azure.Batch.Protocol.Models.ExitConditions" />
<Parameter Name="resourceFiles" Type="System.Collections.Generic.IList<Microsoft.Azure.Batch.Protocol.Models.ResourceFile>" />
<Parameter Name="outputFiles" Type="System.Collections.Generic.IList<Microsoft.Azure.Batch.Protocol.Models.OutputFile>" />
<Parameter Name="environmentSettings" Type="System.Collections.Generic.IList<Microsoft.Azure.Batch.Protocol.Models.EnvironmentSetting>" />
<Parameter Name="affinityInfo" Type="Microsoft.Azure.Batch.Protocol.Models.AffinityInformation" />
<Parameter Name="constraints" Type="Microsoft.Azure.Batch.Protocol.Models.TaskConstraints" />
<Parameter Name="requiredSlots" Type="System.Nullable<System.Int32>" />
<Parameter Name="userIdentity" Type="Microsoft.Azure.Batch.Protocol.Models.UserIdentity" />
<Parameter Name="multiInstanceSettings" Type="Microsoft.Azure.Batch.Protocol.Models.MultiInstanceSettings" />
<Parameter Name="dependsOn" Type="Microsoft.Azure.Batch.Protocol.Models.TaskDependencies" />
<Parameter Name="applicationPackageReferences" Type="System.Collections.Generic.IList<Microsoft.Azure.Batch.Protocol.Models.ApplicationPackageReference>" />
<Parameter Name="authenticationTokenSettings" Type="Microsoft.Azure.Batch.Protocol.Models.AuthenticationTokenSettings" />
</Parameters>
<Docs>
<param name="id">A string that uniquely identifies the Task within
the Job.</param>
<param name="commandLine">The command line of the Task.</param>
<param name="displayName">A display name for the Task.</param>
<param name="containerSettings">The settings for the container
under which the Task runs.</param>
<param name="exitConditions">How the Batch service should respond
when the Task completes.</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="outputFiles">A list of files that the Batch service
will upload from the Compute Node after running the command
line.</param>
<param name="environmentSettings">A list of environment variable
settings for the Task.</param>
<param name="affinityInfo">A locality hint that can be used by the
Batch service to select a Compute Node on which to start the new
Task.</param>
<param name="constraints">The execution constraints that apply to
this Task.</param>
<param name="requiredSlots">The number of scheduling slots that the
Task required to run.</param>
<param name="userIdentity">The user identity under which the Task
runs.</param>
<param name="multiInstanceSettings">An object that indicates that
the Task is a multi-instance Task, and contains information about
how to run the multi-instance Task.</param>
<param name="dependsOn">The Tasks that this Task depends
on.</param>
<param name="applicationPackageReferences">A list of Packages that
the Batch service will deploy to the Compute Node before running
the command line.</param>
<param name="authenticationTokenSettings">The settings for an
authentication token that the Task can use to perform Batch service
operations.</param>
<summary>
Initializes a new instance of the TaskAddParameter class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AffinityInfo">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Batch.Protocol.Models.AffinityInformation AffinityInfo { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Azure.Batch.Protocol.Models.AffinityInformation AffinityInfo" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.Protocol.Models.TaskAddParameter.AffinityInfo" />
<MemberSignature Language="VB.NET" Value="Public Property AffinityInfo As AffinityInformation" />
<MemberSignature Language="F#" Value="member this.AffinityInfo : Microsoft.Azure.Batch.Protocol.Models.AffinityInformation with get, set" Usage="Microsoft.Azure.Batch.Protocol.Models.TaskAddParameter.AffinityInfo" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.3.1.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="affinityInfo")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="affinityInfo")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Microsoft.Azure.Batch.Protocol.Models.AffinityInformation</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets a locality hint that can be used by the Batch service
to select a Compute Node on which to start the new Task.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ApplicationPackageReferences">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IList<Microsoft.Azure.Batch.Protocol.Models.ApplicationPackageReference> ApplicationPackageReferences { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1<class Microsoft.Azure.Batch.Protocol.Models.ApplicationPackageReference> ApplicationPackageReferences" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.Protocol.Models.TaskAddParameter.ApplicationPackageReferences" />
<MemberSignature Language="VB.NET" Value="Public Property ApplicationPackageReferences As IList(Of ApplicationPackageReference)" />
<MemberSignature Language="F#" Value="member this.ApplicationPackageReferences : System.Collections.Generic.IList<Microsoft.Azure.Batch.Protocol.Models.ApplicationPackageReference> with get, set" Usage="Microsoft.Azure.Batch.Protocol.Models.TaskAddParameter.ApplicationPackageReferences" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.3.1.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="applicationPackageReferences")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="applicationPackageReferences")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Collections.Generic.IList<Microsoft.Azure.Batch.Protocol.Models.ApplicationPackageReference></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets a list of Packages that the Batch service will deploy
to the Compute Node before running the command line.
</summary>
<value>To be added.</value>
<remarks>
Application packages are downloaded and deployed to a shared
directory, not the Task working directory. Therefore, if a
referenced package is already on the Node, and is up to date, then
it is not re-downloaded; the existing copy on the Compute Node is
used. If a referenced Package cannot be installed, for example
because the package has been deleted or because download failed,
the Task fails.
</remarks>
</Docs>
</Member>
<Member MemberName="AuthenticationTokenSettings">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Batch.Protocol.Models.AuthenticationTokenSettings AuthenticationTokenSettings { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Azure.Batch.Protocol.Models.AuthenticationTokenSettings AuthenticationTokenSettings" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.Protocol.Models.TaskAddParameter.AuthenticationTokenSettings" />
<MemberSignature Language="VB.NET" Value="Public Property AuthenticationTokenSettings As AuthenticationTokenSettings" />
<MemberSignature Language="F#" Value="member this.AuthenticationTokenSettings : Microsoft.Azure.Batch.Protocol.Models.AuthenticationTokenSettings with get, set" Usage="Microsoft.Azure.Batch.Protocol.Models.TaskAddParameter.AuthenticationTokenSettings" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.3.1.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="authenticationTokenSettings")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="authenticationTokenSettings")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Microsoft.Azure.Batch.Protocol.Models.AuthenticationTokenSettings</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the settings for an authentication token that the Task
can use to perform Batch service operations.
</summary>
<value>To be added.</value>
<remarks>
If this property is set, the Batch service provides the Task with
an authentication token which can be used to authenticate Batch
service operations without requiring an Account access key. The
token is provided via the AZ_BATCH_AUTHENTICATION_TOKEN environment
variable. The operations that the Task can carry out using the
token depend on the settings. For example, a Task can request Job
permissions in order to add other Tasks to the Job, or check the
status of the Job or of other Tasks under the Job.
</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.Protocol.Models.TaskAddParameter.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.Protocol.Models.TaskAddParameter.CommandLine" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.3.1.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 Task.
</summary>
<value>To be added.</value>
<remarks>
For multi-instance Tasks, the command line is executed as the
primary Task, after the primary Task and all subtasks have finished
executing the coordination command line. 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 variable
(https://docs.microsoft.com/azure/batch/batch-compute-node-environment-variables).
</remarks>
</Docs>
</Member>
<Member MemberName="Constraints">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Batch.Protocol.Models.TaskConstraints Constraints { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Azure.Batch.Protocol.Models.TaskConstraints Constraints" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.Protocol.Models.TaskAddParameter.Constraints" />
<MemberSignature Language="VB.NET" Value="Public Property Constraints As TaskConstraints" />
<MemberSignature Language="F#" Value="member this.Constraints : Microsoft.Azure.Batch.Protocol.Models.TaskConstraints with get, set" Usage="Microsoft.Azure.Batch.Protocol.Models.TaskAddParameter.Constraints" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.3.1.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="constraints")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="constraints")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Microsoft.Azure.Batch.Protocol.Models.TaskConstraints</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the execution constraints that apply to this Task.
</summary>
<value>To be added.</value>
<remarks>
If you do not specify constraints, the maxTaskRetryCount is the
maxTaskRetryCount specified for the Job, the maxWallClockTime is
infinite, and the retentionTime is 7 days.
</remarks>
</Docs>
</Member>
<Member MemberName="ContainerSettings">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Batch.Protocol.Models.TaskContainerSettings ContainerSettings { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Azure.Batch.Protocol.Models.TaskContainerSettings ContainerSettings" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.Protocol.Models.TaskAddParameter.ContainerSettings" />
<MemberSignature Language="VB.NET" Value="Public Property ContainerSettings As TaskContainerSettings" />
<MemberSignature Language="F#" Value="member this.ContainerSettings : Microsoft.Azure.Batch.Protocol.Models.TaskContainerSettings with get, set" Usage="Microsoft.Azure.Batch.Protocol.Models.TaskAddParameter.ContainerSettings" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.3.1.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.Batch.Protocol.Models.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>
If the Pool that will run this Task has containerConfiguration set,
this must be set as well. If the Pool that will run this Task
doesn't have containerConfiguration set, this must not be set. 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. Files produced in the container outside
of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk,
meaning that Batch file APIs will not be able to access those
files.
</remarks>
</Docs>
</Member>
<Member MemberName="DependsOn">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Batch.Protocol.Models.TaskDependencies DependsOn { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Azure.Batch.Protocol.Models.TaskDependencies DependsOn" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.Protocol.Models.TaskAddParameter.DependsOn" />
<MemberSignature Language="VB.NET" Value="Public Property DependsOn As TaskDependencies" />
<MemberSignature Language="F#" Value="member this.DependsOn : Microsoft.Azure.Batch.Protocol.Models.TaskDependencies with get, set" Usage="Microsoft.Azure.Batch.Protocol.Models.TaskAddParameter.DependsOn" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.3.1.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="dependsOn")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="dependsOn")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Microsoft.Azure.Batch.Protocol.Models.TaskDependencies</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the Tasks that this Task depends on.
</summary>
<value>To be added.</value>
<remarks>
This Task will not be scheduled until all Tasks that it depends on
have completed successfully. If any of those Tasks fail and exhaust
their retry counts, this Task will never be scheduled. If the Job
does not have usesTaskDependencies set to true, and this element is
present, the request fails with error code
TaskDependenciesNotSpecifiedOnJob.
</remarks>
</Docs>
</Member>
<Member MemberName="DisplayName">
<MemberSignature Language="C#" Value="public string DisplayName { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string DisplayName" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.Protocol.Models.TaskAddParameter.DisplayName" />
<MemberSignature Language="VB.NET" Value="Public Property DisplayName As String" />
<MemberSignature Language="F#" Value="member this.DisplayName : string with get, set" Usage="Microsoft.Azure.Batch.Protocol.Models.TaskAddParameter.DisplayName" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.3.1.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="displayName")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="displayName")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets a display name for the Task.
</summary>
<value>To be added.</value>
<remarks>
The display name need not be unique and can contain any Unicode
characters up to a maximum length of 1024.
</remarks>
</Docs>
</Member>
<Member MemberName="EnvironmentSettings">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IList<Microsoft.Azure.Batch.Protocol.Models.EnvironmentSetting> EnvironmentSettings { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1<class Microsoft.Azure.Batch.Protocol.Models.EnvironmentSetting> EnvironmentSettings" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.Protocol.Models.TaskAddParameter.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.Protocol.Models.EnvironmentSetting> with get, set" Usage="Microsoft.Azure.Batch.Protocol.Models.TaskAddParameter.EnvironmentSettings" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.3.1.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.Batch.Protocol.Models.EnvironmentSetting></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets a list of environment variable settings for the Task.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ExitConditions">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Batch.Protocol.Models.ExitConditions ExitConditions { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Azure.Batch.Protocol.Models.ExitConditions ExitConditions" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.Protocol.Models.TaskAddParameter.ExitConditions" />
<MemberSignature Language="VB.NET" Value="Public Property ExitConditions As ExitConditions" />
<MemberSignature Language="F#" Value="member this.ExitConditions : Microsoft.Azure.Batch.Protocol.Models.ExitConditions with get, set" Usage="Microsoft.Azure.Batch.Protocol.Models.TaskAddParameter.ExitConditions" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.3.1.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="exitConditions")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="exitConditions")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Microsoft.Azure.Batch.Protocol.Models.ExitConditions</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets how the Batch service should respond when the Task
completes.
</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.Protocol.Models.TaskAddParameter.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.Protocol.Models.TaskAddParameter.Id" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.3.1.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="id")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="id")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets a string that uniquely identifies the Task within the
Job.
</summary>
<value>To be added.</value>
<remarks>
The ID can contain any combination of alphanumeric characters
including hyphens and underscores, and cannot contain more than 64
characters. The ID is case-preserving and case-insensitive (that
is, you may not have two IDs within a Job that differ only by
case).
</remarks>
</Docs>
</Member>
<Member MemberName="MultiInstanceSettings">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Batch.Protocol.Models.MultiInstanceSettings MultiInstanceSettings { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Azure.Batch.Protocol.Models.MultiInstanceSettings MultiInstanceSettings" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.Protocol.Models.TaskAddParameter.MultiInstanceSettings" />
<MemberSignature Language="VB.NET" Value="Public Property MultiInstanceSettings As MultiInstanceSettings" />
<MemberSignature Language="F#" Value="member this.MultiInstanceSettings : Microsoft.Azure.Batch.Protocol.Models.MultiInstanceSettings with get, set" Usage="Microsoft.Azure.Batch.Protocol.Models.TaskAddParameter.MultiInstanceSettings" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.3.1.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="multiInstanceSettings")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="multiInstanceSettings")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Microsoft.Azure.Batch.Protocol.Models.MultiInstanceSettings</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets an object that indicates that the Task is a
multi-instance Task, and contains information about how to run the
multi-instance Task.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OutputFiles">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IList<Microsoft.Azure.Batch.Protocol.Models.OutputFile> OutputFiles { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1<class Microsoft.Azure.Batch.Protocol.Models.OutputFile> OutputFiles" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.Protocol.Models.TaskAddParameter.OutputFiles" />
<MemberSignature Language="VB.NET" Value="Public Property OutputFiles As IList(Of OutputFile)" />
<MemberSignature Language="F#" Value="member this.OutputFiles : System.Collections.Generic.IList<Microsoft.Azure.Batch.Protocol.Models.OutputFile> with get, set" Usage="Microsoft.Azure.Batch.Protocol.Models.TaskAddParameter.OutputFiles" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.3.1.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="outputFiles")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="outputFiles")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Collections.Generic.IList<Microsoft.Azure.Batch.Protocol.Models.OutputFile></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets a list of files that the Batch service will upload
from the Compute Node after running the command line.
</summary>
<value>To be added.</value>
<remarks>
For multi-instance Tasks, the files will only be uploaded from the
Compute Node on which the primary Task is executed.
</remarks>
</Docs>
</Member>
<Member MemberName="RequiredSlots">
<MemberSignature Language="C#" Value="public int? RequiredSlots { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<int32> RequiredSlots" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.Protocol.Models.TaskAddParameter.RequiredSlots" />
<MemberSignature Language="VB.NET" Value="Public Property RequiredSlots As Nullable(Of Integer)" />
<MemberSignature Language="F#" Value="member this.RequiredSlots : Nullable<int> with get, set" Usage="Microsoft.Azure.Batch.Protocol.Models.TaskAddParameter.RequiredSlots" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.3.1.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="requiredSlots")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="requiredSlots")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<System.Int32></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the number of scheduling slots that the Task required
to run.
</summary>
<value>To be added.</value>
<remarks>
The default is 1. A Task can only be scheduled to run on a compute
node if the node has enough free scheduling slots available. For
multi-instance Tasks, this must be 1.
</remarks>
</Docs>
</Member>
<Member MemberName="ResourceFiles">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IList<Microsoft.Azure.Batch.Protocol.Models.ResourceFile> ResourceFiles { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1<class Microsoft.Azure.Batch.Protocol.Models.ResourceFile> ResourceFiles" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.Protocol.Models.TaskAddParameter.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.Protocol.Models.ResourceFile> with get, set" Usage="Microsoft.Azure.Batch.Protocol.Models.TaskAddParameter.ResourceFiles" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.3.1.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.Batch.Protocol.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>
For multi-instance Tasks, the resource files will only be
downloaded to the Compute Node on which the primary Task is
executed. 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 ResourceFiles 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.Protocol.Models.UserIdentity UserIdentity { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Azure.Batch.Protocol.Models.UserIdentity UserIdentity" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.Protocol.Models.TaskAddParameter.UserIdentity" />
<MemberSignature Language="VB.NET" Value="Public Property UserIdentity As UserIdentity" />
<MemberSignature Language="F#" Value="member this.UserIdentity : Microsoft.Azure.Batch.Protocol.Models.UserIdentity with get, set" Usage="Microsoft.Azure.Batch.Protocol.Models.TaskAddParameter.UserIdentity" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.3.1.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.Batch.Protocol.Models.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>
</Members>
</Type>