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.
Azure ML workspace 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 workspace connection. |
Extension | Preview |
az ml connection delete |
Delete a workspace connection. |
Extension | Preview |
az ml connection list |
List all the workspaces connection. |
Extension | Preview |
az ml connection show |
Show details of a workspace connection. |
Extension | Preview |
az ml connection update |
Update a workspace 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 workspace connection.
Workspace 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]
[--set]
Examples
Create a workspace connection from a YAML specification file.
az ml connection create --file connection.yml --resource-group my-resource-group --workspace-name my-workspace
Required Parameters
Local path to the YAML file containing the Azure ML workspace 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
Name of the environment.
Update an object by specifying a property path and value to set. Example: --set property1.property2=.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
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.
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 workspace 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
Do not prompt for confirmation.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
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.
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 the workspaces connection.
The list of connections in a workspace.
az ml connection list --resource-group
--workspace-name
[--max-results]
[--type]
Examples
List all connections in a workspace
az ml connection list --resource-group my-resource-group --workspace-name my-workspace
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
Max number of results to return.
The type of Azure ML workspace connection to list.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
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.
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 workspace connection.
az ml connection show --name
--resource-group
--workspace-name
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>
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
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.
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 workspace connection.
az ml connection update --name
--resource-group
--workspace-name
[--add]
[--force-string]
[--remove]
[--set]
Examples
update a workspace connection from a YAML specification file.
az ml connection update --resource-group my-resource-group --name my-workspace-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
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>
.
When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
Remove a property or an element from a list. Example: --remove property.list <indexToRemove>
OR --remove propertyToRemove
.
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.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
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.
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for