az batch node
Manage Batch compute nodes.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| 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 node delete
Removes Compute Nodes from the specified Pool.
This operation can only run when the allocation state of the Pool is steady. When this operation runs, the allocation state changes from steady to resizing. Each request may remove up to 100 nodes.
az batch node delete --pool-id
[--account-endpoint]
[--account-key]
[--account-name]
[--if-match]
[--if-modified-since]
[--if-none-match]
[--if-unmodified-since]
[--json-file]
[--node-deallocation-option {requeue, retaineddata, taskcompletion, terminate}]
[--node-list]
[--resize-timeout]Required Parameters
The ID of the Pool from which you want to remove Compute Nodes.
Optional Parameters
Batch service endpoint. Alternatively, set by environment variable: AZURE_BATCH_ENDPOINT.
Batch account key. Alternatively, set by environment variable: AZURE_BATCH_ACCESS_KEY.
Batch account name. Alternatively, set by environment variable: AZURE_BATCH_ACCOUNT.
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.
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.
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.
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.
A file containing the node remove parameter specification in JSON (formatted to match the respective REST API body). If this parameter is specified, all 'Node Remove Arguments' are ignored.
Determines what to do with a Compute Node and its running task(s) after it has been selected for deallocation. The default value is requeue.
Required. A maximum of 100 nodes may be removed per request. Space-separated values.
The default value is 15 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). Expected format is an ISO-8601 duration.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az batch node list
Lists the Compute Nodes in the specified Pool.
az batch node list --pool-id
[--account-endpoint]
[--account-key]
[--account-name]
[--filter]
[--select]Required Parameters
The ID of the Pool from which you want to list Compute Nodes.
Optional Parameters
Batch service endpoint. Alternatively, set by environment variable: AZURE_BATCH_ENDPOINT.
Batch account key. Alternatively, set by environment variable: AZURE_BATCH_ACCESS_KEY.
Batch account name. Alternatively, set by environment variable: AZURE_BATCH_ACCOUNT.
An OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-nodes-in-a-pool.
An OData $select clause.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az batch node reboot
Restarts the specified Compute Node.
You can restart a Compute Node only if it is in an idle or running state.
az batch node reboot --node-id
--pool-id
[--account-endpoint]
[--account-key]
[--account-name]
[--node-reboot-option {requeue, retaineddata, taskcompletion, terminate}]Required Parameters
The ID of the Compute Node that you want to restart.
The ID of the Pool that contains the Compute Node.
Optional Parameters
Batch service endpoint. Alternatively, set by environment variable: AZURE_BATCH_ENDPOINT.
Batch account key. Alternatively, set by environment variable: AZURE_BATCH_ACCESS_KEY.
Batch account name. Alternatively, set by environment variable: AZURE_BATCH_ACCOUNT.
The default value is requeue.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az batch node reimage
Reinstalls the operating system on the specified Compute Node.
You can reinstall the operating system on a Compute Node only if it is in an idle or running state. This API can be invoked only on Pools created with the cloud service configuration property.
az batch node reimage --node-id
--pool-id
[--account-endpoint]
[--account-key]
[--account-name]
[--node-reimage-option {requeue, retaineddata, taskcompletion, terminate}]Required Parameters
The ID of the Compute Node that you want to restart.
The ID of the Pool that contains the Compute Node.
Optional Parameters
Batch service endpoint. Alternatively, set by environment variable: AZURE_BATCH_ENDPOINT.
Batch account key. Alternatively, set by environment variable: AZURE_BATCH_ACCESS_KEY.
Batch account name. Alternatively, set by environment variable: AZURE_BATCH_ACCOUNT.
The default value is requeue.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az batch node show
Gets information about the specified Compute Node.
az batch node show --node-id
--pool-id
[--account-endpoint]
[--account-key]
[--account-name]
[--select]Required Parameters
The ID of the Compute Node that you want to get information about.
The ID of the Pool that contains the Compute Node.
Optional Parameters
Batch service endpoint. Alternatively, set by environment variable: AZURE_BATCH_ENDPOINT.
Batch account key. Alternatively, set by environment variable: AZURE_BATCH_ACCESS_KEY.
Batch account name. Alternatively, set by environment variable: AZURE_BATCH_ACCOUNT.
An OData $select clause.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
Azure CLI