你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

az databricks workspace

参考

注意

此参考是 Azure CLI（版本 2.57.0 或更高版本）的 databricks 扩展的一部分。该扩展将在首次运行 az databricks workspace 命令时自动安装。详细了解扩展。

用于管理 databricks 工作区的命令。

命令

名称	说明	类型	Status
az databricks workspace create	创建新工作区。	扩展	GA
az databricks workspace delete	删除工作区。	扩展	GA
az databricks workspace list	获取所有工作区。	扩展	GA
az databricks workspace outbound-endpoint	用于管理指定工作区中的终结点的命令。	扩展	GA
az databricks workspace outbound-endpoint list	列出 VNET 注入工作区调用 Azure Databricks 控制平面的终结点列表。必须使用这些终结点配置出站访问。有关详细信息，请参阅 https://docs.microsoft.com/en-us/azure/databricks/administration-guide/cloud-configurations/azure/udr。	扩展	GA
az databricks workspace private-endpoint-connection	用于管理 databricks 工作区专用终结点连接的命令。	扩展	GA
az databricks workspace private-endpoint-connection create	创建具有指定名称的专用终结点连接的状态。	扩展	GA
az databricks workspace private-endpoint-connection delete	删除具有指定名称的专用终结点连接。	扩展	GA
az databricks workspace private-endpoint-connection list	列出工作区的专用终结点连接。	扩展	GA
az databricks workspace private-endpoint-connection show	获取工作区的专用终结点连接属性。	扩展	GA
az databricks workspace private-endpoint-connection update	使用指定名称更新专用终结点连接的状态。	扩展	GA
az databricks workspace private-endpoint-connection wait	将 CLI 置于等待状态，直到满足条件。	扩展	GA
az databricks workspace private-link-resource	用于管理 databricks 工作区专用链接资源的命令。	扩展	GA
az databricks workspace private-link-resource list	列出给定工作区的专用链接资源。	扩展	GA
az databricks workspace private-link-resource show	获取给定组 ID（子资源）的指定专用链接资源。	扩展	GA
az databricks workspace show	显示工作区。	扩展	GA
az databricks workspace update	更新工作区。	扩展	GA
az databricks workspace vnet-peering	用于管理 databricks 工作区 vnet 对等互连的命令。	扩展	GA
az databricks workspace vnet-peering create	为工作区创建 vnet 对等互连。	扩展	GA
az databricks workspace vnet-peering delete	删除 vnet 对等互连。	扩展	GA
az databricks workspace vnet-peering list	列出工作区下的 vnet 对等互连。	扩展	GA
az databricks workspace vnet-peering show	显示 vnet 对等互连。	扩展	GA
az databricks workspace vnet-peering update	更新 vnet 对等互连。	扩展	GA
az databricks workspace vnet-peering wait	将 CLI 置于等待状态，直到满足条件。	扩展	GA
az databricks workspace wait	将 CLI 置于等待状态，直到满足条件。	扩展	GA

az databricks workspace create

创建新工作区。

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]

示例

创建工作区

az databricks workspace create --resource-group MyResourceGroup --name MyWorkspace --location westus --sku standard

为存储帐户创建具有托管标识的工作区

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

必需参数

--name -n

工作区的名称。

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<name> 配置默认组。

可选参数

--access-connector

要与 Databricks 工作区支持速记语法、json-file 和 yaml-file 关联的访问连接器资源。请尝试“？？” 以显示更多内容。

--default-catalog

创建工作区期间的默认目录配置的属性。支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

--default-storage-firewall

获取或设置默认存储防火墙配置信息。

接受的值: Disabled, Enabled

--disk-key-auto-rotation

指示是否应自动将最新的密钥版本用于托管磁盘加密。

接受的值: 0, 1, f, false, n, no, t, true, y, yes

--disk-key-name

KeyVault 密钥的名称。

--disk-key-vault

KeyVault 的 URI。

--disk-key-version

KeyVault 密钥的版本。

--enable-no-public-ip

用于启用无公共 IP 功能的标志。

接受的值: 0, 1, f, false, n, no, t, true, y, yes

--enhanced-security-compliance

包含与增强的安全性和合规性加载项相关的设置。支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

--location -l

