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

az guestconfig guest-configuration-assignment

实验
参考

注意

此参考是 Azure CLI（版本 2.3.1 或更高版本）的 来宾配置 扩展的一部分。该扩展将在首次运行 az guestconfig guest-configuration-assignment 命令时自动安装。详细了解扩展。

此命令组是试验性的，正在开发中。参考和支持级别： https://aka.ms/CLI_refstatus

Guestconfig guest-configuration-assignment。

命令

名称	说明	类型	状态
az guestconfig guest-configuration-assignment create	创建 VM 与来宾配置之间的关联。	分机	实验
az guestconfig guest-configuration-assignment delete	删除来宾配置分配。	分机	实验
az guestconfig guest-configuration-assignment list	列出虚拟机的所有来宾配置分配。	分机	实验
az guestconfig guest-configuration-assignment show	获取有关来宾配置分配的信息。	分机	实验
az guestconfig guest-configuration-assignment update	创建 VM 与来宾配置之间的关联。	分机	实验
az guestconfig guest-configuration-assignment wait	将 CLI 置于等待状态，直到满足来宾配置来宾配置分配的条件。	分机	实验

az guestconfig guest-configuration-assignment create

实验

命令组“guestconfig guest-configuration-assignment”是试验性的，正在开发中。参考和支持级别： https://aka.ms/CLI_refstatus

创建 VM 与来宾配置之间的关联。

az guestconfig guest-configuration-assignment create --guest-configuration-assignment-name
                                                     --resource-group
                                                     --vm-name
                                                     [--context]
                                                     [--guest-configuration-configuration-parameter]
                                                     [--guest-configuration-configuration-setting]
                                                     [--guest-configuration-name]
                                                     [--guest-configuration-version]
                                                     [--latest-assignment-report-assignment]
                                                     [--location]
                                                     [--name]
                                                     [--no-wait]

示例

创建或更新来宾配置分配

az guestconfig guest-configuration-assignment create --guest-configuration-assignment-name "WhitelistedApplication" --guest-configuration-name "WhitelistedApplication" --location "westcentralus" --context "Azure policy" --guest-configuration-name "WhitelistedApplication" --guest-configuration-configuration-parameter name="[InstalledApplication]bwhitelistedapp;Name" value="NotePad,sql" --guest-configuration-configuration-setting action-after-reboot="ContinueConfiguration" configuration-mode="MonitorOnly" configuration-mode-frequency-mins=15 reboot-if-needed="False" --guest-configuration-version "1.*" --resource-group "myResourceGroupName" --vm-name "myVMName"

必需参数

--guest-configuration-assignment-name

来宾配置分配的名称。

--resource-group -g

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

--vm-name

虚拟机的名称。

可选参数

--context

启动来宾配置分配的源。例如：Azure Policy。

--guest-configuration-configuration-parameter

来宾配置的配置参数。

用法：--guest-configuration-configuration-parameter name=XX value=XX

name：配置参数的名称。值：配置参数的值。

可以使用多个 --guest-configuration-configuration-configuration-parameter 参数指定多个操作。

--guest-configuration-configuration-setting

来宾配置的配置设置。

用法：--guest-configuration-setting configuration-mode=XX allow-module-overwrite=XX action-after-reboot=XX refresh-frequency-min=XX reboot-if-needed=XX configuration-mode-frequency-min=XX

配置模式：指定 LCM（本地配置管理器）如何实际将配置应用于目标节点。可能的值为 ApplyOnly、ApplyAndMonitor 和 ApplyAndAutoCorrect。 allow-module-overwrite：如果为 true，则允许从请求服务下载的新配置覆盖目标节点上的旧配置。否则，在重启后执行 false 操作：指定在配置应用程序期间重新启动后发生的情况。可能的值为 ContinueConfiguration 和 StopConfiguration refresh-frequency-minutes：时间间隔（以分钟为单位），LCM 检查请求服务以获取更新的配置。如果 LCM 未配置为请求模式，则将忽略此值。默认值为 30。 restart-if-require：将此项设置为 true，以在应用需要重新启动的配置后自动重新启动节点。否则，你必须为要求重启的配置手动重启节点。默认值为 false。若要在通过 DSC（例如 Windows Installer）以外的其他配置执行重启条件时使用此设置，请将此设置和 xPendingReboot 模块组合使用。 configuration-mode-frequency-minutes：当前配置检查并应用的频率（以分钟为单位）。如果将 ConfigurationMode 属性设置为 ApplyOnly，则将忽略此属性。默认值为 15。

--guest-configuration-name

来宾配置的名称。

--guest-configuration-version

来宾配置的版本。

--latest-assignment-report-assignment

来宾配置分配的配置详细信息。预期值：json-string/@json-file。

--location -l

Location。 az account list-locations 中的值。可以使用 az configure --defaults location=<location> 配置默认位置。

--name

来宾配置分配的名称。

--no-wait

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

默认值: 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 guestconfig guest-configuration-assignment delete

实验

命令组“guestconfig guest-configuration-assignment”是试验性的，正在开发中。参考和支持级别： https://aka.ms/CLI_refstatus

删除来宾配置分配。

az guestconfig guest-configuration-assignment delete [--ids]
                                                     [--name]
                                                     [--no-wait]
                                                     [--resource-group]
                                                     [--subscription]
                                                     [--vm-name]

示例

删除来宾配置分配

az guestconfig guest-configuration-assignment delete --name "SecureProtocol" --resource-group "myResourceGroupName" --vm-name "myVMName"

可选参数

--ids

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

--name -n

来宾配置分配的名称。

--no-wait

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

默认值: False

--resource-group -g

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

--subscription

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

--vm-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 guestconfig guest-configuration-assignment list

实验

