CLI (v2) Azure Container Registry connection YAML schema
APPLIES TO: 
Azure CLI ml extension v2 (current)
Note
The YAML syntax detailed in this document is based on the JSON schema for the latest version of the ML CLI v2 extension. This syntax is guaranteed only to work with the latest version of the ML CLI v2 extension. You can find the schemas for older extension versions at https://azuremlschemasprod.azureedge.net/.
YAML syntax
| Key | Type | Description | Allowed values | Default value |
|---|---|---|---|---|
$schema |
string | The YAML schema. If you use the Azure Machine Learning Visual Studio Code extension to author the YAML file, include $schema at the top of your file to invoke schema and resource completions. |
||
name |
string | Required. The connection name. | ||
description |
string | The connection description. | ||
tags |
object | The connection tag dictionary. | ||
type |
string | Required. The connection type. | container_registry |
container_registry |
is_shared |
boolean | true if the connection is shared across other projects in the hub; otherwise, false. |
true |
|
target |
string | The URL of the endpoint. | ||
credentials |
object | Credential-based authentication to access the storage account. A Microsoft Entra ID or username and password can be used. | ||
credentials.type |
string | The type of authentication to use. | managed_identity, username_password |
|
credentials.client_id |
string | The Microsoft Entra ID client ID. | ||
credentials.resource_id |
string | The Microsoft Entra ID resource ID. | ||
credentials_username |
string | The username to authenticate with. | ||
credentials_password |
string | The password to authenticate with. |
Remarks
While the az ml connection commands can be used to manage both Azure Machine Learning and Azure AI Studio connections.
Examples
These examples would be in the form of YAML files and used from the CLI. For example, az ml connection create -f <file-name>.yaml.
YAML: Microsoft Entra ID managed identity
name: test_ws_conn_cr_managed
type: container_registry
target: https://test-feed.com
credentials:
type: managed_identity
client_id: client_id
resource_id: resource_id
YAML: Username and password
name: test_ws_conn_cr_user_pass
type: container_registry
target: https://test-feed.com2
credentials:
type: username_password
username: contoso
password: pass