Share via

az ml computetarget computeinstance

Note

This reference is part of the azure-cli-ml extension for the Azure CLI (version 2.0.28 or higher). The extension will automatically install the first time you run an az ml computetarget computeinstance command. Learn more about extensions.

AzureML compute instance commands.

Commands

Name Description Type Status
az ml computetarget computeinstance restart

Restart a compute instance.

 Extension GA
az ml computetarget computeinstance start

Start a compute instance.

 Extension GA
az ml computetarget computeinstance stop

Stop a compute instance.

 Extension GA

az ml computetarget computeinstance restart

Restart a compute instance.

az ml computetarget computeinstance restart --name
                                            [--no-wait]
                                            [--path]
                                            [--resource-group]
                                            [--subscription-id]
                                            [--workspace-name]
                                            []

Required Parameters

--name -n

Name of compute instance to restart.

Optional Parameters

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

--no-wait

Flag to not wait for asynchronous calls.

--path

Path to a project folder. Default: current directory.

--resource-group -g

Resource group corresponding to the provided workspace.

--subscription-id

Specifies the subscription Id.

--workspace-name -w

Name of the workspace containing the compute target to restart.

-v

Verbosity flag.

Property Value
Default value: False
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 ml computetarget computeinstance start

Start a compute instance.

az ml computetarget computeinstance start --name
                                          [--no-wait]
                                          [--path]
                                          [--resource-group]
                                          [--subscription-id]
                                          [--workspace-name]
                                          []

Required Parameters

--name -n

Name of compute instance to start.

Optional Parameters

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

--no-wait

Flag to not wait for asynchronous calls.

--path

Path to a project folder. Default: current directory.

--resource-group -g

Resource group corresponding to the provided workspace.

--subscription-id

Specifies the subscription Id.

--workspace-name -w

Name of the workspace containing the compute target to start.

-v

Verbosity flag.

Property Value
Default value: False
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 ml computetarget computeinstance stop

Stop a compute instance.

az ml computetarget computeinstance stop --name
                                         [--no-wait]
                                         [--path]
                                         [--resource-group]
                                         [--subscription-id]
                                         [--workspace-name]
                                         []

Required Parameters

--name -n

Name of compute instance to stop.

Optional Parameters

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

--no-wait

Flag to not wait for asynchronous calls.

--path

Path to a project folder. Default: current directory.

--resource-group -g

Resource group corresponding to the provided workspace.

--subscription-id

Specifies the subscription Id.

--workspace-name -w

Name of the workspace containing the compute target to stop.

-v

Verbosity flag.

Property Value
Default value: False
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