forked from MicrosoftDocs/azure-docs-cli
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathtask.yml
More file actions
313 lines (313 loc) · 18.3 KB
/
task.yml
File metadata and controls
313 lines (313 loc) · 18.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
### YamlMime:UniversalReference
items:
- uid: az_batch_task
name: az batch task
summary: Manage your Batch tasks.
langs:
- azurecli
children:
- az_batch_task_create
- az_batch_task_delete
- az_batch_task_list
- az_batch_task_reactivate
- az_batch_task_reset
- az_batch_task_show
- az_batch_task_stop
- uid: az_batch_task_create
name: az batch task create
summary: Create a single Batch task or multiple Batch tasks.
langs:
- azurecli
parameters:
- isRequired: true
name: --job-id
summary: The ID of the job containing the task.
- name: --affinity-info
summary: A locality hint that can be used by the Batch service to select a compute node on which to start the new task.
- name: --application-package-references
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.
- name: --command-line
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.
- name: --environment-settings
summary: A list of environment variable settings for the task. Space separated values in 'key=value' format.
- name: --json-file
summary: The file containing the task(s) to create in JSON format, if this parameter is specified, all other parameters are ignored.
- name: --max-task-retry-count
summary: The maximum number of times the task may be retried. 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.
- name: --max-wall-clock-time
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. If this is not specified, there is no time limit on how long the task may run.
- name: --resource-files
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.
- name: --retention-time
summary: The minimum time to retain the task directory on the compute node where it ran, from the time it completes execution. After this time, the Batch service may delete the task directory and all its contents. The default is infinite, i.e. the task directory will be retained until the compute node is removed or reimaged.
- name: --task-id
summary: The ID of the task.
- name: --account-endpoint
summary: 'Batch service endpoint. Alternatively, set by environment variable: AZURE_BATCH_ENDPOINT.'
- name: --account-key
summary: 'The Batch account key. Alternatively, set by environment variable: AZURE_BATCH_ACCESS_KEY.'
- name: --account-name
summary: 'The Batch account name. Alternatively, set by environment variable: AZURE_BATCH_ACCOUNT.'
source:
path: src/command_modules/azure-cli-batch/azure/cli/command_modules/batch/_help.py
remote:
branch: chaochen
path: src/command_modules/azure-cli-batch/azure/cli/command_modules/batch/_help.py
repo: https://github.com/azure/azure-cli/.git
- uid: az_batch_task_delete
name: az batch task delete
summary: Deletes a task from the specified job.
langs:
- azurecli
parameters:
- isRequired: true
name: --job-id
summary: The ID of the job from which to delete the task.
- isRequired: true
name: --task-id
summary: The ID of the task to delete.
- name: --yes -y
summary: Do not prompt for confirmation.
- name: --account-endpoint
summary: 'Batch service endpoint. Alternatively, set by environment variable: AZURE_BATCH_ENDPOINT.'
- name: --account-key
summary: 'Batch account key. Alternatively, set by environment variable: AZURE_BATCH_ACCESS_KEY.'
- name: --account-name
summary: 'Batch account name. Alternatively, set by environment variable: AZURE_BATCH_ACCOUNT.'
- name: --if-match
summary: An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.
- name: --if-modified-since
summary: A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
- name: --if-none-match
summary: An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.
- name: --if-unmodified-since
summary: A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
source:
path: src/command_modules/azure-cli-batch/azure/cli/command_modules/batch/_help.py
remote:
branch: chaochen
path: src/command_modules/azure-cli-batch/azure/cli/command_modules/batch/_help.py
repo: https://github.com/azure/azure-cli/.git
- uid: az_batch_task_list
name: az batch task list
summary: Lists all of the tasks that are associated with the specified job.
langs:
- azurecli
parameters:
- isRequired: true
name: --job-id
summary: The ID of the job.
- name: --account-endpoint
summary: 'Batch service endpoint. Alternatively, set by environment variable: AZURE_BATCH_ENDPOINT.'
- name: --account-key
summary: 'Batch account key. Alternatively, set by environment variable: AZURE_BATCH_ACCESS_KEY.'
- name: --account-name
summary: 'Batch account name. Alternatively, set by environment variable: AZURE_BATCH_ACCOUNT.'
- name: --expand
summary: An OData $expand clause.
- name: --filter
summary: An OData $filter clause.
- name: --select
summary: An OData $select clause.
source:
path: src/command_modules/azure-cli-batch/azure/cli/command_modules/batch/_help.py
remote:
branch: chaochen
path: src/command_modules/azure-cli-batch/azure/cli/command_modules/batch/_help.py
repo: https://github.com/azure/azure-cli/.git
- uid: az_batch_task_reactivate
name: az batch task reactivate
summary: Reactivates the specified task.
langs:
- azurecli
parameters:
- isRequired: true
name: --job-id
summary: The ID of the job containing the task.
- isRequired: true
name: --task-id
summary: The ID of the task to reactivate.
- name: --account-endpoint
summary: 'Batch service endpoint. Alternatively, set by environment variable: AZURE_BATCH_ENDPOINT.'
- name: --account-key
summary: 'Batch account key. Alternatively, set by environment variable: AZURE_BATCH_ACCESS_KEY.'
- name: --account-name
summary: 'Batch account name. Alternatively, set by environment variable: AZURE_BATCH_ACCOUNT.'
- name: --if-match
summary: An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.
- name: --if-modified-since
summary: A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
- name: --if-none-match
summary: An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.
- name: --if-unmodified-since
summary: A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
source:
path: src/command_modules/azure-cli-batch/azure/cli/command_modules/batch/_help.py
remote:
branch: chaochen
path: src/command_modules/azure-cli-batch/azure/cli/command_modules/batch/_help.py
repo: https://github.com/azure/azure-cli/.git
- uid: az_batch_task_reset
name: az batch task reset
summary: Update the properties of the specified task. All updatable properties are replaced with the values specified or reset if unspecified.
langs:
- azurecli
parameters:
- isRequired: true
name: --job-id
summary: The ID of the job containing the task.
- isRequired: true
name: --task-id
summary: The ID of the task to update.
- name: --json-file
summary: A file containing the constraints specification in JSON format. If this parameter is specified, all 'Constraints Arguments' are ignored.
- name: --account-endpoint
summary: 'Batch service endpoint. Alternatively, set by environment variable: AZURE_BATCH_ENDPOINT.'
- name: --account-key
summary: 'Batch account key. Alternatively, set by environment variable: AZURE_BATCH_ACCESS_KEY.'
- name: --account-name
summary: 'Batch account name. Alternatively, set by environment variable: AZURE_BATCH_ACCOUNT.'
- name: --max-task-retry-count
summary: The maximum number of times the task may be retried. 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.
- name: --max-wall-clock-time
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. If this is not specified, there is no time limit on how long the task may run. Expected format is an ISO-8601 duration.
- name: --retention-time
summary: The minimum time to retain the task directory on the compute node where it ran, from the time it completes execution. After this time, the Batch service may delete the task directory and all its contents. The default is infinite, i.e. the task directory will be retained until the compute node is removed or reimaged. Expected format is an ISO-8601 duration.
- name: --if-match
summary: An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.
- name: --if-modified-since
summary: A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
- name: --if-none-match
summary: An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.
- name: --if-unmodified-since
summary: A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
source:
path: src/command_modules/azure-cli-batch/azure/cli/command_modules/batch/_help.py
remote:
branch: chaochen
path: src/command_modules/azure-cli-batch/azure/cli/command_modules/batch/_help.py
repo: https://github.com/azure/azure-cli/.git
- uid: az_batch_task_show
name: az batch task show
summary: Gets information about the specified task.
langs:
- azurecli
parameters:
- isRequired: true
name: --job-id
summary: The ID of the job that contains the task.
- isRequired: true
name: --task-id
summary: The ID of the task to get information about.
- name: --account-endpoint
summary: 'Batch service endpoint. Alternatively, set by environment variable: AZURE_BATCH_ENDPOINT.'
- name: --account-key
summary: 'Batch account key. Alternatively, set by environment variable: AZURE_BATCH_ACCESS_KEY.'
- name: --account-name
summary: 'Batch account name. Alternatively, set by environment variable: AZURE_BATCH_ACCOUNT.'
- name: --expand
summary: An OData $expand clause.
- name: --if-match
summary: An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.
- name: --if-modified-since
summary: A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
- name: --if-none-match
summary: An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.
- name: --if-unmodified-since
summary: A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
- name: --select
summary: An OData $select clause.
source:
path: src/command_modules/azure-cli-batch/azure/cli/command_modules/batch/_help.py
remote:
branch: chaochen
path: src/command_modules/azure-cli-batch/azure/cli/command_modules/batch/_help.py
repo: https://github.com/azure/azure-cli/.git
- uid: az_batch_task_stop
name: az batch task stop
summary: Terminates the specified task.
langs:
- azurecli
parameters:
- isRequired: true
name: --job-id
summary: The ID of the job containing the task.
- isRequired: true
name: --task-id
summary: The ID of the task to terminate.
- name: --account-endpoint
summary: 'Batch service endpoint. Alternatively, set by environment variable: AZURE_BATCH_ENDPOINT.'
- name: --account-key
summary: 'Batch account key. Alternatively, set by environment variable: AZURE_BATCH_ACCESS_KEY.'
- name: --account-name
summary: 'Batch account name. Alternatively, set by environment variable: AZURE_BATCH_ACCOUNT.'
- name: --if-match
summary: An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.
- name: --if-modified-since
summary: A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
- name: --if-none-match
summary: An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.
- name: --if-unmodified-since
summary: A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
source:
path: src/command_modules/azure-cli-batch/azure/cli/command_modules/batch/_help.py
remote:
branch: chaochen
path: src/command_modules/azure-cli-batch/azure/cli/command_modules/batch/_help.py
repo: https://github.com/azure/azure-cli/.git
commands:
- uid: az_batch_task_create
name: az batch task create
summary: Create a single Batch task or multiple Batch tasks.
- uid: az_batch_task_delete
name: az batch task delete
summary: Deletes a task from the specified job.
- uid: az_batch_task_file
name: az batch task file
summary: Manage your Batch task files.
- uid: az_batch_task_file_delete
name: az batch task file delete
summary: Deletes the specified task file from the compute node where the task ran.
- uid: az_batch_task_file_download
name: az batch task file download
summary: Download the content of the specified task file.
- uid: az_batch_task_file_list
name: az batch task file list
summary: Lists the files in a task's directory on its compute node.
- uid: az_batch_task_file_show
name: az batch task file show
summary: Gets the properties of the specified task file.
- uid: az_batch_task_list
name: az batch task list
summary: Lists all of the tasks that are associated with the specified job.
- uid: az_batch_task_reactivate
name: az batch task reactivate
summary: Reactivates the specified task.
- uid: az_batch_task_reset
name: az batch task reset
summary: Update the properties of the specified task. All updatable properties are replaced with the values specified or reset if unspecified.
- uid: az_batch_task_show
name: az batch task show
summary: Gets information about the specified task.
- uid: az_batch_task_stop
name: az batch task stop
summary: Terminates the specified task.
- uid: az_batch_task_subtask
name: az batch task subtask
summary: Manage subtask information of your Batch task.
- uid: az_batch_task_subtask_list
name: az batch task subtask list
summary: Lists all of the subtasks that are associated with the specified multi-instance task.
globalParameters:
- name: --debug
summary: Increase logging verbosity to show all debug logs.
- name: --help -h
summary: Show this help message and exit.
- name: --output -o
defaultValue: json
parameterValueGroup: json, jsonc, table, tsv
summary: Output format.
- name: --query
summary: JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.
- name: --verbose
summary: Increase logging verbosity. Use --debug for full debug logs.