az databricks workspace
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. Values from: az account list-locations
. You can configure the default location using az configure --defaults location=<location>
.
The name of the workspace.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
The SKU tier name.
Optional Parameters
The managed resource group to create. It can be either a name or a resource ID.
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 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.
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
Virtual Network name or resource ID.
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.
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
The name of the workspace.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
Do not wait for the long-running operation to finish.
Do not prompt for confirmation.
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.
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
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
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.
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
The name of the workspace.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
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.
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
The name of the workspace.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
The name of KeyVault key.
The encryption key source (provider).
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.
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
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.
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
The name of the workspace.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
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.
Polling interval in seconds.
Maximum wait in seconds.
Wait until updated with provisioningState at 'Succeeded'.
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.
Increase logging verbosity. Use --debug for full debug logs.