az ml connection
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
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
Local path to the YAML file containing the Azure ML connection specification.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name of the Azure ML workspace. You can configure the default workspace using az configure --defaults workspace=<name>
.
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Name of the environment.
For API key-based connections, try to populate the returned credentials with the actual secret value. Does nothing for non-API key-based connections.
Property | Value |
---|---|
Default value: | False |
Update an object by specifying a property path and value to set. Example: --set property1.property2=value.
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az ml connection delete
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 of the environment.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name of the Azure ML workspace. You can configure the default workspace using az configure --defaults workspace=<name>
.
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Do not prompt for confirmation.
Property | Value |
---|---|
Default value: | False |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az ml connection list
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
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name of the Azure ML workspace. You can configure the default workspace using az configure --defaults workspace=<name>
.
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Max number of results to return.
For API key-based connections, try to populate the returned credentials with the actual secret value. Does nothing for non-API key-based connections.
Property | Value |
---|---|
Default value: | False |
The type of Azure ML connection to list.
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az ml connection show
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 of the environment.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name of the Azure ML workspace. You can configure the default workspace using az configure --defaults workspace=<name>
.
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
For API key-based connections, try to populate the returned credentials with the actual secret value. Does nothing for non-API key-based connections.
Property | Value |
---|---|
Default value: | False |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az ml connection update
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 of the environment.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name of the Azure ML workspace. You can configure the default workspace using az configure --defaults workspace=<name>
.
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
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>
.
Property | Value |
---|---|
Parameter group: | Generic Update Arguments |
Default value: | [] |
When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
Property | Value |
---|---|
Parameter group: | Generic Update Arguments |
Default value: | False |
For API key-based connections, try to populate the returned credentials with the actual secret value. Does nothing for non-API key-based connections.
Property | Value |
---|---|
Default value: | False |
Remove a property or an element from a list. Example: --remove property.list <indexToRemove>
OR --remove propertyToRemove
.
Property | Value |
---|---|
Parameter group: | Generic Update Arguments |
Default value: | [] |
Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>
.
Property | Value |
---|---|
Parameter group: | Generic Update Arguments |
Default value: | [] |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |