Share via

az adp workspace

  • 參考

注意

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

管理 adp 工作區。

命令

名稱 Description 類型 狀態
az adp workspace create

建立工作區。

 擴充 GA
az adp workspace delete

刪除工作區。

 擴充 GA
az adp workspace list

依訂用帳戶識別碼列出工作區資源。

 擴充 GA
az adp workspace show

取得工作區。

 擴充 GA
az adp workspace update

更新工作區。

 擴充 GA
az adp workspace wait

將 CLI 置於等候狀態，直到符合條件為止。

 擴充 GA

az adp workspace create

建立工作區。

az adp workspace create --name
                        --resource-group
                        [--data-location]
                        [--direct-read-access {Disabled, Enabled}]
                        [--domain-name-scope {NoReuse, ResourceGroupReuse, SubscriptionReuse, TenantReuse}]
                        [--encryption]
                        [--identity]
                        [--location]
                        [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                        [--source-resource-id]
                        [--storage-account-count]
                        [--storage-sku]
                        [--tags]

範例

使用 LRS sku 建立具有 3 個儲存體帳戶的工作區

az adp workspaces create --name sample-ws --subscription sample-subscription --resource-group sample-rg --location westus3 --storage-account-count 3 --storage-sku name=Standard_LRS

使用加密建立工作區

az adp workspace create --name sample-ws --resource-group sample-rg --location westus3 --encryption key-encryption-key-url=https://contosovault.vault.azure.net/keys/contosokek user-assigned-identity-resource-id=/subscriptions/<subscriptionid>/resourceGroups/<resourcegroup>/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId

必要參數

--name --workspace-name -n

工作區名稱。

--resource-group -g

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

選擇性參數

--data-location

工作區的資料位置。 如果未提供，則預設為資源的位置。

--direct-read-access

根據 Azure RBAC 啟用工作區基礎 Azure 資源的直接資料平面讀取存取權（因此略過自主開發平臺的授權系統）。

接受的值: Disabled, Enabled
--domain-name-scope

FQDN 標籤產生的範圍。 如果未提供，則預設為 TenantReuse。

接受的值: NoReuse, ResourceGroupReuse, SubscriptionReuse, TenantReuse
--encryption

加密組態。 支援速記語法、json-file 和 yaml-file。 請嘗試 「？？」 以顯示更多。

--identity

指派給此資源的受控服務識別。 支援速記語法、json-file 和 yaml-file。 請嘗試 「？？」 以顯示更多。

--location -l

未指定資源所在的地理位置，將會使用資源群組的位置。

--no-wait

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

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

產生此工作區資料的來源資源的 ARM 識別碼。

--storage-account-count

每個工作區布建的儲存體帳戶數量。 如果未提供，則預設為 5。

--storage-sku

儲存體 SKU。 如果未提供，則預設為 Standard_ZRS。 支援速記語法、json-file 和 yaml-file。 請嘗試 「？？」 以顯示更多。

--tags

資源標籤。 支援速記語法、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 adp workspace delete

刪除工作區。

az adp workspace delete [--ids]
                        [--name]
                        [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                        [--resource-group]
                        [--subscription]
                        [--yes]

範例

刪除工作區

az adp workspace delete --subscription sample-subscription --resource-group sample-rg --name sample-ws

選擇性參數

--ids

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

--name --workspace-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 adp workspace list

依訂用帳戶識別碼列出工作區資源。

az adp workspace list [--resource-group]

範例

列出資源群組中的工作區

az adp workspace list --subscription sample-subscription --resource-group sample-rg

選擇性參數

--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 adp workspace show

取得工作區。

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

範例

在資源群組中顯示工作區

az adp workspace show --subscription sample-subscription --resource-group sample-rg --name sample-ws

選擇性參數

--ids

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

--name --workspace-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 adp workspace update

更新工作區。

az adp workspace update [--add]
                        [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                        [--identity]
                        [--ids]
                        [--name]
                        [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                        [--remove]
                        [--resource-group]
                        [--set]
                        [--subscription]
                        [--tags]

範例

將工作區更新為 3 個儲存體帳戶

az adp workspace update --subscription sample-rg --resource-group sample-rg --workspace-name sample-ws --set properties.StorageAccountCount=3

選擇性參數

--add

藉由指定路徑和索引鍵值組，將 物件加入物件清單。 範例：--add property.listProperty < key=value、string 或 JSON 字串 > 。

--force-string

使用 'set' 或 'add' 時，請保留字元串常值，而不是嘗試轉換成 JSON。

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

指派給此資源的受控服務識別。 支援速記語法、json-file 和 yaml-file。 請嘗試 「？？」 以顯示更多。

--ids

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

--name --workspace-name -n

工作區名稱。

--no-wait

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

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

從清單中移除屬性或專案。 範例：--remove property.list OR --remove 屬性ToRemove。

--resource-group -g

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

--set

指定要設定的屬性路徑和值，以更新物件。 範例：--set property1.property2=。

--subscription

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

--tags

資源標籤。 支援速記語法、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 adp workspace wait

將 CLI 置於等候狀態，直到符合條件為止。

az adp 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 --workspace-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 來取得完整偵錯記錄。