az databricks workspace

Reference

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 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 of the Databricks workspace vnet peering is met.
az databricks workspace wait	Place the CLI in a waiting state until a condition of the Databricks workspace is met.

az databricks workspace create

Create a new workspace.

az databricks workspace create --location
                               --name
                               --resource-group
                               --sku {premium, standard, trial}
                               [--managed-resource-group]
                               [--no-wait]
                               [--prepare-encryption]
                               [--private-subnet]
                               [--public-subnet]
                               [--require-infrastructure-encryption]
                               [--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

--location -l

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

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

--sku

The SKU tier name.

accepted values: premium, standard, trial

Optional Parameters

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

--prepare-encryption

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

--private-subnet

The name of a Private Subnet within the Virtual Network.

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

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

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

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az databricks workspace delete

Delete the workspace.

az databricks workspace delete --name
                               --resource-group
                               [--no-wait]
                               [--yes]

Examples

Delete the workspace

az databricks workspace delete --resource-group MyResourceGroup --name MyWorkspace

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

--no-wait

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

--yes -y

Do not prompt for confirmation.

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.

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

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

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.

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az databricks workspace show

Show the workspace.

az databricks workspace show --name
                             --resource-group

Examples

Show the workspace

az databricks workspace show --resource-group MyResourceGroup --name MyWorkspace

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

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.

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az databricks workspace update

Update the workspace.

az databricks workspace update --name
                               --resource-group
                               [--key-name]
                               [--key-source {Default, Microsoft.Keyvault}]
                               [--key-vault]
                               [--key-version]
                               [--no-wait]
                               [--prepare-encryption]
                               [--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

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

--key-name

The name of KeyVault key.

--key-source

The encryption key source (provider).

accepted values: Default, Microsoft.Keyvault

--key-vault

The Uri of KeyVault.

--key-version

The version of KeyVault key.

--no-wait

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

--prepare-encryption

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

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

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.

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az databricks workspace wait

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

az databricks workspace wait --name
                             --resource-group
                             [--created]
                             [--custom]
                             [--deleted]
                             [--exists]
                             [--interval]
                             [--timeout]
                             [--updated]

Examples

Pause executing next line of CLI script until the Databricks workspace is successfully provisioned.

az databricks workspace wait --resource-group MyResourceGroup --name MyWorkspace \ --created

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

--created

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

--custom

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

--deleted

Wait until deleted.

--exists

Wait until the resource exists.

--interval

Polling interval in seconds.

default value: 30

--timeout

Maximum wait in seconds.

default value: 3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

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.

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az databricks workspace

Please rate your experience

Commands

az databricks workspace create

Examples

Required Parameters

Optional Parameters

az databricks workspace delete

Examples

Required Parameters

Optional Parameters

az databricks workspace list

Examples

Optional Parameters

az databricks workspace show

Examples

Required Parameters

az databricks workspace update

Examples

Required Parameters

Optional Parameters

az databricks workspace wait

Examples

Required Parameters

Optional Parameters