CLI (v2) registry YAML schema

  • Article

APPLIES TO: Azure CLI ml extension v2 (current)

The source JSON schema can be found at https://azuremlschemasprod.azureedge.net/latest/registry.schema.json.

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 VS Code extension to author the YAML file, including $schema at the top of your file enables you to invoke schema and resource completions.
name string Required. Name of the registry.
tags object Dictionary of tags for the registry.
location string Required. The primary location of the registry.
replication_locations object Required. List of locations where the associated resources of the registry will be replicated. The list must include the primary location of registry.
public_network_access string Whether public endpoint access is allowed if the registry will be using Private Link. enabled, disabled enabled

Remarks

The az ml registry command can be used for managing Azure Machine Learning registries.

Examples

Examples are available in the examples GitHub repository. Several are shown in the following sections.

YAML: basic

name: DemoRegistry
tags:
  foo: bar
  description: Basic registry with one primary region and to additional regions
location: chinanorth3
replication_locations:
  - location: chinanorth3
  - location: chinanorth3
  - location: chinaeast2
  - location: chinaeast2

YAML: with storage options

name: DemoRegistry2
tags:
  foo: bar
  description: Registry with additional configuration for storage accounts
location: chinanorth3
replication_locations:
  - location: chinanorth3
    storage_config:
      storage_account_hns: False
      storage_account_type: Standard_LRS
  - location: chinanorth3
    storage_config:
      storage_account_hns: False
      storage_account_type: Standard_LRS
  - location: chinaeast2
    storage_config:
      storage_account_hns: False
      storage_account_type: Standard_LRS

Next steps