Share via

az ml registry

  • Reference

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 registry command. Learn more about extensions.

Manage Azure ML registries.

An Azure ML registry is a top-level resource for Azure Machine Learning. It provides a top-level space to store other resources, which can then be accessed by multiple workspaces across different regions.

Commands

Name Description Type Status
az ml registry create

Create a registry.

 Extension GA
az ml registry delete

Delete a given registry.

 Extension GA
az ml registry list

List all the registries in a subscription or resource group.

 Extension GA
az ml registry show

Show details for a registry.

 Extension GA
az ml registry update

Update a registry.

 Extension GA

az ml registry create

Create a registry.

When a registry is created, several Azure resources that will be used by registry get created by default, specifically an Azure Storage and Azure Container Registry. Using existing Azure resource instances for those when creating the registry is not supported.

az ml registry create --resource-group
                      [--display-name]
                      [--file]
                      [--name]
                      [--no-wait]
                      [--public-network-access]
                      [--set]
                      [--tags]

Examples

Create a registry from a YAML specification file.

az ml registry create --resource-group my-resource-group --file registry.yml

Required Parameters

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--display-name

Display name for the registry.

--file -f

Local path to the YAML file containing the Azure ML registry specification. The YAML reference docs for registry can be found at: https://aka.ms/ml-cli-v2-registry-yaml-reference.

--name -n

Name of the Azure ML registry.

--no-wait

Do not wait for registry creation to finish.

Default value: False
--public-network-access

Allow public endpoint connectivity for a registry.

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=.

--tags

Space-separated key-value pairs for the tags of the object.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az ml registry delete

Delete a given registry.

az ml registry delete [--name]
                      [--resource-group]

Examples

Delete a registry from a specific resource group.

az ml registry delete --resource-group my-resource-group --name my-registry-name

Optional Parameters

--name -n

Name of the Azure ML registry. You can configure the default group using az configure --defaults registry=<name>.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az ml registry list

List all the registries in a subscription or resource group.

az ml registry list [--max-results]
                    [--resource-group]

Examples

List all registries in the default resource group and subscription id.

az ml registry list

List all registries in the default resource group in the specified subscription. If no default resource group is set, then list all registries in the subscription.

az ml registry list --subscription my-subscription-id

List all registries in a specific resource group and subscription.

az ml registry list --resource-group my-resource-group --subscription my-subscription-id

List all registries using --query argument to execute a JMESPath query on the results of commands.

az ml registry list --query "[].{Name:name}"  --output table --resource-group my-resource-group

Optional Parameters

--max-results -r

Max number of results to return.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az ml registry show

Show details for a registry.

az ml registry show --name
                    --resource-group

Examples

Show details of a named registry that is in the specified resource group and subscription.

az ml registry show --resource-group my-resource-group --subscription my-subscription-id --name my-registry-name

Required Parameters

--name -n

Name of the Azure ML registry. You can configure the default group using az configure --defaults registry=<name>.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az ml registry update

Update a registry.

Update a registry. This command mostly behaves like the create command, except this is ensures that the target registry exists, and it can be run without a --file input if a valid --name input is provided. Fields can be modified by defining new values in YAML, the --set argument, or the fields' normal input arguments. Not all fields are currently safe to modify. Valid modifications include: Arbitrary changes to the registry tags, and adding new values to the region_details field. WARNING: The --file argument is incompatible with modifying values through --set. If you wish to set registry using a combination of a file and CLI args, use the direct CLI args for the values you wish to modify, as exemplified below.

az ml registry update --resource-group
                      [--add]
                      [--display-name]
                      [--file]
                      [--force-string]
                      [--name]
                      [--no-wait]
                      [--public-network-access]
                      [--remove]
                      [--set]
                      [--tags]

Examples

Update a registry from a YAML specification file.

az ml registry update --resource-group my-resource-group --file registry.yml --tags tag=value

Update specific fields of a registry

az ml registry update --resource-group my-resource-group --name myRegistry --set tags.tag=value

Required Parameters

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--add

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>.

Default value: []
--display-name

Display name for the registry.

--file -f

Local path to the YAML file containing the Azure ML registry specification. The YAML reference docs for registry can be found at: https://aka.ms/ml-cli-v2-registry-yaml-reference.

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Default value: False
--name -n

Name of the Azure ML registry.

--no-wait

Do not wait for registry update to finish.

Default value: False
--public-network-access

Allow public endpoint connectivity for a registry.

--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Default value: []
--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

Default value: []
--tags

Space-separated key-value pairs for the tags of the object.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.