命令组“guestconfig guest-configuration-assignment”是试验性的，正在开发中。参考和支持级别： https://aka.ms/CLI_refstatus

列出虚拟机的所有来宾配置分配。

az guestconfig guest-configuration-assignment list --resource-group
                                                   --vm-name

示例

列出虚拟机的所有来宾配置分配

az guestconfig guest-configuration-assignment list --resource-group "myResourceGroupName" --vm-name "myVMName"

必需参数

--resource-group -g

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

--vm-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 guestconfig guest-configuration-assignment show

实验

命令组“guestconfig guest-configuration-assignment”是试验性的，正在开发中。参考和支持级别： https://aka.ms/CLI_refstatus

获取有关来宾配置分配的信息。

az guestconfig guest-configuration-assignment show [--ids]
                                                   [--name]
                                                   [--resource-group]
                                                   [--subscription]
                                                   [--vm-name]

示例

获取来宾配置分配

az guestconfig guest-configuration-assignment show --name "SecureProtocol" --resource-group "myResourceGroupName" --vm-name "myVMName"

可选参数

--ids

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

--name -n

来宾配置分配名称。

--resource-group -g

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

--subscription

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

--vm-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 guestconfig guest-configuration-assignment update

实验

命令组“guestconfig guest-configuration-assignment”是试验性的，正在开发中。参考和支持级别： https://aka.ms/CLI_refstatus

创建 VM 与来宾配置之间的关联。

az guestconfig guest-configuration-assignment update [--context]
                                                     [--guest-configuration-assignment-name]
                                                     [--guest-configuration-configuration-parameter]
                                                     [--guest-configuration-configuration-setting]
                                                     [--guest-configuration-name]
                                                     [--guest-configuration-version]
                                                     [--ids]
                                                     [--latest-assignment-report-assignment]
                                                     [--location]
                                                     [--name]
                                                     [--no-wait]
                                                     [--resource-group]
                                                     [--subscription]
                                                     [--vm-name]

示例

创建或更新来宾配置分配

az guestconfig guest-configuration-assignment update --guest-configuration-assignment-name "WhitelistedApplication" --guest-configuration-name "WhitelistedApplication" --location "westcentralus" --context "Azure policy" --guest-configuration-name "WhitelistedApplication" --guest-configuration-configuration-parameter name="[InstalledApplication]bwhitelistedapp;Name" value="NotePad,sql" --guest-configuration-configuration-setting action-after-reboot="ContinueConfiguration" configuration-mode="MonitorOnly" configuration-mode-frequency-mins=15 reboot-if-needed="False" --guest-configuration-version "1.*" --resource-group "myResourceGroupName" --vm-name "myVMName"

可选参数

--context

启动来宾配置分配的源。例如：Azure Policy。

--guest-configuration-assignment-name

来宾配置分配的名称。

--guest-configuration-configuration-parameter

来宾配置的配置参数。

用法：--guest-configuration-configuration-parameter name=XX value=XX

name：配置参数的名称。值：配置参数的值。

可以使用多个 --guest-configuration-configuration-configuration-parameter 参数指定多个操作。

--guest-configuration-configuration-setting

来宾配置的配置设置。

用法：--guest-configuration-setting configuration-mode=XX allow-module-overwrite=XX action-after-reboot=XX refresh-frequency-min=XX reboot-if-needed=XX configuration-mode-frequency-min=XX

--guest-configuration-name

来宾配置的名称。

--guest-configuration-version

来宾配置的版本。

--ids

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

--latest-assignment-report-assignment

来宾配置分配的配置详细信息。预期值：json-string/@json-file。

--location -l

Location。 az account list-locations 中的值。可以使用 az configure --defaults location=<location> 配置默认位置。

--name

来宾配置分配的名称。

--no-wait

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

默认值: False

--resource-group -g

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

--subscription

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

--vm-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 guestconfig guest-configuration-assignment wait

实验

命令组“guestconfig guest-configuration-assignment”是试验性的，正在开发中。参考和支持级别： https://aka.ms/CLI_refstatus

将 CLI 置于等待状态，直到满足来宾配置来宾配置分配的条件。

az guestconfig guest-configuration-assignment wait [--created]
                                                   [--custom]
                                                   [--deleted]
                                                   [--exists]
                                                   [--ids]
                                                   [--interval]
                                                   [--name]
                                                   [--resource-group]
                                                   [--subscription]
                                                   [--timeout]
                                                   [--updated]
                                                   [--vm-name]

示例

暂停执行下一行 CLI 脚本，直到来宾配置来宾配置分配成功创建。

az guestconfig guest-configuration-assignment wait --name "SecureProtocol" --resource-group "myResourceGroupName" --vm-name "myVMName" --created

暂停执行下一行 CLI 脚本，直到来宾配置来宾配置分配成功删除。

az guestconfig guest-configuration-assignment wait --name "SecureProtocol" --resource-group "myResourceGroupName" --vm-name "myVMName" --deleted

可选参数

--created

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

默认值: False

--custom

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

--deleted

等到删除为止。

默认值: False

--exists

等待资源存在。

默认值: False

--ids

一个或多个资源 ID（空格分隔）。它应该是包含“资源 ID”参数的所有信息的完整资源 ID。应提供 --id 或其他“资源 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

--vm-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 guestconfig guest-configuration-assignment

命令

az guestconfig guest-configuration-assignment create

示例

必需参数

可选参数

az guestconfig guest-configuration-assignment delete

示例

可选参数

az guestconfig guest-configuration-assignment list

示例

必需参数

az guestconfig guest-configuration-assignment show

示例

可选参数

az guestconfig guest-configuration-assignment update

示例

可选参数

az guestconfig guest-configuration-assignment wait

示例

可选参数

其他资源