Share via

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

Reboot a Batch 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

Disable scheduling on a Batch compute node.

 Core GA
az batch node scheduling enable

Enable scheduling on a Batch 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 service logs from a specified Batch compute node.

 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

Edit

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]
                     [--node-list]
                     [--resize-timeout]

Required Parameters

--pool-id

The ID of the Pool to get. Required.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--account-endpoint

Batch service endpoint. Alternatively, set by environment variable: AZURE_BATCH_ENDPOINT.

Property Value
Parameter group: Batch Account Arguments
--account-key

Batch account key. Alternatively, set by environment variable: AZURE_BATCH_ACCESS_KEY.

Property Value
Parameter group: Batch Account Arguments
--account-name

Batch account name. Alternatively, set by environment variable: AZURE_BATCH_ACCOUNT.

Property Value
Parameter group: Batch Account Arguments
--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.

Property Value
Parameter group: Pre-condition and Query Arguments
--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.

Property Value
Parameter group: Pre-condition and Query Arguments
--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.

Property Value
Parameter group: Pre-condition and Query Arguments
--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 been modified since the specified time.

Property Value
Parameter group: Pre-condition and Query Arguments
--json-file

A file containing the content specification in JSON (formatted to match the respective REST API body). If this parameter is specified, all 'Content Arguments' are ignored.

--node-deallocation-option

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. Known values are: "requeue", "terminate", "taskcompletion", and "retaineddata".

Property Value
Parameter group: Content Arguments
--node-list

A list containing the IDs of the Compute Nodes to be removed from the specified Pool. A maximum of 100 nodes may be removed per request. Required. Space-separated values.

Property Value
Parameter group: Content Arguments
--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.

Property Value
Parameter group: Content Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az batch node list

Edit

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 Compute Nodes. Required.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--account-endpoint

Batch service endpoint. Alternatively, set by environment variable: AZURE_BATCH_ENDPOINT.

Property Value
Parameter group: Batch Account Arguments
--account-key

Batch account key. Alternatively, set by environment variable: AZURE_BATCH_ACCESS_KEY.

Property Value
Parameter group: Batch Account Arguments
--account-name

Batch account name. Alternatively, set by environment variable: AZURE_BATCH_ACCOUNT.

Property Value
Parameter group: Batch Account Arguments
--filter

An OData $filter clause. For more information on constructing this filter,see https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch.

Property Value
Parameter group: Pre-condition and Query Arguments
--select

An OData $select clause.

Property Value
Parameter group: Pre-condition and Query Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az batch node reboot

Edit

Reboot a Batch compute node.

az batch node reboot --node-id
                     --pool-id
                     [--account-endpoint]
                     [--account-key]
                     [--account-name]
                     [--json-file]
                     [--node-reboot-option]

Examples

Reboot the node and requeue tasks.

az batch node reboot --pool-id pool1 --node-id node1

Reboot the node when tasks complete.

az batch node reboot --pool-id pool1 --node-id node1 --node-reboot-option taskcompletion

Required Parameters

--node-id

The ID of the Compute Node that you want to restart. Required.

--pool-id

The ID of the Pool that contains the Compute Node. Required.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--account-endpoint

Batch service endpoint. Alternatively, set by environment variable: AZURE_BATCH_ENDPOINT.

Property Value
Parameter group: Batch Account Arguments
--account-key

Batch account key. Alternatively, set by environment variable: AZURE_BATCH_ACCESS_KEY.

Property Value
Parameter group: Batch Account Arguments
--account-name

Batch account name. Alternatively, set by environment variable: AZURE_BATCH_ACCOUNT.

Property Value
Parameter group: Batch Account Arguments
--json-file

A file containing the parameters specification in JSON (formatted to match the respective REST API body). If this parameter is specified, all 'Parameters Arguments' are ignored.

--node-reboot-option

When to reboot the Compute Node and what to do with currently running Tasks. The default value is requeue. Known values are: "requeue", "terminate", "taskcompletion", and "retaineddata".

Property Value
Parameter group: Parameters Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az batch node show

Edit

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. Required.

--pool-id

The ID of the Pool that contains the Compute Node. Required.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--account-endpoint

Batch service endpoint. Alternatively, set by environment variable: AZURE_BATCH_ENDPOINT.

Property Value
Parameter group: Batch Account Arguments
--account-key

Batch account key. Alternatively, set by environment variable: AZURE_BATCH_ACCESS_KEY.

Property Value
Parameter group: Batch Account Arguments
--account-name

Batch account name. Alternatively, set by environment variable: AZURE_BATCH_ACCOUNT.

Property Value
Parameter group: Batch Account Arguments
--select

An OData $select clause.

Property Value
Parameter group: Pre-condition and Query Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False