az ml computetarget attach

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 attach command. Learn more about extensions.

Attach subgroup commands.

Commands

Name Description Type Status
az ml computetarget attach aks

Attach an AKS cluster to the workspace.

Extension GA
az ml computetarget attach kubernetes

Attach a KubernetesCompute as a compute target to the workspace.

Extension GA
az ml computetarget attach remote

Attach a remote machine without Docker as a compute target to the workspace.

Extension GA

az ml computetarget attach aks

Attach an AKS cluster to the workspace.

az ml computetarget attach aks --compute-resource-id
                               --name
                               [--resource-group]
                               [--workspace-name]

Required Parameters

--compute-resource-id -i

Resource ID of the compute object to attach to the workspace.

--name -n

Specifies the compute target name. Must be unique to the workspace.

Optional Parameters

--resource-group -g

Resource group corresponding to the provided workspace. A default value for all commands can be set by running "az configure --defaults group=". This parameter will override any set default.

--workspace-name -w

Name of the workspace to create this compute target under. A default value for all commands can be set by running "az configure --defaults workspace_name=". This parameter will override any set default.

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 ml computetarget attach kubernetes

Attach a KubernetesCompute as a compute target to the workspace.

az ml computetarget attach kubernetes --compute-resource-id
                                      --name
                                      [--namespace]
                                      [--resource-group]
                                      [--workspace-name]

Required Parameters

--compute-resource-id -i

Resource ID of the compute object to attach to the workspace.

--name -n

Specifies the compute target name. Must be unique to the workspace.

Optional Parameters

--namespace

The Kubernetes namespace to which workloads for the compute target are submitted.

--resource-group -g

Resource group corresponding to the provided workspace. A default value for all commands can be set by running "az configure --defaults group=". This parameter will override any set default.

--workspace-name -w

Name of the workspace to create this compute target under. A default value for all commands can be set by running "az configure --defaults workspace_name=". This parameter will override any set default.

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 ml computetarget attach remote

Attach a remote machine without Docker as a compute target to the workspace.

az ml computetarget attach remote --address
                                  --name
                                  --ssh-port
                                  --username
                                  [--password]
                                  [--private-key-file]
                                  [--private-key-passphrase]
                                  [--resource-group]
                                  [--workspace-name]

Required Parameters

--address -a

DNS name or IP address of the target.

--name -n

Specifies the compute target name. Must be unique to the workspace.

--ssh-port

Ssh port that can be use to connect to the compute.

Default value: 22
--username -u

The username for the remote machine being attached. Must also provide either a password or public and private key files.

Optional Parameters

--password -p

The password for the remote machine being attached. Must either provide a password or public and private key files.

--private-key-file

Path to a file containing the private key information for the remote machine being attached.

--private-key-passphrase

Passphrase for private key specified with the --private-key-file option.

--resource-group -g

Resource group corresponding to the provided workspace. A default value for all commands can be set by running "az configure --defaults group=". This parameter will override any set default.

--workspace-name -w

Name of the workspace to create this compute target under. A default value for all commands can be set by running "az configure --defaults workspace_name=". This parameter will override any set default.

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.