Share via


az batch node scheduling

Manage task scheduling for a Batch compute node.

Commands

Name Description Type Status
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 scheduling disable

Disable scheduling on a Batch compute node.

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

Examples

Disable scheduling on a node and requeue any running tasks.

az batch node scheduling disable --pool-id pool1 --node-id node1 --node-disable-scheduling-option requeue

Required Parameters

--node-id

The ID of the Compute Node on which you want to disable Task scheduling. Required.

--pool-id

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

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.

--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-disable-scheduling-option

What to do with currently running Tasks when disabling Task scheduling on the Compute Node. The default value is requeue. Known values are: "requeue", "terminate", and "taskcompletion".

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az batch node scheduling enable

Enable scheduling on a Batch compute node.

az batch node scheduling enable --node-id
                                --pool-id
                                [--account-endpoint]
                                [--account-key]
                                [--account-name]

Examples

Enable scheduling on a node.

az batch node scheduling enable --pool-id pool1 --node-id node1

Required Parameters

--node-id

The ID of the Compute Node on which you want to enable Task scheduling. Required.

--pool-id

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

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.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.