generated: '2026-09-17' method: searched source: https://learn.microsoft.com/en-us/cli/azure/batch name: Azure CLI — az batch official: true vendor: Microsoft description: 'The Batch command group of the Azure CLI. It is the only first-party CLI for Azure Batch and it spans BOTH planes: az batch account / application / location / private-endpoint-connection call the management plane (management.azure.com), while az batch job / job-schedule / task / pool / node call the data plane, after az batch account login establishes the account context.' install: - method: winget command: winget install --exact --id Microsoft.AzureCLI - method: homebrew command: brew install azure-cli - method: apt command: curl -sL https://aka.ms/InstallAzureCLIDeb | sudo bash - method: docker command: docker run -it mcr.microsoft.com/azure-cli - method: pip command: pip install azure-cli note: Not the recommended path; Microsoft ships platform installers. install_docs: https://learn.microsoft.com/en-us/cli/azure/install-azure-cli auth: command: az batch account login description: Log in to a Batch account through Microsoft Entra ID or shared-key authentication. note: az login establishes the Azure identity first; az batch account login then binds the Batch account context the data-plane commands use. summary: commands: 127 groups: 10 groups: - group: az batch account commands: - command: az batch account autostorage-keys description: Manage the access keys for the auto storage account configured for a Batch account. - command: az batch account autostorage-keys sync description: Synchronizes access keys for the auto-storage account configured for the specified Batch account, only if storage key authentication is being used. - command: az batch account create description: Create a Batch account with the specified parameters. - command: az batch account delete description: Deletes the specified Batch account. - command: az batch account identity description: Manage identities of a batch account. - command: az batch account identity assign description: Add managed identities to an existing batch account. - command: az batch account identity remove description: Remove managed identities from an existing batch account. - command: az batch account identity show description: Display managed identities of a batch account. - command: az batch account keys description: Manage Batch account keys. - command: az batch account keys list description: 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. - command: az batch account keys renew description: Renew keys for a Batch account. - command: az batch account list description: List the Batch accounts associated with a subscription or resource group. - command: az batch account login description: Log in to a Batch account through Azure Active Directory or Shared Key authentication. - command: az batch account network-profile description: Manage Batch account Network profiles. - command: az batch account network-profile network-rule description: Manage Batch account Network rules in Network Profile. - command: az batch account network-profile network-rule add description: Add a Network rule from a Network Profile. - command: az batch account network-profile network-rule delete description: Delete a Network rule from a Network Profile. - command: az batch account network-profile network-rule list description: List the Network rules from a Network Profile. - command: az batch account network-profile set description: Set the Network profile for Batch account. - command: az batch account network-profile show description: Get information about the Network profile for Batch account. - command: az batch account outbound-endpoints description: List an account's outbound network dependencies. - command: az batch account set description: Update properties for a Batch account. - command: az batch account show description: Get a specified Batch account or the currently set account. description: Manage Azure Batch accounts. command_count: 23 - group: az batch application commands: - command: az batch application create description: Adds an application to the specified Batch account. - command: az batch application delete description: Deletes an application. - command: az batch application list description: Lists all of the applications in the specified account. - command: az batch application package description: Manage Batch application packages. - command: az batch application package activate description: Activates a Batch application package. - command: az batch application package create description: Create a Batch application package record and activate it. - command: az batch application package delete description: Deletes an application package record and its associated binary file. - command: az batch application package list description: Lists all of the application packages in the specified application. - command: az batch application package show description: Gets information about the specified application package. - command: az batch application set description: Update properties for a Batch application. - command: az batch application show description: Gets information about the specified application. - command: az batch application summary description: View a summary of Batch application packages. - command: az batch application summary list description: Lists all of the applications available in the specified account. - command: az batch application summary show description: Gets information about the specified application. description: Manage Batch applications. command_count: 14 - group: az batch job commands: - command: az batch job create description: Add a job to a Batch account. - command: az batch job delete description: Deletes a job from a Batch account. - command: az batch job disable description: Disable a Batch job. - command: az batch job enable description: Enable a Batch job. - command: az batch job list description: List all of the jobs or job schedule in a Batch account. - command: az batch job prep-release-status description: View the status of Batch job preparation and release tasks. - command: az batch job prep-release-status list description: 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. - command: az batch job reset description: Update the properties of a Batch job. Unspecified properties which can be updated are reset to their defaults. - command: az batch job set description: Update the properties of a Batch job. Updating a property in a subgroup will reset the unspecified properties of that group. - command: az batch job show description: Gets information about the specified Batch job. - command: az batch job stop description: Stop a running Batch job. - command: az batch job task-counts description: View the number of tasks and slots in a Batch job and their states. - command: az batch job task-counts show description: Gets the Task counts for the specified Job. description: Manage Batch jobs. command_count: 13 - group: az batch job-schedule commands: - command: az batch job-schedule create description: Add a Batch job schedule to an account. - command: az batch job-schedule delete description: Deletes a Job Schedule from the specified Account. - command: az batch job-schedule disable description: Disables a Job Schedule. - command: az batch job-schedule enable description: Enables a Job Schedule. - command: az batch job-schedule list description: Lists all of the Job Schedules in the specified Account. - command: az batch job-schedule reset description: Reset the properties of a job schedule. An updated job specification only applies to new jobs. - command: az batch job-schedule set description: Update the properties of a job schedule. - command: az batch job-schedule show description: Gets information about the specified Job Schedule. - command: az batch job-schedule stop description: Terminates a Job Schedule. description: Manage Batch job schedules. command_count: 9 - group: az batch location commands: - command: az batch location list-skus description: List virtual machine SKUs available in a location. - command: az batch location quotas description: Manage Batch service quotas at the region level. - command: az batch location quotas show description: Gets the Batch service quotas for the specified subscription at the given location. description: Manage Batch service options for a subscription at the region level. command_count: 3 - group: az batch node commands: - command: az batch node delete description: Removes Compute Nodes from the specified Pool. - command: az batch node file description: Manage Batch compute node files. - command: az batch node file delete description: Deletes the specified file from the Compute Node. - command: az batch node file download description: Download the content of the a node file. - command: az batch node file list description: Lists all of the files in Task directories on the specified Compute Node. - command: az batch node file show description: Gets the properties of the specified Compute Node file. - command: az batch node list description: Lists the Compute Nodes in the specified Pool. - command: az batch node reboot description: Reboot a Batch compute node. - command: az batch node remote-login-settings description: Retrieve the remote login settings for a Batch compute node. - command: az batch node remote-login-settings show description: Gets the settings required for remote login to a Compute Node. - command: az batch node scheduling description: Manage task scheduling for a Batch compute node. - command: az batch node scheduling disable description: Disable scheduling on a Batch compute node. - command: az batch node scheduling enable description: Enable scheduling on a Batch compute node. - command: az batch node service-logs description: Manage the service log files of a Batch compute node. - command: az batch node service-logs upload description: Upload service logs from a specified Batch compute node. - command: az batch node show description: Gets information about the specified Compute Node. - command: az batch node user description: Manage the user accounts of a Batch compute node. - command: az batch node user create description: Add a user account to a Batch compute node. - command: az batch node user delete description: Deletes a user Account from the specified Compute Node. - command: az batch node user reset description: Update the properties of a user account on a Batch compute node. Unspecified properties which can be updated are reset to their defaults. description: Manage Batch compute nodes. command_count: 20 - group: az batch pool commands: - command: az batch pool autoscale description: Manage automatic scaling of Batch pools. - command: az batch pool autoscale disable description: Disables automatic scaling for a Pool. - command: az batch pool autoscale enable description: Enables automatic scaling for a Pool. - command: az batch pool autoscale evaluate description: Gets the result of evaluating an automatic scaling formula on the Pool. - command: az batch pool create description: Create a Batch pool in an account. When creating a pool, choose arguments from either Cloud Services Configuration or Virtual Machine Configuration. - command: az batch pool delete description: Deletes a Pool from the specified Account. - command: az batch pool list description: Lists all of the Pools in the specified Account. - command: az batch pool node-counts description: Get node counts for Batch pools. - command: az batch pool node-counts list description: Gets the number of Compute Nodes in each state, grouped by Pool. - command: az batch pool reset description: Update the properties of a Batch pool. Unspecified properties which can be updated are reset to their defaults. - command: az batch pool resize description: Resize or stop resizing a Batch pool. - command: az batch pool set description: Update the properties of a Batch pool. Updating a property in a subgroup will reset the unspecified properties of that group. - command: az batch pool show description: Gets information about the specified Pool. - command: az batch pool supported-images description: Query information on VM images supported by Azure Batch service. - command: az batch pool supported-images list description: Lists all Virtual Machine Images supported by the Azure Batch service. - command: az batch pool usage-metrics description: View usage metrics of Batch pools. - command: az batch pool usage-metrics list description: Lists the usage metrics, aggregated by Pool across individual time intervals, for the specified Account. description: Manage Batch pools. command_count: 17 - group: az batch private-endpoint-connection commands: - command: az batch private-endpoint-connection list description: List all of the private endpoint connections in the specified account. - command: az batch private-endpoint-connection show description: Get information about the specified private endpoint connection. description: Manage Batch account private endpoint connections. command_count: 2 - group: az batch private-link-resource commands: - command: az batch private-link-resource list description: List all of the private link resources in the specified account. - command: az batch private-link-resource show description: Get information about the specified private link resource. description: Manage Batch account private Link Resources. command_count: 2 - group: az batch task commands: - command: az batch task create description: Create Batch tasks. - command: az batch task delete description: Deletes a Task from the specified Job. - command: az batch task file description: Manage Batch task files. - command: az batch task file delete description: Deletes the specified Task file from the Compute Node where the Task ran. - command: az batch task file download description: Download the content of a Batch task file. - command: az batch task file list description: Lists the files in a Task's directory on its Compute Node. - command: az batch task file show description: Gets the properties of the specified Task file. - command: az batch task list description: Lists all of the Tasks that are associated with the specified Job. - command: az batch task reactivate description: Reactivates a Task, allowing it to run again even if its retry count has been exhausted. - command: az batch task reset description: Reset the properties of a Batch task. - command: az batch task show description: Gets information about the specified Task. - command: az batch task stop description: Terminates the specified Task. - command: az batch task subtask description: Manage subtask information of a Batch task. - command: az batch task subtask list description: Lists all of the subtasks that are associated with the specified multi-instance Task. description: Manage Batch tasks. command_count: 14 key_flows: - flow: Create an account and log in commands: - az batch account create - az batch account login - flow: Stand up a pool commands: - az batch pool create - az batch pool resize - az batch pool show - flow: Run work commands: - az batch job create - az batch task create - az batch task list - az batch task file download - flow: Autoscale commands: - az batch pool autoscale evaluate - az batch pool autoscale enable - az batch pool autoscale disable - flow: Tear down commands: - az batch job stop - az batch job delete - az batch pool delete