az ml workspace

Workspace subgroup commands.

Commands

az ml workspace create

Create a workspace.

az ml workspace delete

Delete a workspace.

az ml workspace list

List workspaces.

az ml workspace list-keys

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

az ml workspace private-endpoint

Workspace private endpoint subgroup commands.

az ml workspace private-endpoint add

Add private endpoint to a workspace.

az ml workspace private-endpoint delete

Delete the specified private endpoint Connection in the workspace.

az ml workspace private-endpoint list

List all private endpoints in a workspace.

az ml workspace share

Share a workspace with another user with a given role.

az ml workspace show

Show a workspace.

az ml workspace sync-keys

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

az ml workspace update

Update a workspace.

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]
                       [--resource-cmk-uri]
                       [--resource-group]
                       [--sku]
                       [--storage-account]
                       [--tags]
                       [--yes]

Required Parameters

--workspace-name -w

Workspace name.

Optional Parameters

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

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

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

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

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.

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

default value: basic
--storage-account

Storage account to be associated with this workspace.

--tags -t

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

--yes -y

Create a resource group for this workspace.

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

--all-resources

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

--no-wait

Do not wait for the workspace deletion to complete.

--output-metadata-file -t

Provide an optional output file location for structured object output.

--path

Path to a root directory for run configuration files.

default value: .
--resource-group -g

Resource group name.

--subscription-id

Specifies the subscription Id.

--workspace-name -w

Workspace name.

az ml workspace list

List workspaces.

az ml workspace list [--resource-group]

Optional Parameters

--resource-group -g

Resource group name.

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

--output-metadata-file -t

Provide an optional output file location for structured object output.

--path

Path to a root directory for run configuration files.

default value: .
--resource-group -g

Resource group name.

--subscription-id

Specifies the subscription Id.

--workspace-name -w

Workspace name.

az ml workspace share

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]

Required Parameters

--role

Role to assign to this user.

--user

User with whom to share this workspace.

Optional Parameters

--output-metadata-file -t

Provide an optional output file location for structured object output.

--path

Path to a root directory for run configuration files.

default value: .
--resource-group -g

Resource group name.

--subscription-id

Specifies the subscription Id.

--workspace-name -w

Workspace name.

az ml workspace show

Show a workspace.

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

Optional Parameters

--output-metadata-file -t

Provide an optional output file location for structured object output.

--path

Path to a root directory for run configuration files.

default value: .
--resource-group -g

Resource group name.

--subscription-id

Specifies the subscription Id.

--workspace-name -w

Workspace name.

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

--output-metadata-file -t

Provide an optional output file location for structured object output.

--path

Path to a root directory for run configuration files.

default value: .
--resource-group -g

Resource group name.

--subscription-id

Specifies the subscription Id.

--workspace-name -w

Workspace name.

az ml workspace update

Update a workspace.

az ml workspace update [--description]
                       [--friendly-name]
                       [--image-build-compute]
                       [--output-metadata-file]
                       [--path]
                       [--resource-group]
                       [--subscription-id]
                       [--tags]
                       [--workspace-name]

Optional Parameters

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

default value: .
--resource-group -g

Resource group name.

--subscription-id

Specifies the subscription Id.

--tags

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

--workspace-name -w

Workspace name.