forked from MicrosoftDocs/azure-docs-cli
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathbatch.yml
More file actions
367 lines (367 loc) · 16.7 KB
/
batch.yml
File metadata and controls
367 lines (367 loc) · 16.7 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
### YamlMime:UniversalReference
items:
- uid: az_batch
name: az batch
summary: Manage Azure Batch.
langs:
- azurecli
children: []
commands:
- uid: az_batch_account
name: az batch account
summary: Manage your Batch accounts.
- uid: az_batch_account_autostorage-keys
name: az batch account autostorage-keys
summary: Manage the access keys for the auto storage account configured for your Batch account.
- uid: az_batch_account_autostorage-keys_sync
name: az batch account autostorage-keys sync
summary: Synchronizes access keys for the auto-storage account configured for the specified Batch account.
- uid: az_batch_account_create
name: az batch account create
summary: Create a Batch account with the specified parameters.
- uid: az_batch_account_delete
name: az batch account delete
summary: Deletes the specified Batch account.
- uid: az_batch_account_keys
name: az batch account keys
summary: Manage your Batch account keys.
- uid: az_batch_account_keys_list
name: az batch account keys list
summary: Gets the account keys for the specified Batch account.
- uid: az_batch_account_keys_renew
name: az batch account keys renew
summary: Regenerates the specified account key for the Batch account.
- uid: az_batch_account_list
name: az batch account list
summary: List the Batch accounts associated with a subscription or resource group.
- uid: az_batch_account_login
name: az batch account login
summary: Log in with specified Batch account through Azure Active Directory or Shared Key authentication.
- uid: az_batch_account_set
name: az batch account set
summary: Update the properties of the specified Batch account. Properties that are not specified remain unchanged.
- uid: az_batch_account_show
name: az batch account show
summary: Gets information about the specified Batch account.
- uid: az_batch_application
name: az batch application
summary: Manage your Batch applications.
- uid: az_batch_application_create
name: az batch application create
summary: Adds an application to the specified Batch account.
- uid: az_batch_application_delete
name: az batch application delete
summary: Deletes an application.
- uid: az_batch_application_list
name: az batch application list
summary: Lists all of the applications in the specified account.
- uid: az_batch_application_package
name: az batch application package
summary: Manage your Batch application packages.
- uid: az_batch_application_package_activate
name: az batch application package activate
summary: Activates the specified application package. This step is unnecessary if the package has already been successfully activated by the 'create' command.
- uid: az_batch_application_package_create
name: az batch application package create
summary: Create an application package record and activate it.
- uid: az_batch_application_package_delete
name: az batch application package delete
summary: Deletes an application package record and its associated binary file.
- uid: az_batch_application_package_show
name: az batch application package show
summary: Gets information about the specified application package.
- uid: az_batch_application_set
name: az batch application set
summary: Update the properties of the specified application. Properties that are not specified remain unchanged.
- uid: az_batch_application_show
name: az batch application show
summary: Gets information about the specified application.
- uid: az_batch_application_summary
name: az batch application summary
summary: View a summary of your Batch application packages.
- uid: az_batch_application_summary_list
name: az batch application summary list
summary: Lists all of the applications available in the specified account.
- uid: az_batch_application_summary_show
name: az batch application summary show
summary: Gets information about the specified application.
- uid: az_batch_certificate
name: az batch certificate
summary: Manage your Batch certificates.
- uid: az_batch_certificate_create
name: az batch certificate create
summary: Add a certificate.
- uid: az_batch_certificate_delete
name: az batch certificate delete
summary: Delete the specified Batch certificate.
- uid: az_batch_certificate_list
name: az batch certificate list
summary: Lists all of the certificates that have been added to the specified account.
- uid: az_batch_certificate_show
name: az batch certificate show
summary: Gets information about the specified certificate.
- uid: az_batch_job
name: az batch job
summary: Manage your Batch jobs.
- uid: az_batch_job_all-statistics
name: az batch job all-statistics
summary: View statistics of all the jobs under your Batch account.
- uid: az_batch_job_all-statistics_show
name: az batch job all-statistics show
summary: Get lifetime summary statistics for all of the jobs in the specified account. Statistics are aggregated across all jobs that have ever existed in the account, from account creation to the last update time of the statistics.
- uid: az_batch_job_create
name: az batch job create
summary: Add a job to the specified account.
- uid: az_batch_job_delete
name: az batch job delete
summary: Deletes a job.
- uid: az_batch_job_disable
name: az batch job disable
summary: Disables the specified job, preventing new tasks from running.
- uid: az_batch_job_enable
name: az batch job enable
summary: Enables the specified job, allowing new tasks to run.
- uid: az_batch_job_list
name: az batch job list
summary: List all of the jobs in the specified account or the specified job schedule.
- uid: az_batch_job_prep-release-status
name: az batch job prep-release-status
summary: View the status of your job preparation and release tasks.
- uid: az_batch_job_prep-release-status_list
name: az batch job prep-release-status list
summary: Lists the execution status of the Job Preparation and Job Release task for the specified job across the compute nodes where the job has run.
- uid: az_batch_job_reset
name: az batch job reset
summary: Update the properties of a job. All updatable properties are replaced with the values specified or reset to default vaules if unspecified.
- uid: az_batch_job_set
name: az batch job set
summary: Update the properties of a job. Properties can be updated independently, but when a property is updated in a sub-group, for example 'constraints' or 'pool info', all properties of that group are reset.
- uid: az_batch_job_show
name: az batch job show
summary: Gets information about the specified job.
- uid: az_batch_job_stop
name: az batch job stop
summary: Terminates the specified job, marking it as completed.
- uid: az_batch_job-schedule
name: az batch job-schedule
summary: Manage your Batch job schedules.
- uid: az_batch_job-schedule_create
name: az batch job-schedule create
summary: Add a job schedule to the specified account.
- uid: az_batch_job-schedule_delete
name: az batch job-schedule delete
summary: Deletes a job schedule from the specified account.
- uid: az_batch_job-schedule_disable
name: az batch job-schedule disable
summary: Disables a job schedule.
- uid: az_batch_job-schedule_enable
name: az batch job-schedule enable
summary: Enables a job schedule.
- uid: az_batch_job-schedule_list
name: az batch job-schedule list
summary: Lists all of the job schedules in the specified account.
- uid: az_batch_job-schedule_reset
name: az batch job-schedule reset
summary: Update the properties of the specified job schedule. All updatable properties are replaced with the values specified or reset to default values if unspecified. An updated job specification only applies to new jobs.
- uid: az_batch_job-schedule_set
name: az batch job-schedule set
summary: Update the properties of the specified job schedule. You can independently update the 'schedule' and the 'job specification', but any change to either of these entities will reset all properties in that entity.
- uid: az_batch_job-schedule_show
name: az batch job-schedule show
summary: Gets information about the specified job schedule.
- uid: az_batch_job-schedule_stop
name: az batch job-schedule stop
summary: Terminates a job schedule.
- uid: az_batch_location
name: az batch location
summary: Manage Batch service options for a subscription at the region level.
- uid: az_batch_location_quotas
name: az batch location quotas
summary: Manage Batch service quotas at the region level.
- uid: az_batch_location_quotas_show
name: az batch location quotas show
summary: Gets the Batch service quotas for the specified subscription at the given location.
- uid: az_batch_node
name: az batch node
summary: Manage your Batch compute nodes.
- uid: az_batch_node_delete
name: az batch node delete
summary: Removes compute nodes from the specified pool.
- uid: az_batch_node_file
name: az batch node file
summary: Manage your Batch compute node files.
- uid: az_batch_node_file_delete
name: az batch node file delete
summary: Deletes the specified file from the compute node.
- uid: az_batch_node_file_download
name: az batch node file download
summary: Download the content of the specified node file.
- uid: az_batch_node_file_list
name: az batch node file list
summary: Lists all of the files in task directories on the specified compute node.
- uid: az_batch_node_file_show
name: az batch node file show
summary: Gets the properties of the specified compute node file.
- uid: az_batch_node_list
name: az batch node list
summary: Lists the compute nodes in the specified pool.
- uid: az_batch_node_reboot
name: az batch node reboot
summary: Restarts the specified compute node.
- uid: az_batch_node_reimage
name: az batch node reimage
summary: Reinstalls the operating system on the specified compute node.
- uid: az_batch_node_remote-desktop
name: az batch node remote-desktop
summary: Retrieve the remote desktop protocol for a Batch compute node.
- uid: az_batch_node_remote-desktop_download
name: az batch node remote-desktop download
summary: Gets the Remote Desktop Protocol file for the specified compute node.
- uid: az_batch_node_remote-login-settings
name: az batch node remote-login-settings
summary: Retrieve the remote login settings for a Batch compute node.
- uid: az_batch_node_remote-login-settings_show
name: az batch node remote-login-settings show
summary: Gets the settings required for remote login to a compute node.
- uid: az_batch_node_scheduling
name: az batch node scheduling
summary: Manage task scheduling for a Batch compute node.
- uid: az_batch_node_scheduling_disable
name: az batch node scheduling disable
summary: Disables task scheduling on the specified compute node.
- uid: az_batch_node_scheduling_enable
name: az batch node scheduling enable
summary: Enables task scheduling on the specified compute node.
- uid: az_batch_node_show
name: az batch node show
summary: Gets information about the specified compute node.
- uid: az_batch_node_user
name: az batch node user
summary: Manage the user accounts of your Batch compute node.
- uid: az_batch_node_user_create
name: az batch node user create
summary: Add a user account to the specified compute node.
- uid: az_batch_node_user_delete
name: az batch node user delete
summary: Deletes a user account from the specified compute node.
- uid: az_batch_node_user_reset
name: az batch node user reset
summary: Update the properties of a user account on the specified compute node. All updatable properties are replaced with the values specified or reset if unspecified.
- uid: az_batch_pool
name: az batch pool
summary: Manage your Batch pools.
- uid: az_batch_pool_all-statistics
name: az batch pool all-statistics
summary: View statistics of all pools under your Batch account.
- uid: az_batch_pool_all-statistics_show
name: az batch pool all-statistics show
summary: Get lifetime summary statistics for all of the pools in the specified account. Statistics are aggregated across all pools that have ever existed in the account, from account creation to the last update time of the statistics.
- uid: az_batch_pool_autoscale
name: az batch pool autoscale
summary: Manage automatic scaling of your Batch pools.
- uid: az_batch_pool_autoscale_disable
name: az batch pool autoscale disable
summary: Disables automatic scaling for a pool.
- uid: az_batch_pool_autoscale_enable
name: az batch pool autoscale enable
summary: Enables automatic scaling for a pool.
- uid: az_batch_pool_autoscale_evaluate
name: az batch pool autoscale evaluate
summary: Gets the result of evaluating an automatic scaling formula on the pool.
- uid: az_batch_pool_create
name: az batch pool create
summary: Create a pool in the specified account. When creating a pool, choose arguments from either Cloud Services Configuration or Virtual Machine Configuration.
- uid: az_batch_pool_delete
name: az batch pool delete
summary: Deletes a pool from the specified account.
- uid: az_batch_pool_list
name: az batch pool list
summary: Lists all of the pools in the specified account.
- uid: az_batch_pool_node-agent-skus
name: az batch pool node-agent-skus
summary: Retrieve node agent SKUs of pools using a Virtual Machine Configuration.
- uid: az_batch_pool_node-agent-skus_list
name: az batch pool node-agent-skus list
summary: Lists all node agent SKUs supported by the Azure Batch service.
- uid: az_batch_pool_os
name: az batch pool os
summary: Manage the operating system of your Batch pools.
- uid: az_batch_pool_os_upgrade
name: az batch pool os upgrade
summary: Upgrades the operating system of the specified pool.
- uid: az_batch_pool_reset
name: az batch pool reset
summary: Update the properties of the specified pool. All updatable properties are replaced with the values specified or reset to default values if unspecified.
- uid: az_batch_pool_resize
name: az batch pool resize
summary: Resize (or stop resizing) the Batch pool.
- uid: az_batch_pool_set
name: az batch pool set
summary: Update the properties of the specified pool. Properties can be updated independently, but when a property is updated in a sub-group, for example 'start task', all properties of that group are reset.
- uid: az_batch_pool_show
name: az batch pool show
summary: Gets information about the specified pool.
- uid: az_batch_pool_usage-metrics
name: az batch pool usage-metrics
summary: View usage metrics of your Batch pools.
- uid: az_batch_pool_usage-metrics_list
name: az batch pool usage-metrics list
summary: Lists the usage metrics, aggregated by pool across individual time intervals, for the specified account.
- uid: az_batch_task
name: az batch task
summary: Manage your Batch tasks.
- 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.