az databricks workspace
Note
This reference is part of the databricks extension for the Azure CLI (version 2.45.0 or higher). The extension will automatically install the first time you run an az databricks workspace command. Learn more about extensions.
Commands to manage databricks workspace.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| az databricks workspace create |
Create a new workspace. |
Extension | GA |
| az databricks workspace delete |
Delete the workspace. |
Extension | GA |
| az databricks workspace list |
Get all the workspaces. |
Extension | GA |
| az databricks workspace outbound-endpoint |
Commands to manage endpoints in the specified workspace. |
Extension | GA |
| az databricks workspace outbound-endpoint list |
List the list of endpoints that VNET Injected Workspace calls Azure Databricks Control Plane. You must configure outbound access with these endpoints. For more information, see https://docs.microsoft.com/en-us/azure/databricks/administration-guide/cloud-configurations/azure/udr. |
Extension | GA |
| az databricks workspace private-endpoint-connection |
Commands to manage databricks workspace private endpoint connections. |
Extension | GA |
| az databricks workspace private-endpoint-connection create |
Create the status of a private endpoint connection with the specified name. |
Extension | GA |
| az databricks workspace private-endpoint-connection delete |
Delete private endpoint connection with the specified name. |
Extension | GA |
| az databricks workspace private-endpoint-connection list |
List private endpoint connections of the workspace. |
Extension | GA |
| az databricks workspace private-endpoint-connection show |
Get a private endpoint connection properties for a workspace. |
Extension | GA |
| az databricks workspace private-endpoint-connection update |
Update the status of a private endpoint connection with the specified name. |
Extension | GA |
| az databricks workspace private-endpoint-connection wait |
Place the CLI in a waiting state until a condition is met. |
Extension | GA |
| az databricks workspace private-link-resource |
Commands to manage databricks workspace private link resources. |
Extension | GA |
| az databricks workspace private-link-resource list |
List private link resources for a given workspace. |
Extension | GA |
| az databricks workspace private-link-resource show |
Get the specified private link resource for the given group id (sub-resource). |
Extension | GA |
| az databricks workspace show |
Show the workspace. |
Extension | GA |
| az databricks workspace update |
Update the workspace. |
Extension | GA |
| az databricks workspace vnet-peering |
Commands to manage databricks workspace vnet peering. |
Extension | GA |
| az databricks workspace vnet-peering create |
Create a vnet peering for a workspace. |
Extension | GA |
| az databricks workspace vnet-peering delete |
Delete the vnet peering. |
Extension | GA |
| az databricks workspace vnet-peering list |
List vnet peerings under a workspace. |
Extension | GA |
| az databricks workspace vnet-peering show |
Show the vnet peering. |
Extension | GA |
| az databricks workspace vnet-peering update |
Update the vnet peering. |
Extension | GA |
| az databricks workspace vnet-peering wait |
Place the CLI in a waiting state until a condition is met. |
Extension | GA |
| az databricks workspace wait |
Place the CLI in a waiting state until a condition is met. |
Extension | GA |
az databricks workspace create
Create a new workspace.
az databricks workspace create --name
--resource-group
[--disk-key-auto-rotation {0, 1, f, false, n, no, t, true, y, yes}]
[--disk-key-name]
[--disk-key-vault]
[--disk-key-version]
[--enable-no-public-ip {0, 1, f, false, n, no, t, true, y, yes}]
[--location]
[--managed-resource-group]
[--managed-services-key-name]
[--managed-services-key-vault]
[--managed-services-key-version]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--prepare-encryption {0, 1, f, false, n, no, t, true, y, yes}]
[--private-subnet]
[--public-network-access {Disabled, Enabled}]
[--public-subnet]
[--require-infrastructure-encryption {0, 1, f, false, n, no, t, true, y, yes}]
[--required-nsg-rules {AllRules, NoAzureDatabricksRules, NoAzureServiceRules}]
[--sku]
[--tags]
[--vnet]Examples
Create a workspace
az databricks workspace create --resource-group MyResourceGroup --name MyWorkspace --location westus --sku standardCreate a workspace with managed identity for storage account
az databricks workspace create --resource-group MyResourceGroup --name MyWorkspace --location eastus2euap --sku premium --prepare-encryptionRequired Parameters
The name of the workspace.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
Indicate whether the latest key version should be automatically used for Managed Disk Encryption.
The name of KeyVault key.
The URI of KeyVault.
The version of KeyVault key.
Flag to enable the no public ip feature.
Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>. When not specified, the location of the resource group will be used.
The managed resource group to create. It can be either a name or a resource ID.
The name of KeyVault key.
The Uri of KeyVault.
The version of KeyVault key.
Do not wait for the long-running operation to finish.
Flag to enable the Managed Identity for managed storage account to prepare for CMK encryption.
The name of a Private Subnet within the Virtual Network.
The configuration to set whether network access from public internet to the endpoints are allowed. Allowed values: Disabled, Enabled.
The name of a Public Subnet within the Virtual Network.
Flag to enable the DBFS root file system with secondary layer of encryption with platform managed keys for data at rest.
The type of Nsg rule for internal use only. Allowed values: AllRules, NoAzureDatabricksRules, NoAzureServiceRules.
The SKU tier name. Allowed values: premium, standard, trial.
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Virtual Network name or resource ID.
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 databricks workspace delete
Delete the workspace.
az databricks workspace delete [--ids]
[--name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]
[--yes]Examples
Delete the workspace
az databricks workspace delete --resource-group MyResourceGroup --name MyWorkspace -yOptional Parameters
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
The name of the workspace.
Do not wait for the long-running operation to finish.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Do not prompt for confirmation.
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 databricks workspace list
Get all the workspaces.
az databricks workspace list [--resource-group]Examples
List workspaces within a resource group
az databricks workspace list --resource-group MyResourceGroupList workspaces within the default subscription
az databricks workspace listOptional Parameters
Name of resource group. You can configure the default group using az configure --defaults 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 databricks workspace show
Show the workspace.
az databricks workspace show [--ids]
[--name]
[--resource-group]
[--subscription]Examples
Show the workspace
az databricks workspace show --resource-group MyResourceGroup --name MyWorkspaceOptional Parameters
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
The name of the workspace.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
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 databricks workspace update
Update the workspace.
az databricks workspace update [--add]
[--disk-key-auto-rotation {0, 1, f, false, n, no, t, true, y, yes}]
[--disk-key-name]
[--disk-key-vault]
[--disk-key-version]
[--enable-no-public-ip {0, 1, f, false, n, no, t, true, y, yes}]
[--force-string {0, 1, f, false, n, no, t, true, y, yes}]
[--ids]
[--key-name]
[--key-source {Default, Microsoft.Keyvault}]
[--key-vault]
[--key-version]
[--managed-services-key-name]
[--managed-services-key-vault]
[--managed-services-key-version]
[--name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--prepare-encryption {0, 1, f, false, n, no, t, true, y, yes}]
[--public-network-access {Disabled, Enabled}]
[--remove]
[--required-nsg-rules {AllRules, NoAzureDatabricksRules, NoAzureServiceRules}]
[--resource-group]
[--sa-sku-name]
[--set]
[--sku]
[--subscription]
[--tags]Examples
Update the workspace's tags.
az databricks workspace update --resource-group MyResourceGroup --name MyWorkspace --tags key1=value1 key2=value2Clean the workspace's tags.
az databricks workspace update --resource-group MyResourceGroup --name MyWorkspace --tags ""Prepare for CMK encryption by assigning identity for storage account.
az databricks workspace update --resource-group MyResourceGroup --name MyWorkspace --prepare-encryptionConfigure CMK encryption
az databricks workspace update --resource-group MyResourceGroup --name MyWorkspace --key-source Microsoft.KeyVault --key-name MyKey --key-vault https://myKeyVault.vault.azure.net/ --key-version 00000000000000000000000000000000Revert encryption to Microsoft Managed Keys
az databricks workspace update --resource-group MyResourceGroup --name MyWorkspace --key-source DefaultOptional Parameters
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>.
Indicate whether the latest key version should be automatically used for Managed Disk Encryption.
The name of KeyVault key.
The URI of KeyVault.
The version of KeyVault key.
Flag to enable the no public ip feature.
When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
The name of KeyVault key.
The encryption key source (provider). Allowed values: Default, Microsoft.Keyvault.
The Uri of KeyVault.
The version of KeyVault key. It is optional when updating CMK.
The name of KeyVault key.
The Uri of KeyVault.
The version of KeyVault key.
The name of the workspace.
Do not wait for the long-running operation to finish.
Flag to enable the Managed Identity for managed storage account to prepare for CMK encryption.
The network access type for accessing workspace. Set value to disabled to access workspace only via private link.
Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.
The type of Nsg rule for internal use only. Allowed values: AllRules, NoAzureDatabricksRules, NoAzureServiceRules.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Storage account SKU name, ex: Standard_GRS, Standard_LRS. Refer https://aka.ms/storageskus for valid inputs.
Update an object by specifying a property path and value to set. Example: --set property1.property2=.
The SKU tier name. Allowed values: premium, standard, trial.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
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 databricks workspace wait
Place the CLI in a waiting state until a condition is met.
az databricks workspace wait [--created]
[--custom]
[--deleted]
[--exists]
[--ids]
[--interval]
[--name]
[--resource-group]
[--subscription]
[--timeout]
[--updated]Optional Parameters
Wait until created with 'provisioningState' at 'Succeeded'.
Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Wait until deleted.
Wait until the resource exists.
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
Polling interval in seconds.
The name of the workspace.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Maximum wait in seconds.
Wait until updated with provisioningState at 'Succeeded'.
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