az batch node

Manage Batch compute nodes.

Commands

az batch node delete Removes compute nodes from the specified pool.
az batch node file Manage Batch compute node files.
az batch node file delete Deletes the specified file from the compute node.
az batch node file download Download the content of the a node file.
az batch node file list Lists all of the files in task directories on the specified compute node.
az batch node file show Gets the properties of the specified compute node file.
az batch node list Lists the compute nodes in the specified pool.
az batch node reboot Restarts the specified compute node.
az batch node reimage Reinstalls the operating system on the specified compute node.
az batch node remote-desktop Retrieve the remote desktop protocol file for a Batch compute node.
az batch node remote-desktop download Gets the Remote Desktop Protocol file for the specified compute node.
az batch node remote-login-settings Retrieve the remote login settings for a Batch compute node.
az batch node remote-login-settings show Gets the settings required for remote login to a compute node.
az batch node scheduling Manage task scheduling for a Batch compute node.
az batch node scheduling disable Disables task scheduling on the specified compute node.
az batch node scheduling enable Enables task scheduling on the specified compute node.
az batch node show Gets information about the specified compute node.
az batch node user Manage the user accounts of a Batch compute node.
az batch node user create Add a user account to a Batch compute node.
az batch node user delete Deletes a user account from the specified compute node.
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.

az batch node delete

Removes compute nodes from the specified pool.

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

--pool-id
The ID of the pool from which you want to remove nodes.

Optional Parameters

--account-endpoint
Batch service endpoint. Alternatively, set by environment variable: AZURE_BATCH_ENDPOINT.
--account-key
Batch account key. Alternatively, set by environment variable: AZURE_BATCH_ACCESS_KEY.
--account-name
Batch account name. Alternatively, set by environment variable: AZURE_BATCH_ACCOUNT.
--if-match
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.
--if-modified-since
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.
--if-none-match
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.
--if-unmodified-since
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.
--json-file
A file containing the node remove parameter specification in JSON format. If this parameter is specified, all 'Node Remove Arguments' are ignored.
--node-deallocation-option
Determines what to do with a node and its running task(s) after it has been selected for deallocation. The default value is requeue.
accepted values: requeue, retainedData, taskCompletion, terminate
--node-list
A list containing the IDs of the compute nodes to be removed from the specified pool. Space separated values.
--resize-timeout
The timeout for removal of compute nodes to the pool. 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.

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

--pool-id
The ID of the pool from which you want to list nodes.

Optional Parameters

--account-endpoint
Batch service endpoint. Alternatively, set by environment variable: AZURE_BATCH_ENDPOINT.
--account-key
Batch account key. Alternatively, set by environment variable: AZURE_BATCH_ACCESS_KEY.
--account-name
Batch account name. Alternatively, set by environment variable: AZURE_BATCH_ACCOUNT.
--filter
An OData $filter clause..
--select
An OData $select clause.

az batch node reboot

Restarts the specified compute node.

az batch node reboot --node-id
--pool-id
[--account-endpoint]
[--account-key]
[--account-name]
[--node-reboot-option {'''requeue'', ''retainedData'', ''taskCompletion'', ''terminate'''}]

Required Parameters

--node-id
The ID of the compute node that you want to restart.
--pool-id
The ID of the pool that contains the compute node.

Optional Parameters

--account-endpoint
Batch service endpoint. Alternatively, set by environment variable: AZURE_BATCH_ENDPOINT.
--account-key
Batch account key. Alternatively, set by environment variable: AZURE_BATCH_ACCESS_KEY.
--account-name
Batch account name. Alternatively, set by environment variable: AZURE_BATCH_ACCOUNT.
--node-reboot-option
When to reboot the compute node and what to do with currently running tasks. Values are: requeue - Terminate running task processes and requeue the tasks. The tasks will run again when a node is available. Restart the node as soon as tasks have been terminated. terminate - Terminate running tasks. The tasks will not run again. Restart the node as soon as tasks have been terminated. taskcompletion - Allow currently running tasks to complete. Schedule no new tasks while waiting. Restart the node when all tasks have completed. retaineddata - Allow currently running tasks to complete, then wait for all task data retention periods to expire. Schedule no new tasks while waiting. Restart the node when all task retention periods have expired. The default value is requeue.
accepted values: '''requeue'', ''retainedData'', ''taskCompletion'', ''terminate'''

az batch node reimage

Reinstalls the operating system on the specified compute node.

az batch node reimage --node-id
--pool-id
[--account-endpoint]
[--account-key]
[--account-name]
[--node-reimage-option {'''requeue'', ''retainedData'', ''taskCompletion'', ''terminate'''}]

Required Parameters

--node-id
The ID of the compute node that you want to restart.
--pool-id
The ID of the pool that contains the compute node.

Optional Parameters

--account-endpoint
Batch service endpoint. Alternatively, set by environment variable: AZURE_BATCH_ENDPOINT.
--account-key
Batch account key. Alternatively, set by environment variable: AZURE_BATCH_ACCESS_KEY.
--account-name
Batch account name. Alternatively, set by environment variable: AZURE_BATCH_ACCOUNT.
--node-reimage-option
When to reimage the compute node and what to do with currently running tasks. Values are: requeue - Terminate running task processes and requeue the tasks. The tasks will run again when a node is available. Reimage the node as soon as tasks have been terminated. terminate - Terminate running tasks. The tasks will not run again. Reimage the node as soon as tasks have been terminated. taskcompletion - Allow currently running tasks to complete. Schedule no new tasks while waiting. Reimage the node when all tasks have completed. retaineddata - Allow currently running tasks to complete, then wait for all task data retention periods to expire. Schedule no new tasks while waiting. Reimage the node when all task retention periods have expired. The default value is requeue.
accepted values: '''requeue'', ''retainedData'', ''taskCompletion'', ''terminate'''

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

--node-id
The ID of the compute node that you want to get information about.
--pool-id
The ID of the pool that contains the compute node.

Optional Parameters

--account-endpoint
Batch service endpoint. Alternatively, set by environment variable: AZURE_BATCH_ENDPOINT.
--account-key
Batch account key. Alternatively, set by environment variable: AZURE_BATCH_ACCESS_KEY.
--account-name
Batch account name. Alternatively, set by environment variable: AZURE_BATCH_ACCOUNT.
--select
An OData $select clause.