位置。 az account list-locations 中的值。可以使用 az configure --defaults location=<location> 配置默认位置。如果未指定，将使用资源组的位置。

--managed-resource-group

要创建的托管资源组。它可以是名称或资源 ID。

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

KeyVault 密钥的名称。

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

KeyVault 的 URI。

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

KeyVault 密钥的版本。

--no-wait

不等待长时间运行的操作完成。

接受的值: 0, 1, f, false, n, no, t, true, y, yes

--prepare-encryption

为托管存储帐户启用托管标识以准备 CMK 加密的标志。

接受的值: 0, 1, f, false, n, no, t, true, y, yes

--private-subnet

虚拟网络中的专用子网的名称。

--public-network-access

用于设置是否允许从公共 Internet 访问终结点的网络访问的配置。允许的值：已禁用、已启用。

接受的值: Disabled, Enabled

--public-subnet

虚拟网络中的公共子网的名称。

--require-infrastructure-encryption

使用平台托管密钥为静态数据启用具有辅助加密层的 DBFS 根文件系统的标志。

接受的值: 0, 1, f, false, n, no, t, true, y, yes

--required-nsg-rules

仅供内部使用的 Nsg 规则的类型。允许的值：AllRules、NoAzureDatabricksRules、NoAzureServiceRules。

接受的值: AllRules, NoAzureDatabricksRules, NoAzureServiceRules

--sku

SKU 层名称。允许的值：高级、标准、试用。

--tags

空格分隔标记：key[=value] [key[=value] ...]。使用“”清除现有标记。支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

--vnet

虚拟网络名称或资源 ID。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。使用 --debug 获取完整的调试日志。

az databricks workspace delete

删除工作区。

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]

示例

删除工作区

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

可选参数

--force-deletion

用于保留默认 unity 目录数据的可选参数。默认情况下，如果在工作区上启用了 Uc，数据将保留。

接受的值: 0, 1, f, false, n, no, t, true, y, yes

默认值: False

--ids

一个或多个资源 ID（以空格分隔）。它应该是包含“Resource Id”参数的所有信息的完整资源 ID。应提供 --ids 或其他“Resource Id”参数。

--name -n

工作区的名称。

--no-wait

不等待长时间运行的操作完成。

接受的值: 0, 1, f, false, n, no, t, true, y, yes

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<name> 配置默认组。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--yes -y

不提示确认。

默认值: False

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。使用 --debug 获取完整的调试日志。

az databricks workspace list

获取所有工作区。

az databricks workspace list [--max-items]
                             [--next-token]
                             [--resource-group]

示例

列出资源组中的工作区

az databricks workspace list --resource-group MyResourceGroup

列出默认订阅中的工作区

az databricks workspace list

可选参数

--max-items

命令输出中要返回的项总数。如果可用的项总数大于指定的值，则会在命令的输出中提供令牌。若要恢复分页，请在后续命令的参数中 --next-token 提供令牌值。

--next-token

用于指定开始分页的位置的令牌。这是先前截断的响应中的令牌值。

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<name> 配置默认组。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。使用 --debug 获取完整的调试日志。

az databricks workspace show

显示工作区。

az databricks workspace show [--ids]
                             [--name]
                             [--resource-group]
                             [--subscription]

示例

显示工作区

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

可选参数

--ids

一个或多个资源 ID（以空格分隔）。它应该是包含“Resource Id”参数的所有信息的完整资源 ID。应提供 --ids 或其他“Resource Id”参数。

--name -n

工作区的名称。

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<name> 配置默认组。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。使用 --debug 获取完整的调试日志。

az databricks workspace update

更新工作区。

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]

示例

更新工作区的标记。

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

清理工作区的标记。

az databricks workspace update --resource-group MyResourceGroup --name MyWorkspace --tags ""

通过为存储帐户分配标识来准备 CMK 加密。

az databricks workspace update --resource-group MyResourceGroup --name MyWorkspace --prepare-encryption

配置 CMK 加密

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

将加密还原为Microsoft托管密钥

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

可选参数

--access-connector

要与 Databricks 工作区支持速记语法、json-file 和 yaml-file 关联的访问连接器资源。请尝试“？？” 以显示更多内容。

--add

