az databricks workspace

Reference

Note

This reference is part of the databricks extension for the Azure CLI (version 2.57.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
                               [--access-connector]
                               [--default-catalog]
                               [--default-storage-firewall {Disabled, Enabled}]
                               [--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}]
                               [--enhanced-security-compliance]
                               [--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 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

--access-connector

Access Connector Resource that is going to be associated with Databricks Workspace Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--default-catalog

Properties for Default Catalog configuration during workspace creation. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--default-storage-firewall

Gets or Sets Default Storage Firewall configuration information.

Accepted values: Disabled, Enabled

--disk-key-auto-rotation

Indicate whether the latest key version should be automatically used for Managed Disk Encryption.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--disk-key-name

The name of KeyVault key.

--disk-key-vault

The URI of KeyVault.

--disk-key-version

The version of KeyVault key.

--enable-no-public-ip

Flag to enable the no public ip feature.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--enhanced-security-compliance

Contains settings related to the Enhanced Security and Compliance Add-On. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--location -l

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.

--managed-resource-group

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

--managed-services-key-name --ms-key-name

The name of KeyVault key.

--managed-services-key-vault --ms-key-vault

The Uri of KeyVault.

--managed-services-key-version --ms-key-version

The version of KeyVault key.

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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

az databricks workspace delete

Delete the workspace.

az databricks workspace delete [--force-deletion {0, 1, f, false, n, no, t, true, y, yes}]
                               [--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

--force-deletion

Optional parameter to retain default unity catalog data. By default the data will retained if Uc is enabled on the workspace.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

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.

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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

az databricks workspace list

Get all the workspaces.

az databricks workspace list [--max-items]
                             [--next-token]
                             [--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

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

--resource-group -g

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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

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

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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

az databricks workspace update

Update the workspace.

az databricks workspace update [--access-connector]
                               [--add]
                               [--default-catalog]
                               [--default-storage-firewall {Disabled, Enabled}]
                               [--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}]
                               [--enhanced-security-compliance]
                               [--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=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

--access-connector

Access Connector Resource that is going to be associated with Databricks Workspace Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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

--default-catalog

Properties for Default Catalog configuration during workspace creation. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--default-storage-firewall

Gets or Sets Default Storage Firewall configuration information.

Accepted values: Disabled, Enabled

--disk-key-auto-rotation

Indicate whether the latest key version should be automatically used for Managed Disk Encryption.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--disk-key-name

The name of KeyVault key.

--disk-key-vault

The URI of KeyVault.

--disk-key-version

The version of KeyVault key.

--enable-no-public-ip

Flag to enable the no public ip feature.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--enhanced-security-compliance

Contains settings related to the Enhanced Security and Compliance Add-On. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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

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

--managed-services-key-name --ms-key-name

The name of KeyVault key.

--managed-services-key-vault --ms-key-vault

The Uri of KeyVault.

--managed-services-key-version --ms-key-version

The version of KeyVault key.

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

--public-network-access

The network access type for accessing workspace. Set value to disabled to access workspace only via private link.

Accepted values: Disabled, Enabled

--remove

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

--required-nsg-rules

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

Accepted values: AllRules, NoAzureDatabricksRules, NoAzureServiceRules

--resource-group -g

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

--sa-sku-name --storage-account-sku-name

Storage account SKU name, ex: Standard_GRS, Standard_LRS. Refer https://aka.ms/storageskus for valid inputs.

--set

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

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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

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

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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

Share via

az databricks workspace

Commands

az databricks workspace create

Examples

Required Parameters

Optional Parameters

az databricks workspace delete

Examples

Optional Parameters

az databricks workspace list

Examples

Optional Parameters

az databricks workspace show

Examples

Optional Parameters

az databricks workspace update

Examples

Optional Parameters

az databricks workspace wait

Optional Parameters

Additional resources