az ml workspace-hub

  • Preview
  • 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 workspace-hub 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 WorkspaceHub.

An WorkspaceHub is a resource used to help manage and create Azure Machine Learning workspaces. It provides a centralized Azure setup for a group of Azure ML workspaces.

Commands

Name Description Type Status
az ml workspace-hub create

Create a WorkspaceHub.

 Extension Preview
az ml workspace-hub delete

Delete a WorkspaceHub.

 Extension Preview
az ml workspace-hub list

List all the WorkspaceHubs in a subscription.

 Extension Preview
az ml workspace-hub show

Show details for a WorkspaceHub.

 Extension Preview
az ml workspace-hub update

Update a WorkspaceHub.

 Extension Preview

az ml workspace-hub create

Preview

Command group 'ml workspace-hub' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Create a WorkspaceHub.

When a WorkspaceHub is created, several Azure resources that will be used by Azure ML also get created by default: Azure Storage, Azure Key Vault. You can instead use existing Azure resource instances for those when creating the WorkspaceHub by specifying the resource IDs in the WorkspaceHub's configuration YAML file.

az ml workspace-hub create --resource-group
                           [--additional-workspace-storage-accounts]
                           [--container-registry]
                           [--default-workspace-resource-group]
                           [--description]
                           [--display-name]
                           [--file]
                           [--key-vault]
                           [--location]
                           [--managed-network]
                           [--name]
                           [--no-wait]
                           [--primary-user-assigned-identity]
                           [--public-network-access]
                           [--set]
                           [--storage-account]
                           [--tags]
                           [--update-dependent-resources]

Examples

Create a WorkspaceHub from a YAML specification file.

az ml workspace-hub create --file workspace-hub.yml --resource-group my-resource-group

Required Parameters

--resource-group -g

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

Optional Parameters

--additional-workspace-storage-accounts -a

A list of comma separated resource IDs of existing storage accounts that will be utilized in addition to the default one.

--container-registry -c

ARM id of the container registry associated with this WorkspaceHub.

--default-workspace-resource-group -d

A destination resource group for any Project workspaces that join the workspaceHub, it will be the workspaceHub's resource group by default.

--description

Description of the Azure ML WorkspaceHub.

--display-name

Display name for the WorkspaceHub.

--file -f

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

--key-vault -k

ARM id of the key vault associated with this WorkspaceHub.

--location -l

The location to be used for the new WorkspaceHub.

--managed-network -m
Preview

Managed Network Isolation Mode for the WorkspaceHub.

--name -n

Name of the Azure ML WorkspaceHub.

--no-wait

Do not wait for WorkspaceHub creation to finish.

default value: False
--primary-user-assigned-identity -p

ARM identifier of primary user assigned managed identity, in case multiple ones are specified. Also the default managed identity for clusterless compute.

--public-network-access

Allow public endpoint connectivity when a WorkspaceHub is private link enabled.

--set

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

--storage-account -s

ARM id of the storage account associated with this WorkspaceHub.

--tags

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

--update-dependent-resources -u

Specifying --update_dependent_resources, gives your consent to update the workspace dependent resources. Updating the workspace-attached Azure Container Registry or Application Insights resource may break lineage of previous jobs, deployed inference endpoints, or your ability to rerun earlier jobs in this workspace.

default value: False
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 workspace-hub delete

Preview

Command group 'ml workspace-hub' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Delete a WorkspaceHub.

By default the dependent resources associated with the WorkspaceHub (Azure Storages, Azure Container Registries, Azure Key Vaults) are not deleted. To delete those as well, include --all-resources. To permanently delete the WorkspaceHub, include --permanently-delete.

az ml workspace-hub delete --name
                           --resource-group
                           [--all-resources]
                           [--no-wait]
                           [--permanently-delete]
                           [--yes]

Required Parameters

--name -n

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

--resource-group -g

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

Optional Parameters

--all-resources

Delete all the dependent resources associated with the WorkspaceHub (Azure Storage account, Azure Container Registry, Azure Application Insights, Azure Key Vault).

default value: False
--no-wait

Do not wait for the long-running-operation to finish. Default is False.

default value: False
--permanently-delete -p

WorkspaceHub are soft-deleted state by default to allow recovery of data. Set this flag to override the soft-delete behavior and permanently delete your workspace-hub.

default value: False
--yes -y

Do not prompt for confirmation.

default value: False
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 workspace-hub list

Preview

Command group 'ml workspace-hub' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List all the WorkspaceHubs in a subscription.

The list of WorkspaceHub can be filtered by resource group.

az ml workspace-hub list [--max-results]
                         [--resource-group]

Examples

List all the WorkspaceHubs in a resource group

az ml workspace-hub list --resource-group my-resource-group

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

az ml workspace-hub 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 workspace-hub show

Preview

Command group 'ml workspace-hub' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Show details for a WorkspaceHub.

az ml workspace-hub show --name
                         --resource-group

Required Parameters

--name -n

Name of the Azure ML WorkspaceHub. You can configure the default group using az configure --defaults workspace=<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 workspace-hub update

Preview

Command group 'ml workspace-hub' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Update a WorkspaceHub.

The 'description', 'tags', and 'friendly_name' properties can be updated.

az ml workspace-hub update --name
                           --resource-group
                           [--add]
                           [--description]
                           [--display-name]
                           [--file]
                           [--force-string]
                           [--managed-network]
                           [--no-wait]
                           [--primary-user-assigned-identity]
                           [--public-network-access]
                           [--remove]
                           [--set]
                           [--update-dependent-resources]

Examples

update a WorkspaceHub from a YAML specification file.

az ml workspace-hub update --resource-group my-resource-group --name my-workspace-hub-name --file workspace-hub.yml

Required Parameters

--name -n

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

--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: []
--description

Description of the Azure ML WorkspaceHub.

--display-name

Display name for the WorkspaceHub.

--file -f

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

--force-string

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

default value: False
--managed-network -m
Preview

Managed Network Isolation Mode for the WorkspaceHub.

--no-wait

Do not wait for the long-running-operation to finish. Default is False.

default value: False
--primary-user-assigned-identity -p

ARM id of the primary user assigned identity associated with this WorkspaceHub.

--public-network-access

Allow public endpoint connectivity when a WorkspaceHub is private link enabled.

--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: []
--update-dependent-resources -u

Specifying --update_dependent_resources, gives your consent to update the workspace dependent resources. Updating the workspace-attached Azure Container Registry or Application Insights resource may break lineage of previous jobs, deployed inference endpoints, or your ability to rerun earlier jobs in this workspace.

default value: False
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.