az batch
Note
This command group has commands that are defined in both Azure CLI and at least one extension. Install each extension to benefit from its extended capabilities. Learn more about extensions.
Manage Azure Batch.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| az batch account |
Manage Azure Batch accounts. |
Core | GA |
| az batch account autostorage-keys |
Manage the access keys for the auto storage account configured for a Batch account. |
Core | GA |
| az batch account autostorage-keys sync |
Synchronizes access keys for the auto-storage account configured for the specified Batch account, only if storage key authentication is being used. |
Core | GA |
| az batch account create |
Create a Batch account with the specified parameters. |
Core | GA |
| az batch account delete |
Deletes the specified Batch account. |
Core | GA |
| az batch account identity |
Manage identities of a batch account. |
Core | GA |
| az batch account identity assign |
Add managed identities to an existing batch account. |
Core | GA |
| az batch account identity remove |
Remove managed identities from an existing batch account. |
Core | GA |
| az batch account identity show |
Display managed identities of a batch account. |
Core | GA |
| az batch account keys |
Manage Batch account keys. |
Core | GA |
| az batch account keys list |
Gets the account keys for the specified Batch account. This operation applies only to Batch accounts with allowedAuthenticationModes containing 'SharedKey'. If the Batch account doesn't contain 'SharedKey' in its allowedAuthenticationMode, clients cannot use shared keys to authenticate, and must use another allowedAuthenticationModes instead. In this case, getting the keys will fail. |
Core | GA |
| az batch account keys renew |
Renew keys for a Batch account. |
Core | GA |
| az batch account list |
List the Batch accounts associated with a subscription or resource group. |
Core | GA |
| az batch account login |
Log in to a Batch account through Azure Active Directory or Shared Key authentication. |
Core | GA |
| az batch account network-profile |
Manage Batch account Network profiles. |
Core | GA |
| az batch account network-profile network-rule |
Manage Batch account Network rules in Network Profile. |
Core | GA |
| az batch account network-profile network-rule add |
Add a Network rule from a Network Profile. |
Core | GA |
| az batch account network-profile network-rule delete |
Delete a Network rule from a Network Profile. |
Core | GA |
| az batch account network-profile network-rule list |
List the Network rules from a Network Profile. |
Core | GA |
| az batch account network-profile set |
Set the Network profile for Batch account. |
Core | GA |
| az batch account network-profile show |
Get information about the Network profile for Batch account. |
Core | GA |
| az batch account outbound-endpoints |
List an account's outbound network dependencies. |
Core | GA |
| az batch account set |
Update properties for a Batch account. |
Core | GA |
| az batch account show |
Get a specified Batch account or the currently set account. |
Core | GA |
| az batch application |
Manage Batch applications. |
Core | GA |
| az batch application create |
Adds an application to the specified Batch account. |
Core | GA |
| az batch application delete |
Deletes an application. |
Core | GA |
| az batch application list |
Lists all of the applications in the specified account. |
Core | GA |
| az batch application package |
Manage Batch application packages. |
Core | GA |
| az batch application package activate |
Activates a Batch application package. |
Core | GA |
| az batch application package create |
Create a Batch application package record and activate it. |
Core | GA |
| az batch application package delete |
Deletes an application package record and its associated binary file. |
Core | GA |
| az batch application package list |
Lists all of the application packages in the specified application. |
Core | GA |
| az batch application package show |
Gets information about the specified application package. |
Core | GA |
| az batch application set |
Update properties for a Batch application. |
Core | GA |
| az batch application show |
Gets information about the specified application. |
Core | GA |
| az batch application summary |
View a summary of Batch application packages. |
Core | GA |
| az batch application summary list |
Lists all of the applications available in the specified account. |
Core | GA |
| az batch application summary show |
Gets information about the specified application. |
Core | GA |
| az batch certificate |
Manage Batch certificates. |
Core | Deprecated |
| az batch certificate create |
Add a certificate to a Batch account. |
Core | Deprecated |
| az batch certificate delete |
Delete a certificate from a Batch account. |
Core | Deprecated |
| az batch certificate list |
Lists all of the Certificates that have been added to the specified Account. |
Core | Deprecated |
| az batch certificate show |
Gets information about the specified Certificate. |
Core | Deprecated |
| az batch file |
Manage Batch input files. |
Extension | GA |
| az batch file download |
Download a specified file or directory of files to the specified storage path. |
Extension | GA |
| az batch file upload |
Upload a specified file or directory of files to the specified storage path. |
Extension | GA |
| az batch job |
Manage Batch jobs. |
Core and Extension | GA |
| az batch job-schedule |
Manage Batch job schedules. |
Core | GA |
| az batch job-schedule create |
Add a Batch job schedule to an account. |
Core | GA |
| az batch job-schedule delete |
Deletes a Job Schedule from the specified Account. |
Core | GA |
| az batch job-schedule disable |
Disables a Job Schedule. |
Core | GA |
| az batch job-schedule enable |
Enables a Job Schedule. |
Core | GA |
| az batch job-schedule list |
Lists all of the Job Schedules in the specified Account. |
Core | GA |
| az batch job-schedule reset |
Reset the properties of a job schedule. An updated job specification only applies to new jobs. |
Core | GA |
| az batch job-schedule set |
Update the properties of a job schedule. |
Core | GA |
| az batch job-schedule show |
Gets information about the specified Job Schedule. |
Core | GA |
| az batch job-schedule stop |
Terminates a Job Schedule. |
Core | GA |
| az batch job create |
Add a job to a Batch account. |
Core | GA |
| az batch job create (azure-batch-cli-extensions extension) |
Add a job and associated task(s) to a Batch account. |
Extension | GA |
| az batch job delete |
Deletes a Job. |
Core | GA |
| az batch job disable |
Disables the specified Job, preventing new Tasks from running. |
Core | GA |
| az batch job enable |
Enables the specified Job, allowing new Tasks to run. |
Core | GA |
| az batch job list |
List all of the jobs or job schedule in a Batch account. |
Core | GA |
| az batch job prep-release-status |
View the status of Batch job preparation and release tasks. |
Core | GA |
| az batch job prep-release-status list |
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. |
Core | GA |
| az batch job reset |
Update the properties of a Batch job. Unspecified properties which can be updated are reset to their defaults. |
Core | GA |
| az batch job set |
Update the properties of a Batch job. Updating a property in a subgroup will reset the unspecified properties of that group. |
Core | GA |
| az batch job show |
Gets information about the specified Job. |
Core | GA |
| az batch job stop |
Stop a running Batch job. |
Core | GA |
| az batch job task-counts |
View the number of tasks and slots in a Batch job and their states. |
Core | GA |
| az batch job task-counts show |
Gets the Task counts for the specified Job. |
Core | GA |
| az batch location |
Manage Batch service options for a subscription at the region level. |
Core | GA |
| az batch location list-skus |
List virtual machine SKUs available in a location. |
Core | GA |
| az batch location quotas |
Manage Batch service quotas at the region level. |
Core | GA |
| az batch location quotas show |
Gets the Batch service quotas for the specified subscription at the given location. |
Core | GA |
| az batch node |
Manage Batch compute nodes. |
Core | GA |
| az batch node delete |
Removes Compute Nodes from the specified Pool. |
Core | GA |
| az batch node file |
Manage Batch compute node files. |
Core | GA |
| az batch node file delete |
Deletes the specified file from the Compute Node. |
Core | GA |
| az batch node file download |
Download the content of the a node file. |
Core | GA |
| az batch node file list |
Lists all of the files in Task directories on the specified Compute Node. |
Core | GA |
| az batch node file show |
Gets the properties of the specified Compute Node file. |
Core | GA |
| az batch node list |
Lists the Compute Nodes in the specified Pool. |
Core | GA |
| az batch node reboot |
Restarts the specified Compute Node. |
Core | GA |
| az batch node reimage |
Reinstalls the operating system on the specified Compute Node. |
Core | GA |
| az batch node remote-desktop |
Retrieve the remote desktop protocol file for a Batch compute node. |
Core | GA |
| az batch node remote-desktop download |
Gets the Remote Desktop Protocol file for the specified Compute Node. |
Core | GA |
| az batch node remote-login-settings |
Retrieve the remote login settings for a Batch compute node. |
Core | GA |
| az batch node remote-login-settings show |
Gets the settings required for remote login to a Compute Node. |
Core | GA |
| az batch node scheduling |
Manage task scheduling for a Batch compute node. |
Core | GA |
| az batch node scheduling disable |
Disables Task scheduling on the specified Compute Node. |
Core | GA |
| az batch node scheduling enable |
Enables Task scheduling on the specified Compute Node. |
Core | GA |
| az batch node service-logs |
Manage the service log files of a Batch compute node. |
Core | GA |
| az batch node service-logs upload |
Upload Azure Batch service log files from the specified Compute Node to Azure Blob Storage. |
Core | GA |
| az batch node show |
Gets information about the specified Compute Node. |
Core | GA |
| az batch node user |
Manage the user accounts of a Batch compute node. |
Core | GA |
| az batch node user create |
Add a user account to a Batch compute node. |
Core | GA |
| az batch node user delete |
Deletes a user Account from the specified Compute Node. |
Core | GA |
| az batch node user reset |
Update the properties of a user account on a Batch compute node. Unspecified properties which can be updated are reset to their defaults. |
Core | GA |
| az batch pool |
Manage Batch pools. |
Core and Extension | GA |
| az batch pool autoscale |
Manage automatic scaling of Batch pools. |
Core | GA |
| az batch pool autoscale disable |
Disables automatic scaling for a Pool. |
Core | GA |
| az batch pool autoscale enable |
Enables automatic scaling for a Pool. |
Core | GA |
| az batch pool autoscale evaluate |
Gets the result of evaluating an automatic scaling formula on the Pool. |
Core | GA |
| az batch pool create |
Create a Batch pool in an account. When creating a pool, choose arguments from either Cloud Services Configuration or Virtual Machine Configuration. |
Core | GA |
| az batch pool create (azure-batch-cli-extensions extension) |
Create a Batch pool in an account. When creating a pool, choose arguments from either Cloud Services Configuration or Virtual Machine Configuration. |
Extension | GA |
| az batch pool delete |
Deletes a Pool from the specified Account. |
Core | GA |
| az batch pool list |
Lists all of the Pools in the specified Account. |
Core | GA |
| az batch pool node-counts |
Get node counts for Batch pools. |
Core | GA |
| az batch pool node-counts list |
Gets the number of Compute Nodes in each state, grouped by Pool. |
Core | GA |
| az batch pool reset |
Update the properties of a Batch pool. Unspecified properties which can be updated are reset to their defaults. |
Core | GA |
| az batch pool resize |
Resize or stop resizing a Batch pool. |
Core | GA |
| az batch pool set |
Update the properties of a Batch pool. Updating a property in a subgroup will reset the unspecified properties of that group. |
Core | GA |
| az batch pool show |
Gets information about the specified Pool. |
Core | GA |
| az batch pool supported-images |
Query information on VM images supported by Azure Batch service. |
Core | GA |
| az batch pool supported-images list |
Lists all Virtual Machine Images supported by the Azure Batch service. |
Core | GA |
| az batch pool usage-metrics |
View usage metrics of Batch pools. |
Core | GA |
| az batch pool usage-metrics list |
Lists the usage metrics, aggregated by Pool across individual time intervals, for the specified Account. |
Core | GA |
| az batch private-endpoint-connection |
Manage Batch account private endpoint connections. |
Core | GA |
| az batch private-endpoint-connection list |
List all of the private endpoint connections in the specified account. |
Core | GA |
| az batch private-endpoint-connection show |
Get information about the specified private endpoint connection. |
Core | GA |
| az batch private-link-resource |
Manage Batch account private Link Resources. |
Core | GA |
| az batch private-link-resource list |
List all of the private link resources in the specified account. |
Core | GA |
| az batch private-link-resource show |
Get information about the specified private link resource. |
Core | GA |
| az batch task |
Manage Batch tasks. |
Core | GA |
| az batch task create |
Create Batch tasks. |
Core | GA |
| az batch task delete |
Deletes a Task from the specified Job. |
Core | GA |
| az batch task file |
Manage Batch task files. |
Core | GA |
| az batch task file delete |
Deletes the specified Task file from the Compute Node where the Task ran. |
Core | GA |
| az batch task file download |
Download the content of a Batch task file. |
Core | GA |
| az batch task file list |
Lists the files in a Task's directory on its Compute Node. |
Core | GA |
| az batch task file show |
Gets the properties of the specified Task file. |
Core | GA |
| az batch task list |
Lists all of the Tasks that are associated with the specified Job. |
Core | GA |
| az batch task reactivate |
Reactivates a Task, allowing it to run again even if its retry count has been exhausted. |
Core | GA |
| az batch task reset |
Reset the properties of a Batch task. |
Core | GA |
| az batch task show |
Gets information about the specified Task. |
Core | GA |
| az batch task stop |
Terminates the specified Task. |
Core | GA |
| az batch task subtask |
Manage subtask information of a Batch task. |
Core | GA |
| az batch task subtask list |
Lists all of the subtasks that are associated with the specified multi-instance Task. |
Core | GA |
