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

az databricks workspace create

Create a new workspace.

az databricks workspace delete

Delete the workspace.

az databricks workspace list

Get all the workspaces.

az databricks workspace outbound-endpoint

Commands to manage endpoints in the specified workspace.

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.

az databricks workspace private-endpoint-connection

Commands to manage databricks workspace private endpoint connections.

az databricks workspace private-endpoint-connection create

Create the status of a private endpoint connection with the specified name.

az databricks workspace private-endpoint-connection delete

Delete private endpoint connection with the specified name.

az databricks workspace private-endpoint-connection list

List private endpoint connections of the workspace.

az databricks workspace private-endpoint-connection show

Get a private endpoint connection properties for a workspace.

az databricks workspace private-endpoint-connection update

Update the status of a private endpoint connection with the specified name.

az databricks workspace private-endpoint-connection wait

Place the CLI in a waiting state until a condition is met.

az databricks workspace private-link-resource

Commands to manage databricks workspace private link resources.

az databricks workspace private-link-resource list

List private link resources for a given workspace.

az databricks workspace private-link-resource show

Get the specified private link resource for the given group id (sub-resource).

az databricks workspace show

Show the workspace.

az databricks workspace update

Update the workspace.

az databricks workspace vnet-peering

Commands to manage databricks workspace vnet peering.

az databricks workspace vnet-peering create

Create a vnet peering for a workspace.

az databricks workspace vnet-peering delete

Delete the vnet peering.

az databricks workspace vnet-peering list

List vnet peerings under a workspace.

az databricks workspace vnet-peering show

Show the vnet peering.

az databricks workspace vnet-peering update

Update the vnet peering.

az databricks workspace vnet-peering wait

Place the CLI in a waiting state until a condition is met.

az databricks workspace wait

Place the CLI in a waiting state until a condition is met.

az databricks workspace create

Create a new workspace.

az databricks workspace create --name
                               --resource-group
                               [--enable-no-public-ip {0, 1, f, false, n, no, t, true, y, yes}]
                               [--location]
                               [--managed-resource-group]
                               [--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 standard

Create a workspace with managed identity for storage account

az databricks workspace create --resource-group MyResourceGroup --name MyWorkspace --location eastus2euap --sku premium --prepare-encryption

Required Parameters

--name -n

The name of the workspace.

--resource-group -g

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

Optional Parameters

--enable-no-public-ip

Flag to enable the no public ip feature.

accepted values: 0, 1, f, false, n, no, t, true, y, yes
--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--managed-resource-group

The managed resource group to create. It can be either a name or a resource ID.

--no-wait

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

accepted values: 0, 1, f, false, n, no, t, true, y, yes
--prepare-encryption

Flag to enable the Managed Identity for managed storage account to prepare for CMK encryption.

accepted values: 0, 1, f, false, n, no, t, true, y, yes
--private-subnet

The name of a Private Subnet within the Virtual Network.

--public-network-access

The configuration to set whether network access from public internet to the endpoints are allowed. Allowed values: Disabled, Enabled.

accepted values: Disabled, Enabled
--public-subnet

The name of a Public Subnet within the Virtual Network.

--require-infrastructure-encryption

Flag to enable the DBFS root file system with secondary layer of encryption with platform managed keys for data at rest.

accepted values: 0, 1, f, false, n, no, t, true, y, yes
--required-nsg-rules

The type of Nsg rule for internal use only. Allowed values: AllRules, NoAzureDatabricksRules, NoAzureServiceRules.

accepted values: AllRules, NoAzureDatabricksRules, NoAzureServiceRules
--sku

The SKU tier name. Allowed values: premium, standard, trial.

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags. Support shorthand-syntax, json-file and yaml-file. Try ?? to show more.

--vnet

Virtual Network name or resource ID.

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

Optional Parameters

--ids

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.

--name -n

The name of the workspace.

--no-wait

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

accepted values: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

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

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--yes -y

Do not prompt for confirmation.

default value: False

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 MyResourceGroup

List workspaces within the default subscription

az databricks workspace list

Optional Parameters

--resource-group -g

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

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 MyWorkspace

Optional Parameters

--ids

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.

--name -n

The name of the workspace.

--resource-group -g

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

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

az databricks workspace update

Update the workspace.

az databricks workspace update [--add]
                               [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                               [--ids]
                               [--key-name]
                               [--key-source {Default, Microsoft.Keyvault}]
                               [--key-vault]
                               [--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}]
                               [--remove]
                               [--resource-group]
                               [--set]
                               [--sku]
                               [--subscription]
                               [--tags]

Examples

Update the workspace's tags.

az databricks workspace update --resource-group MyResourceGroup --name MyWorkspace --tags key1=value1 key2=value2

Clean 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-encryption

Configure 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 00000000000000000000000000000000

Revert encryption to Microsoft Managed Keys

az databricks workspace update --resource-group MyResourceGroup --name MyWorkspace --key-source Default

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

--force-string

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

accepted values: 0, 1, f, false, n, no, t, true, y, yes
--ids

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.

--key-name

The name of KeyVault key.

--key-source

The encryption key source (provider). Allowed values: Default, Microsoft.Keyvault.

accepted values: Default, Microsoft.Keyvault
--key-vault

The Uri of KeyVault.

--key-version

The version of KeyVault key. It is optional when updating CMK.

--name -n

The name of the workspace.

--no-wait

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

accepted values: 0, 1, f, false, n, no, t, true, y, yes
--prepare-encryption

Flag to enable the Managed Identity for managed storage account to prepare for CMK encryption.

accepted values: 0, 1, f, false, n, no, t, true, y, yes
--remove

Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.

--resource-group -g

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

--set

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

--sku

The SKU tier name. Allowed values: premium, standard, trial.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags. Support shorthand-syntax, json-file and yaml-file. Try ?? to show more.

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

--created

Wait until created with 'provisioningState' at 'Succeeded'.

default value: False
--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Wait until deleted.

default value: False
--exists

Wait until the resource exists.

default value: False
--ids

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.

--interval

Polling interval in seconds.

default value: 30
--name -n

The name of the workspace.

--resource-group -g

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

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--timeout

Maximum wait in seconds.

default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

default value: False