az ml workspace

Note

This reference is part of the azure-cli-ml extension for the Azure CLI (version 2.0.28 or higher). The extension will automatically install the first time you run an az ml workspace command. Learn more about extensions.

Workspace subgroup commands.

Commands

Name	Description	Type	Status
az ml workspace create	Create a workspace.	Extension	GA
az ml workspace delete	Delete a workspace.	Extension	GA
az ml workspace diagnose	Diagnose workspace setup problems.	Extension	GA
az ml workspace list	List workspaces.	Extension	GA
az ml workspace list-keys	List workspace keys for dependent resources such as storage, acr, and app insights.	Extension	GA
az ml workspace private-endpoint	Workspace private endpoint subgroup commands.	Extension	GA
az ml workspace private-endpoint add	Add private endpoint to a workspace.	Extension	GA
az ml workspace private-endpoint delete	Delete the specified private endpoint Connection in the workspace.	Extension	GA
az ml workspace private-endpoint list	List all private endpoints in a workspace.	Extension	GA
az ml workspace share	Share a workspace with another user with a given role.	Extension	GA
az ml workspace show	Show a workspace.	Extension	GA
az ml workspace sync-keys	Sync workspace keys for dependent resources such as storage, acr, and app insights.	Extension	GA
az ml workspace update	Update a workspace.	Extension	GA
az ml workspace update-dependencies	Update workspace dependent resources.	Extension	GA

az ml workspace create

Create a workspace.

az ml workspace create --workspace-name
                       [--adb-workspace]
                       [--application-insights]
                       [--cmk-keyvault]
                       [--container-registry]
                       [--exist-ok]
                       [--friendly-name]
                       [--hbi-workspace]
                       [--keyvault]
                       [--location]
                       [--pe-auto-approval]
                       [--pe-name]
                       [--pe-resource-group]
                       [--pe-subnet-name]
                       [--pe-subscription-id]
                       [--pe-vnet-name]
                       [--primary-user-assigned-identity]
                       [--resource-cmk-uri]
                       [--resource-group]
                       [--sku]
                       [--storage-account]
                       [--system_datastores_auth_mode]
                       [--tags]
                       [--user-assigned-identity-for-cmk-encryption]
                       [--v1-legacy-mode]
                       [--yes]

Required Parameters

--workspace-name -w

Workspace name.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--adb-workspace

Adb Workspace to be linked with this workspace.

--application-insights

Application Insights to be associated with this workspace.

--cmk-keyvault

The key vault containing the customer managed key in the Azure resource ID format.

--container-registry

Container Registry to be associated with this workspace.

--exist-ok

Do not fail if workspace exists.

Property	Value
Default value:	False

--friendly-name -f

Friendly name for this workspace.

--hbi-workspace

Specifies whether the customer data is of High Business Impact(HBI), i.e., contains sensitive business information.

Property	Value
Default value:	False

--keyvault

Key Vault to be associated with this workspace.

--location -l

Location for resource.

--pe-auto-approval

Whether private endpoint connections to the workspace resource via a private link should be auto approved.

Property	Value
Default value:	False

--pe-name

Name of the workspace private endpoint. Use this parameter to restrict workspace access to private networks, via a private endpoint.

--pe-resource-group

Name of the existing resource group to create the workspace private endpoint in. The vnet should be in the same resource group. If not specified, the resource group of the workspace will be used.

--pe-subnet-name

Name of the existing subnet to create the workspace private endpoint in.

Property	Value
Default value:	default

--pe-subscription-id

Id of the existing subscription to create the workspace private endpoint in. The vnet should be in the same subscription. If not specified, the subscription Id of the workspace will be used.

--pe-vnet-name

Name of the existing vnet to create the workspace private endpoint in.

--primary-user-assigned-identity

The resourceId of the user assigned identity that used to represent workspace identity.

--resource-cmk-uri

The key URI of the customer managed key to encrypt the data at rest.

--resource-group -g

Resource group name.

--sku

SKU/edition of a workspace -can be a 'basic' workspace or a feature rich 'enterprise' workspace.

Property	Value
Default value:	basic

--storage-account

Storage account to be associated with this workspace.

--system_datastores_auth_mode

Determines whether or not to use credentials for the system datastores of the workspace 'workspaceblobstore' and 'workspacefilestore'. The default value is 'accessKey', in which case, the workspace will create the system datastores with credentials. If set to 'identity', the workspace will create the system datastores with no credentials.

Property	Value
Default value:	accessKey

--tags -t

Tags associated with this workspace with 'key=value' syntax.

--user-assigned-identity-for-cmk-encryption

The resourceId of the user assigned identity that needs to be used to access the encryption key.

--v1-legacy-mode -v

Prevent using v2 API service on public Azure Resource Manager if you set this parameter true. Learn more at aka.ms/amlv2network.

--yes -y

Create a resource group for this workspace.

Property	Value
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

az ml workspace delete

Delete a workspace.

az ml workspace delete [--all-resources]
                       [--no-wait]
                       [--output-metadata-file]
                       [--path]
                       [--resource-group]
                       [--subscription-id]
                       [--workspace-name]

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--all-resources

Deletes resources which this workspace depends on like storage, acr, kv and app insights.

Property	Value
Default value:	False

--no-wait

Do not wait for the workspace deletion to complete.

Property	Value
Default value:	False

