az desktopvirtualization workspace

注意

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

管理桌面虛擬化工作區。

命令

名稱	Description	類型	狀態
az desktopvirtualization workspace create	建立工作區。	副檔名	GA
az desktopvirtualization workspace delete	刪除工作區。	副檔名	GA
az desktopvirtualization workspace list	列出工作區。	副檔名	GA
az desktopvirtualization workspace show	顯示工作區。	副檔名	GA
az desktopvirtualization workspace update	更新工作區。	副檔名	GA

az desktopvirtualization workspace create

建立工作區。

az desktopvirtualization workspace create --name
                                          --resource-group
                                          [--application-group-references]
                                          [--description]
                                          [--friendly-name]
                                          [--location]
                                          [--tags]

範例

建立工作區

az desktopvirtualization workspace create -g rg -n workspace-name --friendly-name friendly

必要參數

--name -n

工作區的名稱。

--resource-group -g

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

選擇性參數

--application-group-references

應用程式群組資源識別碼的清單。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

--description

工作區的描述。

--friendly-name

工作區的易記名稱。

--location -l

資源所在的地理位置。

--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 desktopvirtualization workspace delete

刪除工作區。

az desktopvirtualization workspace delete [--ids]
                                          [--name]
                                          [--resource-group]
                                          [--subscription]
                                          [--yes]

範例

刪除工作區

az desktopvirtualization workspace delete -g rg -n workspace-name

選擇性參數

--ids

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

--name -n

工作區的名稱。

--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 desktopvirtualization workspace list

列出工作區。

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

範例

列出工作區

az desktopvirtualization workspace list -g rg

選擇性參數

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

顯示工作區。

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

範例

顯示工作區

az desktopvirtualization workspace show -g rg -n workspace-name

選擇性參數

--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 desktopvirtualization workspace update

更新工作區。

az desktopvirtualization workspace update [--add]
                                          [--application-group-references]
                                          [--description]
                                          [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                          [--friendly-name]
                                          [--ids]
                                          [--name]
                                          [--remove]
                                          [--resource-group]
                                          [--set]
                                          [--subscription]
                                          [--tags]

範例

更新工作區

az desktopvirtualization workspace update -g rg -n workspace-name --tags tag=test

選擇性參數

--add

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

--application-group-references

應用程式群組資源識別碼的清單。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

--description

工作區的描述。

--force-string

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

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

--friendly-name

工作區的易記名稱。

--ids

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

--name -n

工作區的名稱。

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