az databricks workspace

注意

此參考是 Azure CLI 的 databricks 延伸模組的一部分(2.57.0 版或更高版本)。 擴充功能會在您第一次執行 az databricks workspace 命令時自動安裝。 深入了解擴充功能。

管理 databricks 工作區的命令。

命令

名稱 Description 類型 狀態
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

取得指定群組識別碼 (子資源) 的指定私人連結資源。

副檔名 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

要建立的受控資源群組。 它可以是名稱或資源識別碼。

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

設定是否允許從公用因特網存取端點的網路存取。 允許的值:已停用、已啟用。

接受的值: 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

虛擬網絡 名稱或資源識別碼。

全域參數
--debug

增加記錄詳細資訊,以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
預設值: json
--query

JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 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

一或多個資源識別碼 (以空格分隔)。 它應該是完整資源識別碼,其中包含「資源標識碼」引數的所有資訊。 您應該提供 --ids 或其他「資源識別碼」引數。

--name -n

工作區的名稱。

--no-wait

請勿等候長時間執行的作業完成。

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

資源群組的名稱。 您可以使用 az configure --defaults group=<name> 來設定預設群組。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 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

訂用帳戶的名稱或識別碼。 您可以使用 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

訂用帳戶的名稱或識別碼。 您可以使用 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

一或多個資源識別碼 (以空格分隔)。 它應該是完整資源識別碼,其中包含「資源標識碼」引數的所有資訊。 您應該提供 --ids 或其他「資源識別碼」引數。

--name -n

工作區的名稱。

--resource-group -g

資源群組的名稱。 您可以使用 az configure --defaults group=<name> 來設定預設群組。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 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

訂用帳戶的名稱或識別碼。 您可以使用 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

一或多個資源識別碼 (以空格分隔)。 它應該是完整資源識別碼,其中包含「資源標識碼」引數的所有資訊。 您應該提供 --ids 或其他「資源識別碼」引數。

--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 屬性ToRemove。

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

訂用帳戶的名稱或識別碼。 您可以使用 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

訂用帳戶的名稱或識別碼。 您可以使用 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

一或多個資源識別碼 (以空格分隔)。 它應該是完整資源識別碼,其中包含「資源標識碼」引數的所有資訊。 您應該提供 --ids 或其他「資源識別碼」引數。

--interval

輪詢間隔以秒為單位。

預設值: 30
--name -n

工作區的名稱。

--resource-group -g

資源群組的名稱。 您可以使用 az configure --defaults group=<name> 來設定預設群組。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 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

訂用帳戶的名稱或識別碼。 您可以使用 az account set -s NAME_OR_ID 設定預設訂用帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。