--output-metadata-file -t

Provide an optional output file location for structured object output.

--path

Path to a root directory for run configuration files.

Property	Value
Default value:	.

--resource-group -g

Resource group name.

--subscription-id

Specifies the subscription Id.

--workspace-name -w

Workspace name.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

az ml workspace diagnose

Diagnose workspace setup problems.

az ml workspace diagnose [--output-metadata-file]
                         [--path]
                         [--resource-group]
                         [--subscription-id]
                         [--workspace-name]

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--output-metadata-file -t

Provide an optional output file location for structured object output.

--path

Path to a root directory for run configuration files.

Property	Value
Default value:	.

--resource-group -g

Resource group name.

--subscription-id

Specifies the subscription Id.

--workspace-name -w

Workspace name.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

az ml workspace list

List workspaces.

az ml workspace list [--resource-group]

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--resource-group -g

Resource group name.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

az ml workspace list-keys

List workspace keys for dependent resources such as storage, acr, and app insights.

az ml workspace list-keys [--output-metadata-file]
                          [--path]
                          [--resource-group]
                          [--subscription-id]
                          [--workspace-name]

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--output-metadata-file -t

Provide an optional output file location for structured object output.

--path

Path to a root directory for run configuration files.

Property	Value
Default value:	.

--resource-group -g

Resource group name.

--subscription-id

Specifies the subscription Id.

--workspace-name -w

Workspace name.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

Share a workspace with another user with a given role.

az ml workspace share --role
                      --user
                      [--output-metadata-file]
                      [--path]
                      [--resource-group]
                      [--subscription-id]
                      [--workspace-name]

--role

Role to assign to this user.

--user

User with whom to share this workspace.

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--output-metadata-file -t

Provide an optional output file location for structured object output.

--path

Path to a root directory for run configuration files.

Property	Value
Default value:	.

--resource-group -g

Resource group name.

--subscription-id

Specifies the subscription Id.

--workspace-name -w

Workspace name.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

az ml workspace show

Show a workspace.

az ml workspace show [--output-metadata-file]
                     [--path]
                     [--resource-group]
                     [--subscription-id]
                     [--workspace-name]

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--output-metadata-file -t

Provide an optional output file location for structured object output.

--path

Path to a root directory for run configuration files.

Property	Value
Default value:	.

--resource-group -g

Resource group name.

--subscription-id

Specifies the subscription Id.

--workspace-name -w

Workspace name.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

az ml workspace sync-keys

Sync workspace keys for dependent resources such as storage, acr, and app insights.

az ml workspace sync-keys [--output-metadata-file]
                          [--path]
                          [--resource-group]
                          [--subscription-id]
                          [--workspace-name]

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--output-metadata-file -t

Provide an optional output file location for structured object output.

--path

Path to a root directory for run configuration files.

Property	Value
Default value:	.

--resource-group -g

Resource group name.

--subscription-id

Specifies the subscription Id.

--workspace-name -w

Workspace name.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

az ml workspace update

Update a workspace.

az ml workspace update [--allow-public-access]
                       [--description]
                       [--friendly-name]
                       [--image-build-compute]
                       [--output-metadata-file]
                       [--path]
                       [--primary-user-assigned-identity]
                       [--resource-group]
                       [--subscription-id]
                       [--tags]
                       [--v1-legacy-mode]
                       [--workspace-name]

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--allow-public-access

Allow public access to private link workspace.

--description -d

Description of this workspace.

--friendly-name -f

Friendly name.

--image-build-compute

Compute target for image build.

--output-metadata-file -t

Provide an optional output file location for structured object output.

--path

Path to a root directory for run configuration files.

Property	Value
Default value:	.

--primary-user-assigned-identity

The resourceId of the user assigned identity that used to represent workspace identity.

--resource-group -g

Resource group name.

--subscription-id

Specifies the subscription Id.

--tags

Tags associated with this workspace with 'key=value' syntax.

--v1-legacy-mode -v

Prevent using v2 API service on public Azure Resource Manager if you set this parameter true. Learn more at aka.ms/amlv2network.

--workspace-name -w

Workspace name.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

az ml workspace update-dependencies

Update workspace dependent resources.

az ml workspace update-dependencies [--acr]
                                    [--force]
                                    [--output-metadata-file]
                                    [--path]
                                    [--resource-group]
                                    [--subscription-id]
                                    [--workspace-name]

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acr

The arm id of the container registry that you want to update this workspace with.

--force

Force update dependent resources without user's confirmation.

Property	Value
Default value:	False

--output-metadata-file -t

Provide an optional output file location for structured object output.

--path

Path to a root directory for run configuration files.

Property	Value
Default value:	.

--resource-group -g

Resource group name.

--subscription-id

Specifies the subscription Id.

--workspace-name -w

Workspace name.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

Share via

az ml workspace

Commands

az ml workspace create

Required Parameters

Optional Parameters

az ml workspace delete

Optional Parameters

az ml workspace diagnose

Optional Parameters

az ml workspace list

Optional Parameters

az ml workspace list-keys

Optional Parameters

az ml workspace share

Required Parameters

Optional Parameters

az ml workspace show

Optional Parameters

az ml workspace sync-keys

Optional Parameters

az ml workspace update

Optional Parameters

az ml workspace update-dependencies

Optional Parameters

Feedback