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

az desktopvirtualization workspace

参考

注意

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

管理桌面虚拟化工作区。

命令

名称	说明	类型	状态
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

应用程序组资源 ID 的列表。支持速记语法、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

订阅的名称或 ID。可以使用 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

一个或多个资源 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 配置默认订阅。

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

订阅的名称或 ID。可以使用 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

一个或多个资源 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 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

应用程序组资源 ID 的列表。支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

--description

工作区的说明。

--force-string

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

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

--friendly-name

工作区的友好名称。

--ids

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

--name -n

工作区的名称。

--remove

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

--resource-group -g

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

--set

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

--subscription

订阅的名称或 ID。可以使用 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

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

--verbose

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

通过

az desktopvirtualization workspace

命令

az desktopvirtualization workspace create

示例

必需参数

可选参数

az desktopvirtualization workspace delete

示例

可选参数

az desktopvirtualization workspace list

示例

可选参数

az desktopvirtualization workspace show

示例

可选参数

az desktopvirtualization workspace update

示例

可选参数

其他资源