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.
Optional Parameters
Adb Workspace to be linked with this workspace.
Application Insights to be associated with this workspace.
The key vault containing the customer managed key in the Azure resource ID format.
Container Registry to be associated with this workspace.
Do not fail if workspace exists.
Friendly name for this workspace.
Specifies whether the customer data is of High Business Impact(HBI), i.e., contains sensitive business information.
Key Vault to be associated with this workspace.
Location for resource.
Whether private endpoint connections to the workspace resource via a private link should be auto approved.
Name of the workspace private endpoint. Use this parameter to restrict workspace access to private networks, via a private endpoint.
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.
Name of the existing subnet to create the workspace private endpoint in.
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.
Name of the existing vnet to create the workspace private endpoint in.
The resourceId of the user assigned identity that used to represent workspace identity.
The key URI of the customer managed key to encrypt the data at rest.
Resource group name.
SKU/edition of a workspace -can be a 'basic' workspace or a feature rich 'enterprise' workspace.
Storage account to be associated with this workspace.
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.
Tags associated with this workspace with 'key=value' syntax.
The resourceId of the user assigned identity that needs to be used to access the encryption key.
Prevent using v2 API service on public Azure Resource Manager if you set this parameter true. Learn more at aka.ms/amlv2network.
Create a resource group for this workspace.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
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
Deletes resources which this workspace depends on like storage, acr, kv and app insights.
Do not wait for the workspace deletion to complete.
Provide an optional output file location for structured object output.
Path to a root directory for run configuration files.
Resource group name.
Specifies the subscription Id.
Workspace name.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az ml workspace diagnose
Diagnose workspace setup problems.
az ml workspace diagnose [--output-metadata-file]
[--path]
[--resource-group]
[--subscription-id]
[--workspace-name]Optional Parameters
Provide an optional output file location for structured object output.
Path to a root directory for run configuration files.
Resource group name.
Specifies the subscription Id.
Workspace name.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az ml workspace list
List workspaces.
az ml workspace list [--resource-group]Optional Parameters
Resource group name.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
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
Provide an optional output file location for structured object output.
Path to a root directory for run configuration files.
Resource group name.
Specifies the subscription Id.
Workspace name.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
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 to assign to this user.
User with whom to share this workspace.
Optional Parameters
Provide an optional output file location for structured object output.
Path to a root directory for run configuration files.
Resource group name.
Specifies the subscription Id.
Workspace name.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az ml workspace show
Show a workspace.
az ml workspace show [--output-metadata-file]
[--path]
[--resource-group]
[--subscription-id]
[--workspace-name]Optional Parameters
Provide an optional output file location for structured object output.
Path to a root directory for run configuration files.
Resource group name.
Specifies the subscription Id.
Workspace name.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
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
Provide an optional output file location for structured object output.
Path to a root directory for run configuration files.
Resource group name.
Specifies the subscription Id.
Workspace name.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
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
Allow public access to private link workspace.
Description of this workspace.
Friendly name.
Compute target for image build.
Provide an optional output file location for structured object output.
Path to a root directory for run configuration files.
The resourceId of the user assigned identity that used to represent workspace identity.
Resource group name.
Specifies the subscription Id.
Tags associated with this workspace with 'key=value' syntax.
Prevent using v2 API service on public Azure Resource Manager if you set this parameter true. Learn more at aka.ms/amlv2network.
Workspace name.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
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 arm id of the container registry that you want to update this workspace with.
Force update dependent resources without user's confirmation.
Provide an optional output file location for structured object output.
Path to a root directory for run configuration files.
Resource group name.
Specifies the subscription Id.
Workspace name.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for