forked from MicrosoftDocs/azure-docs-cli
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathtask.pycliyml
More file actions
619 lines (619 loc) · 24.3 KB
/
task.pycliyml
File metadata and controls
619 lines (619 loc) · 24.3 KB
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
commandList:
- name: az batch task create
description: Creates a single Batch task or multiple Batch tasks.
href: task#create
- name: az batch task delete
description: Deletes a task from the specified job.
href: task#delete
- name: az batch task file
description: Commands to manage your Batch task files.
href: task/file
isGroup: true
- name: az batch task file delete
description: Deletes the specified task file from the compute node where the task ran.
href: task/file#delete
- name: az batch task file download
description: Downloads the content of the specified task file.
href: task/file#download
- name: az batch task file list
description: Lists the files in a task's directory on its compute node.
href: task/file#list
- name: az batch task file show
description: Gets the properties of the specified task file.
href: task/file#show
- name: az batch task list
description: Lists all of the tasks that are associated with the specified job.
href: task#list
- name: az batch task reactivate
description: Reactivates the specified task.
href: task#reactivate
- name: az batch task reset
description: Updates the properties of the specified task. All updatable properties are replaced with the values specified or reset if unspecified.
href: task#reset
- name: az batch task show
description: Gets information about the specified task.
href: task#show
- name: az batch task stop
description: Terminates the specified task.
href: task#stop
- name: az batch task subtask
description: Commands to manage subtask information of your Batch task.
href: task/subtask
isGroup: true
- name: az batch task subtask list
description: Lists all of the subtasks that are associated with the specified multi-instance task.
href: task/subtask#list
htmlId: task
examples: []
source:
remote:
path: src/command_modules/azure-cli-batch/azure/cli/command_modules/batch/_help.py
branch: master
repo: https://github.com/Azure/azure-cli.git
children:
- commandList: []
htmlId: create
examples: []
parameters:
- name: --job-id
isRequired: True
summary: The ID of the job containing the task.
description: ''
- name: --affinity-info
isRequired: False
summary: A locality hint that can be used by the Batch service to select a compute node on which to start the new task.
description: ''
- name: --application-package-references
isRequired: False
summary: The space separated list of IDs specifying the application packages to be installed. Space separated application IDs with optional version in 'id[#version]' format.
description: ''
- name: --command-line
isRequired: False
summary: The command line of the task. 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.
description: ''
- name: --environment-settings
isRequired: False
summary: A list of environment variable settings for the task. Space separated values in 'key=value' format.
description: ''
- name: --json-file
isRequired: False
summary: The file containing the task(s) to create in JSON format, if this parameter is specified, all other parameters are ignored.
description: ''
- name: --max-task-retry-count
isRequired: False
summary: The maximum number of times the task may be retried. The Batch service retries a task if its exit code is nonzero.
description: ''
- name: --max-wall-clock-time
isRequired: False
summary: The maximum elapsed time that the task may run, measured from the time the task starts. If the task does not complete within the time limit, the Batch service terminates it.
description: ''
- name: --resource-files
isRequired: False
summary: A list of files that the Batch service will download to the compute node before running the command line. Space separated resource references in filename=blobsource format.
description: ''
- name: --retention-time
isRequired: False
summary: The minimum time to retain the working directory for the task on the compute node where it ran, from the time it completes execution. After this time, the Batch service may delete the working directory and all its contents. The default is infinite.
description: ''
- name: --run-elevated
isRequired: False
summary: Whether to run the task in elevated mode. True if flag present, otherwise defaults to False.
description: ''
- name: --task-id
isRequired: False
summary: The ID of the task.
description: ''
- name: --account-endpoint
isRequired: False
summary: 'Batch service endpoint. Alternatively, set by environment variable: AZURE_BATCH_ENDPOINT.'
description: ''
- name: --account-key
isRequired: False
summary: 'The Batch account key. Alternatively, set by environment variable: AZURE_BATCH_ACCESS_KEY.'
description: ''
- name: --account-name
isRequired: False
summary: 'The Batch account name. Alternatively, set by environment variable: AZURE_BATCH_ACCOUNT.'
description: ''
- name: --debug
isRequired: False
summary: Increase logging verbosity to show all debug logs.
description: ''
- name: --help -h
isRequired: False
summary: Show this help message and exit.
description: ''
- name: --output -o
isRequired: False
summary: Output format.
description: ''
defaultValue: json
parameterValueGroup: json, jsonc, table, tsv
- name: --query
isRequired: False
summary: JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.
description: ''
- name: --verbose
isRequired: False
summary: Increase logging verbosity. Use --debug for full debug logs.
description: ''
source:
remote:
path: src/command_modules/azure-cli-batch/azure/cli/command_modules/batch/_help.py
branch: master
repo: https://github.com/Azure/azure-cli.git
children: []
uid: az_batch_task_create
name: az batch task create
description: ''
summary: Creates a single Batch task or multiple Batch tasks.
Metadata: {}
- commandList: []
htmlId: delete
examples: []
parameters:
- name: --job-id
isRequired: True
summary: The id of the job from which to delete the task.
description: ''
- name: --task-id
isRequired: True
summary: The id of the task to delete.
description: ''
- name: --yes -y
isRequired: False
summary: Do not prompt for confirmation.
description: ''
- name: --account-endpoint
isRequired: False
summary: 'Batch service endpoint. Alternatively, set by environment variable: AZURE_BATCH_ENDPOINT.'
description: ''
- name: --account-key
isRequired: False
summary: 'Batch account key. Alternatively, set by environment variable: AZURE_BATCH_ACCESS_KEY.'
description: ''
- name: --account-name
isRequired: False
summary: 'Batch account name. Alternatively, set by environment variable: AZURE_BATCH_ACCOUNT.'
description: ''
- name: --if-match
isRequired: False
summary: An ETag is specified. Specify this header to perform the operation only if the resource's ETag is an exact match as specified.
description: ''
- name: --if-modified-since
isRequired: False
summary: Specify this header to perform the operation only if the resource has been modified since the specified date/time.
description: ''
- name: --if-none-match
isRequired: False
summary: An ETag is specified. Specify this header to perform the operation only if the resource's ETag does not match the specified ETag.
description: ''
- name: --if-unmodified-since
isRequired: False
summary: Specify this header to perform the operation only if the resource has not been modified since the specified date/time.
description: ''
- name: --debug
isRequired: False
summary: Increase logging verbosity to show all debug logs.
description: ''
- name: --help -h
isRequired: False
summary: Show this help message and exit.
description: ''
- name: --output -o
isRequired: False
summary: Output format.
description: ''
defaultValue: json
parameterValueGroup: json, jsonc, table, tsv
- name: --query
isRequired: False
summary: JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.
description: ''
- name: --verbose
isRequired: False
summary: Increase logging verbosity. Use --debug for full debug logs.
description: ''
source:
remote:
path: src/command_modules/azure-cli-batch/azure/cli/command_modules/batch/_help.py
branch: master
repo: https://github.com/Azure/azure-cli.git
children: []
uid: az_batch_task_delete
name: az batch task delete
description: ''
summary: Deletes a task from the specified job.
Metadata: {}
- commandList: []
htmlId: list
examples: []
parameters:
- name: --job-id
isRequired: True
summary: The id of the job.
description: ''
- name: --account-endpoint
isRequired: False
summary: 'Batch service endpoint. Alternatively, set by environment variable: AZURE_BATCH_ENDPOINT.'
description: ''
- name: --account-key
isRequired: False
summary: 'Batch account key. Alternatively, set by environment variable: AZURE_BATCH_ACCESS_KEY.'
description: ''
- name: --account-name
isRequired: False
summary: 'Batch account name. Alternatively, set by environment variable: AZURE_BATCH_ACCOUNT.'
description: ''
- name: --expand
isRequired: False
summary: An OData $expand clause.
description: ''
- name: --filter
isRequired: False
summary: An OData $filter clause.
description: ''
- name: --select
isRequired: False
summary: An OData $select clause.
description: ''
- name: --debug
isRequired: False
summary: Increase logging verbosity to show all debug logs.
description: ''
- name: --help -h
isRequired: False
summary: Show this help message and exit.
description: ''
- name: --output -o
isRequired: False
summary: Output format.
description: ''
defaultValue: json
parameterValueGroup: json, jsonc, table, tsv
- name: --query
isRequired: False
summary: JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.
description: ''
- name: --verbose
isRequired: False
summary: Increase logging verbosity. Use --debug for full debug logs.
description: ''
source:
remote:
path: src/command_modules/azure-cli-batch/azure/cli/command_modules/batch/_help.py
branch: master
repo: https://github.com/Azure/azure-cli.git
children: []
uid: az_batch_task_list
name: az batch task list
description: ''
summary: Lists all of the tasks that are associated with the specified job.
Metadata: {}
- commandList: []
htmlId: reactivate
examples: []
parameters:
- name: --job-id
isRequired: True
summary: The id of the job containing the task.
description: ''
- name: --task-id
isRequired: True
summary: The id of the task to reactivate.
description: ''
- name: --account-endpoint
isRequired: False
summary: 'Batch service endpoint. Alternatively, set by environment variable: AZURE_BATCH_ENDPOINT.'
description: ''
- name: --account-key
isRequired: False
summary: 'Batch account key. Alternatively, set by environment variable: AZURE_BATCH_ACCESS_KEY.'
description: ''
- name: --account-name
isRequired: False
summary: 'Batch account name. Alternatively, set by environment variable: AZURE_BATCH_ACCOUNT.'
description: ''
- name: --if-match
isRequired: False
summary: An ETag is specified. Specify this header to perform the operation only if the resource's ETag is an exact match as specified.
description: ''
- name: --if-modified-since
isRequired: False
summary: Specify this header to perform the operation only if the resource has been modified since the specified date/time.
description: ''
- name: --if-none-match
isRequired: False
summary: An ETag is specified. Specify this header to perform the operation only if the resource's ETag does not match the specified ETag.
description: ''
- name: --if-unmodified-since
isRequired: False
summary: Specify this header to perform the operation only if the resource has not been modified since the specified date/time.
description: ''
- name: --debug
isRequired: False
summary: Increase logging verbosity to show all debug logs.
description: ''
- name: --help -h
isRequired: False
summary: Show this help message and exit.
description: ''
- name: --output -o
isRequired: False
summary: Output format.
description: ''
defaultValue: json
parameterValueGroup: json, jsonc, table, tsv
- name: --query
isRequired: False
summary: JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.
description: ''
- name: --verbose
isRequired: False
summary: Increase logging verbosity. Use --debug for full debug logs.
description: ''
source:
remote:
path: src/command_modules/azure-cli-batch/azure/cli/command_modules/batch/_help.py
branch: master
repo: https://github.com/Azure/azure-cli.git
children: []
uid: az_batch_task_reactivate
name: az batch task reactivate
description: Reactivation makes a task eligible to be retried again up to its maximum retry count. This will fail for tasks that are not completed or that previously completed successfully (with an exit code of 0). Additionally, this will fail if the job has completed (or is terminating or deleting).
summary: Reactivates the specified task.
Metadata: {}
- commandList: []
htmlId: reset
examples: []
parameters:
- name: --job-id
isRequired: True
summary: The id of the job containing the task.
description: ''
- name: --task-id
isRequired: True
summary: The id of the task to update.
description: ''
- name: --json-file
isRequired: False
summary: A file containing the constraints specification in JSON format. If this parameter is specified, all 'Constraints Arguments' are ignored.
description: ''
- name: --account-endpoint
isRequired: False
summary: 'Batch service endpoint. Alternatively, set by environment variable: AZURE_BATCH_ENDPOINT.'
description: ''
- name: --account-key
isRequired: False
summary: 'Batch account key. Alternatively, set by environment variable: AZURE_BATCH_ACCESS_KEY.'
description: ''
- name: --account-name
isRequired: False
summary: 'Batch account name. Alternatively, set by environment variable: AZURE_BATCH_ACCOUNT.'
description: ''
- name: --max-task-retry-count
isRequired: False
summary: The maximum number of times the task may be retried. The Batch service retries a task if its exit code is nonzero.
description: ''
- name: --max-wall-clock-time
isRequired: False
summary: The maximum elapsed time that the task may run, measured from the time the task starts. If the task does not complete within the time limit, the Batch service terminates it. Expected format is an ISO-8601 duration.
description: ''
- name: --retention-time
isRequired: False
summary: The minimum time to retain the working directory for the task on the compute node where it ran, from the time it completes execution. After this time, the Batch service may delete the working directory and all its contents. The default is infinite. Expected format is an ISO-8601 duration.
description: ''
- name: --if-match
isRequired: False
summary: An ETag is specified. Specify this header to perform the operation only if the resource's ETag is an exact match as specified.
description: ''
- name: --if-modified-since
isRequired: False
summary: Specify this header to perform the operation only if the resource has been modified since the specified date/time.
description: ''
- name: --if-none-match
isRequired: False
summary: An ETag is specified. Specify this header to perform the operation only if the resource's ETag does not match the specified ETag.
description: ''
- name: --if-unmodified-since
isRequired: False
summary: Specify this header to perform the operation only if the resource has not been modified since the specified date/time.
description: ''
- name: --debug
isRequired: False
summary: Increase logging verbosity to show all debug logs.
description: ''
- name: --help -h
isRequired: False
summary: Show this help message and exit.
description: ''
- name: --output -o
isRequired: False
summary: Output format.
description: ''
defaultValue: json
parameterValueGroup: json, jsonc, table, tsv
- name: --query
isRequired: False
summary: JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.
description: ''
- name: --verbose
isRequired: False
summary: Increase logging verbosity. Use --debug for full debug logs.
description: ''
source:
remote:
path: src/command_modules/azure-cli-batch/azure/cli/command_modules/batch/_help.py
branch: master
repo: https://github.com/Azure/azure-cli.git
children: []
uid: az_batch_task_reset
name: az batch task reset
description: ''
summary: Updates the properties of the specified task. All updatable properties are replaced with the values specified or reset if unspecified.
Metadata: {}
- commandList: []
htmlId: show
examples: []
parameters:
- name: --job-id
isRequired: True
summary: The id of the job that contains the task.
description: ''
- name: --task-id
isRequired: True
summary: The id of the task to get information about.
description: ''
- name: --account-endpoint
isRequired: False
summary: 'Batch service endpoint. Alternatively, set by environment variable: AZURE_BATCH_ENDPOINT.'
description: ''
- name: --account-key
isRequired: False
summary: 'Batch account key. Alternatively, set by environment variable: AZURE_BATCH_ACCESS_KEY.'
description: ''
- name: --account-name
isRequired: False
summary: 'Batch account name. Alternatively, set by environment variable: AZURE_BATCH_ACCOUNT.'
description: ''
- name: --expand
isRequired: False
summary: An OData $expand clause.
description: ''
- name: --if-match
isRequired: False
summary: An ETag is specified. Specify this header to perform the operation only if the resource's ETag is an exact match as specified.
description: ''
- name: --if-modified-since
isRequired: False
summary: Specify this header to perform the operation only if the resource has been modified since the specified date/time.
description: ''
- name: --if-none-match
isRequired: False
summary: An ETag is specified. Specify this header to perform the operation only if the resource's ETag does not match the specified ETag.
description: ''
- name: --if-unmodified-since
isRequired: False
summary: Specify this header to perform the operation only if the resource has not been modified since the specified date/time.
description: ''
- name: --select
isRequired: False
summary: An OData $select clause.
description: ''
- name: --debug
isRequired: False
summary: Increase logging verbosity to show all debug logs.
description: ''
- name: --help -h
isRequired: False
summary: Show this help message and exit.
description: ''
- name: --output -o
isRequired: False
summary: Output format.
description: ''
defaultValue: json
parameterValueGroup: json, jsonc, table, tsv
- name: --query
isRequired: False
summary: JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.
description: ''
- name: --verbose
isRequired: False
summary: Increase logging verbosity. Use --debug for full debug logs.
description: ''
source:
remote:
path: src/command_modules/azure-cli-batch/azure/cli/command_modules/batch/_help.py
branch: master
repo: https://github.com/Azure/azure-cli.git
children: []
uid: az_batch_task_show
name: az batch task show
description: ''
summary: Gets information about the specified task.
Metadata: {}
- commandList: []
htmlId: stop
examples: []
parameters:
- name: --job-id
isRequired: True
summary: The id of the job containing the task.
description: ''
- name: --task-id
isRequired: True
summary: The id of the task to terminate.
description: ''
- name: --account-endpoint
isRequired: False
summary: 'Batch service endpoint. Alternatively, set by environment variable: AZURE_BATCH_ENDPOINT.'
description: ''
- name: --account-key
isRequired: False
summary: 'Batch account key. Alternatively, set by environment variable: AZURE_BATCH_ACCESS_KEY.'
description: ''
- name: --account-name
isRequired: False
summary: 'Batch account name. Alternatively, set by environment variable: AZURE_BATCH_ACCOUNT.'
description: ''
- name: --if-match
isRequired: False
summary: An ETag is specified. Specify this header to perform the operation only if the resource's ETag is an exact match as specified.
description: ''
- name: --if-modified-since
isRequired: False
summary: Specify this header to perform the operation only if the resource has been modified since the specified date/time.
description: ''
- name: --if-none-match
isRequired: False
summary: An ETag is specified. Specify this header to perform the operation only if the resource's ETag does not match the specified ETag.
description: ''
- name: --if-unmodified-since
isRequired: False
summary: Specify this header to perform the operation only if the resource has not been modified since the specified date/time.
description: ''
- name: --debug
isRequired: False
summary: Increase logging verbosity to show all debug logs.
description: ''
- name: --help -h
isRequired: False
summary: Show this help message and exit.
description: ''
- name: --output -o
isRequired: False
summary: Output format.
description: ''
defaultValue: json
parameterValueGroup: json, jsonc, table, tsv
- name: --query
isRequired: False
summary: JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.
description: ''
- name: --verbose
isRequired: False
summary: Increase logging verbosity. Use --debug for full debug logs.
description: ''
source:
remote:
path: src/command_modules/azure-cli-batch/azure/cli/command_modules/batch/_help.py
branch: master
repo: https://github.com/Azure/azure-cli.git
children: []
uid: az_batch_task_stop
name: az batch task stop
description: ''
summary: Terminates the specified task.
Metadata: {}
uid: az_batch_task
name: 'Batch tasks (Preview) - az batch task'
description: ''
summary: Commands to manage your Batch tasks.
Metadata:
doc_source_url_repo: https://github.com/Azure/azure-cli/blob/master/
doc_source_url_path: src/command_modules/azure-cli-batch/azure/cli/command_modules/batch/_help.py
original_content_git_url: https://github.com/Azure/azure-cli/blob/master/src/command_modules/azure-cli-batch/azure/cli/command_modules/batch/_help.py
gitcommit: https://github.com/Azure/azure-cli/blob/6feea71edca41b84241364d2dc267d86407ed230/src/command_modules/azure-cli-batch/azure/cli/command_modules/batch/_help.py
updated_at: 2/15/2017 5:37:36 PM
ms.date: 2/15/2017