Share via

az ml connection

  • Preview
  • Reference

Note

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

This command group is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage Azure ML workspace connection and its more specific derivatives.

Azure ML connection provides a secure way to store authentication and configuration information needed to connect and interact with the external resources.

Commands

Name Description Type Status
az ml connection create

Create a connection.

 Extension Preview
az ml connection delete

Delete a connection.

 Extension Preview
az ml connection list

List all connections.

 Extension Preview
az ml connection show

Show details of a connection.

 Extension Preview
az ml connection update

Update a connection.

 Extension Preview

az ml connection create

Preview

Command group 'ml connection' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Create a connection.

Connection allow to store authentication and configuration information needed to connect and interact with the external resources.

az ml connection create --file
                        --resource-group
                        --workspace-name
                        [--name]
                        [--populate-secrets]
                        [--set]

Examples

Create a connection from a YAML specification file.

az ml connection create --file connection.yml --resource-group my-resource-group --workspace-name my-workspace

Create a connection from a YAML specification file, and show the API key in the returned connection for verification.

az ml connection create --file connection.yml --resource-group my-resource-group --workspace-name my-workspace --populate-secrets

Required Parameters

--file -f

Local path to the YAML file containing the Azure ML connection specification.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--workspace-name -w

Name of the Azure ML workspace. You can configure the default workspace using az configure --defaults workspace=<name>.

Optional Parameters

--name -n

Name of the environment.

--populate-secrets -p

For API key-based connections, try to populate the returned credentials with the actual secret value. Does nothing for non-API key-based connections.

Default value: False
--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=.

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

Preview

Command group 'ml connection' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Delete a connection.

az ml connection delete --name
                        --resource-group
                        --workspace-name
                        [--yes]

Required Parameters

--name -n

Name of the environment.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--workspace-name -w

Name of the Azure ML workspace. You can configure the default workspace using az configure --defaults workspace=<name>.

Optional Parameters

--yes -y

Do not prompt for confirmation.

Default value: False
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 connection list

Preview

Command group 'ml connection' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List all connections.

The list of connections in a workspace.

az ml connection list --resource-group
                      --workspace-name
                      [--max-results]
                      [--populate-secrets]
                      [--type]

Examples

List all connections in a workspace

az ml connection list --resource-group my-resource-group --workspace-name my-workspace

List all connections in a workspace, and show the API key for applicable connections

az ml connection list --resource-group my-resource-group --workspace-name my-workspace --populate-secrets

List all the connections in a workspace using --query argument to execute a JMESPath query on the results of commands.

az ml connection list --query "[].{Name:name}"  --output table --resource-group my-resource-group --workspace-name my-workspace

Required Parameters

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--workspace-name -w

Name of the Azure ML workspace. You can configure the default workspace using az configure --defaults workspace=<name>.

Optional Parameters

--max-results -r

Max number of results to return.

--populate-secrets -p

For API key-based connections, try to populate the returned credentials with the actual secret value. Does nothing for non-API key-based connections.

Default value: False
--type -t

The type of Azure ML connection to list.

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

Preview

Command group 'ml connection' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Show details of a connection.

az ml connection show --name
                      --resource-group
                      --workspace-name
                      [--populate-secrets]

Examples

Show details of a connection, including its API key.

az ml connection show --resource-group my-resource-group --name my-connection-name --workspace-name my-workspace --populate-secrets

Required Parameters

--name -n

Name of the environment.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--workspace-name -w

Name of the Azure ML workspace. You can configure the default workspace using az configure --defaults workspace=<name>.

Optional Parameters

--populate-secrets -p

For API key-based connections, try to populate the returned credentials with the actual secret value. Does nothing for non-API key-based connections.

Default value: False
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 connection update

Preview

Command group 'ml connection' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Update a connection.

az ml connection update --name
                        --resource-group
                        --workspace-name
                        [--add]
                        [--force-string]
                        [--populate-secrets]
                        [--remove]
                        [--set]

Examples

update a connection from a YAML specification file.

az ml connection update --resource-group my-resource-group --name my-connection-name --workspace-name my-workspace

Required Parameters

--name -n

Name of the environment.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--workspace-name -w

Name of the Azure ML workspace. You can configure the default workspace using az configure --defaults workspace=<name>.

Optional Parameters

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

Default value: []
--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Default value: False
--populate-secrets -p

For API key-based connections, try to populate the returned credentials with the actual secret value. Does nothing for non-API key-based connections.

Default value: False
--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Default value: []
--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

Default value: []
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.