通过指定路径和键值对将对象添加到对象列表。示例：--add property.listProperty <key=value、string 或 JSON 字符串>。

--default-catalog

创建工作区期间的默认目录配置的属性。支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

--default-storage-firewall

获取或设置默认存储防火墙配置信息。

接受的值: Disabled, Enabled

--disk-key-auto-rotation

指示是否应自动将最新的密钥版本用于托管磁盘加密。

接受的值: 0, 1, f, false, n, no, t, true, y, yes

--disk-key-name

KeyVault 密钥的名称。

--disk-key-vault

KeyVault 的 URI。

--disk-key-version

KeyVault 密钥的版本。

--enable-no-public-ip

用于启用无公共 IP 功能的标志。

接受的值: 0, 1, f, false, n, no, t, true, y, yes

--enhanced-security-compliance

包含与增强的安全性和合规性加载项相关的设置。支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

--force-string

使用“set”或“add”时，保留字符串文本，而不是尝试转换为 JSON。

接受的值: 0, 1, f, false, n, no, t, true, y, yes

--ids

一个或多个资源 ID（以空格分隔）。它应该是包含“Resource Id”参数的所有信息的完整资源 ID。应提供 --ids 或其他“Resource Id”参数。

--key-name

KeyVault 密钥的名称。

--key-source

加密密钥源（提供程序）。允许的值：默认值，Microsoft.Keyvault。

接受的值: Default, Microsoft.Keyvault

--key-vault

KeyVault 的 URI。

--key-version

KeyVault 密钥的版本。更新 CMK 时，这是可选的。

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

KeyVault 密钥的名称。

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

KeyVault 的 URI。

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

KeyVault 密钥的版本。

--name -n

工作区的名称。

--no-wait

不等待长时间运行的操作完成。

接受的值: 0, 1, f, false, n, no, t, true, y, yes

--prepare-encryption

为托管存储帐户启用托管标识以准备 CMK 加密的标志。

接受的值: 0, 1, f, false, n, no, t, true, y, yes

--public-network-access

用于访问工作区的网络访问类型。将值设置为禁用，以便仅通过专用链接访问工作区。

接受的值: Disabled, Enabled

--remove

从列表中删除属性或元素。示例：--remove property.list OR --remove propertyToRemove。

--required-nsg-rules

仅供内部使用的 Nsg 规则的类型。允许的值：AllRules、NoAzureDatabricksRules、NoAzureServiceRules。

接受的值: AllRules, NoAzureDatabricksRules, NoAzureServiceRules

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<name> 配置默认组。

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

存储帐户 SKU 名称，例如：Standard_GRS，Standard_LRS。请参阅 https://aka.ms/storageskus 有效的输入。

--set

通过指定要设置的属性路径和值来更新对象。示例：--set property1.property2=。

--sku

SKU 层名称。允许的值：高级、标准、试用。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--tags

空格分隔标记：key[=value] [key[=value] ...]。使用“”清除现有标记。支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。使用 --debug 获取完整的调试日志。

az databricks workspace wait

将 CLI 置于等待状态，直到满足条件。

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

可选参数

--created

等待在“Succeeded”中使用“provisioningState”创建。

默认值: False

--custom

等待条件满足自定义 JMESPath 查询。例如 provisioningState！='InProgress'， instanceView.statuses[？code=='PowerState/running']。

--deleted

等到删除为止。

默认值: False

--exists

等待资源存在。

默认值: False

--ids

一个或多个资源 ID（以空格分隔）。它应该是包含“Resource Id”参数的所有信息的完整资源 ID。应提供 --ids 或其他“Resource Id”参数。

--interval

轮询间隔（以秒为单位）。

默认值: 30

--name -n

工作区的名称。

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<name> 配置默认组。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--timeout

最大等待（以秒为单位）。

默认值: 3600

--updated

等到 provisioningState 更新为“Succeeded”。

默认值: False

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。使用 --debug 获取完整的调试日志。

通过

az databricks workspace

命令

az databricks workspace create

示例

必需参数

可选参数

az databricks workspace delete

示例

可选参数

az databricks workspace list

示例

可选参数

az databricks workspace show

示例

可选参数

az databricks workspace update

示例

可选参数

az databricks workspace wait

可选参数

其他资源