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

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

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

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

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