CLI (v2) custom key 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.	custom	custom
is_shared	boolean	true if the connection is shared across other projects in the hub; otherwise, false.		true
configs	object	Contains several keys, which are non-credentials.
configs.<key1>	string	A key.
secrets	object	Required. Contains one or more secrets. At least one key is required.
secrets.<key1>	string	A secret for the matching key.

Remarks

While the az ml connection commands can be used to manage both Azure Machine Learning and Microsoft Foundry connections, the custom key connection is specific to Foundry.

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: custom key

name: test_ws_conn_custom_keys
type: custom
target: my_endpoint
tags:
  one: two
credentials:
  type: api_key
  key: "4444"

Next steps

• Install and use the CLI (v2)