az guestconfig guest-configuration-assignment
Note
此参考是 Azure CLI(版本 2.3.1 或更高版本)的 来宾配置 扩展的一部分。 该扩展将在首次运行 az guestconfig guest-configuration-assignment 命令时自动安装。 了解更多关于扩展的信息。
此命令组是试验性的,正在开发中。 参考和支持级别:https://aka.ms/CLI_refstatus
Guestconfig guest-configuration-assignment。
命令
| 名称 | 说明 | 类型 | Status |
|---|---|---|---|
| az guestconfig guest-configuration-assignment create |
创建 VM 与来宾配置之间的关联。 |
Extension | Experimental |
| az guestconfig guest-configuration-assignment delete |
删除来宾配置分配。 |
Extension | Experimental |
| az guestconfig guest-configuration-assignment list |
列出虚拟机的所有来宾配置分配。 |
Extension | Experimental |
| az guestconfig guest-configuration-assignment show |
获取有关来宾配置分配的信息。 |
Extension | Experimental |
| az guestconfig guest-configuration-assignment update |
创建 VM 与来宾配置之间的关联。 |
Extension | Experimental |
| az guestconfig guest-configuration-assignment wait |
将 CLI 置于等待状态,直到满足来宾配置来宾配置分配的条件。 |
Extension | Experimental |
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"
必需参数
来宾配置分配的名称。
资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。
虚拟机的名称。
可选参数
以下参数是可选的,但根据上下文,命令可能需要一个或多个参数才能成功执行。
启动来宾配置分配的源。 例如:Azure Policy。
来宾配置的配置参数。
用法:--guest-configuration-configuration-parameter name=XX value=XX
name:配置参数的名称。 值:配置参数的值。
可以使用多个 --guest-configuration-configuration-configuration-parameter 参数指定多个作。
来宾配置的配置设置。
用法:--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。
来宾配置的名称。
来宾配置的版本。
来宾配置分配的配置详细信息。 预期值:json-string/@json-file。
Location.
az account list-locations 中的值。 可以使用 az configure --defaults location=<location> 配置默认位置。
来宾配置分配的名称。
不等待长时间运行的操作完成。
| 属性 | 值 |
|---|---|
| 默认值: | False |
全局参数
提高日志记录详细程度以显示所有调试日志。
| 属性 | 值 |
|---|---|
| 默认值: | False |
显示此帮助消息并退出。
仅显示错误,禁止显示警告。
| 属性 | 值 |
|---|---|
| 默认值: | False |
输出格式。
| 属性 | 值 |
|---|---|
| 默认值: | json |
| 接受的值: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。
增加日志记录详细程度。 使用 --debug 获取完整的调试日志。
| 属性 | 值 |
|---|---|
| 默认值: | False |
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"
可选参数
以下参数是可选的,但根据上下文,命令可能需要一个或多个参数才能成功执行。
一个或多个资源 ID(以空格分隔)。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。
| 属性 | 值 |
|---|---|
| 参数组: | Resource Id Arguments |
来宾配置分配的名称。
| 属性 | 值 |
|---|---|
| 参数组: | Resource Id Arguments |
不等待长时间运行的操作完成。
| 属性 | 值 |
|---|---|
| 默认值: | False |
资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。
| 属性 | 值 |
|---|---|
| 参数组: | Resource Id Arguments |
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。
| 属性 | 值 |
|---|---|
| 参数组: | Resource Id Arguments |
虚拟机的名称。
| 属性 | 值 |
|---|---|
| 参数组: | Resource Id Arguments |
全局参数
提高日志记录详细程度以显示所有调试日志。
| 属性 | 值 |
|---|---|
| 默认值: | False |
显示此帮助消息并退出。
仅显示错误,禁止显示警告。
| 属性 | 值 |
|---|---|
| 默认值: | False |
输出格式。
| 属性 | 值 |
|---|---|
| 默认值: | json |
| 接受的值: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
增加日志记录详细程度。 使用 --debug 获取完整的调试日志。
| 属性 | 值 |
|---|---|
| 默认值: | False |
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"
必需参数
资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。
虚拟机的名称。
全局参数
提高日志记录详细程度以显示所有调试日志。
| 属性 | 值 |
|---|---|
| 默认值: | False |
显示此帮助消息并退出。
仅显示错误,禁止显示警告。
| 属性 | 值 |
|---|---|
| 默认值: | False |
输出格式。
| 属性 | 值 |
|---|---|
| 默认值: | json |
| 接受的值: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。
增加日志记录详细程度。 使用 --debug 获取完整的调试日志。
| 属性 | 值 |
|---|---|
| 默认值: | False |
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"
可选参数
以下参数是可选的,但根据上下文,命令可能需要一个或多个参数才能成功执行。
一个或多个资源 ID(以空格分隔)。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。
| 属性 | 值 |
|---|---|
| 参数组: | Resource Id Arguments |
来宾配置分配名称。
| 属性 | 值 |
|---|---|
| 参数组: | Resource Id Arguments |
资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。
| 属性 | 值 |
|---|---|
| 参数组: | Resource Id Arguments |
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。
| 属性 | 值 |
|---|---|
| 参数组: | Resource Id Arguments |
虚拟机的名称。
| 属性 | 值 |
|---|---|
| 参数组: | Resource Id Arguments |
全局参数
提高日志记录详细程度以显示所有调试日志。
| 属性 | 值 |
|---|---|
| 默认值: | False |
显示此帮助消息并退出。
仅显示错误,禁止显示警告。
| 属性 | 值 |
|---|---|
| 默认值: | False |
输出格式。
| 属性 | 值 |
|---|---|
| 默认值: | json |
| 接受的值: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
增加日志记录详细程度。 使用 --debug 获取完整的调试日志。
| 属性 | 值 |
|---|---|
| 默认值: | False |
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"
可选参数
以下参数是可选的,但根据上下文,命令可能需要一个或多个参数才能成功执行。
启动来宾配置分配的源。 例如:Azure Policy。
来宾配置分配的名称。
| 属性 | 值 |
|---|---|
| 参数组: | Resource Id Arguments |
来宾配置的配置参数。
用法:--guest-configuration-configuration-parameter name=XX value=XX
name:配置参数的名称。 值:配置参数的值。
可以使用多个 --guest-configuration-configuration-configuration-parameter 参数指定多个作。
来宾配置的配置设置。
用法:--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。
来宾配置的名称。
来宾配置的版本。
一个或多个资源 ID(以空格分隔)。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。
| 属性 | 值 |
|---|---|
| 参数组: | Resource Id Arguments |
来宾配置分配的配置详细信息。 预期值:json-string/@json-file。
Location.
az account list-locations 中的值。 可以使用 az configure --defaults location=<location> 配置默认位置。
来宾配置分配的名称。
不等待长时间运行的操作完成。
| 属性 | 值 |
|---|---|
| 默认值: | False |
资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。
| 属性 | 值 |
|---|---|
| 参数组: | Resource Id Arguments |
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。
| 属性 | 值 |
|---|---|
| 参数组: | Resource Id Arguments |
虚拟机的名称。
| 属性 | 值 |
|---|---|
| 参数组: | Resource Id Arguments |
全局参数
提高日志记录详细程度以显示所有调试日志。
| 属性 | 值 |
|---|---|
| 默认值: | False |
显示此帮助消息并退出。
仅显示错误,禁止显示警告。
| 属性 | 值 |
|---|---|
| 默认值: | False |
输出格式。
| 属性 | 值 |
|---|---|
| 默认值: | json |
| 接受的值: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
增加日志记录详细程度。 使用 --debug 获取完整的调试日志。
| 属性 | 值 |
|---|---|
| 默认值: | False |
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
可选参数
以下参数是可选的,但根据上下文,命令可能需要一个或多个参数才能成功执行。
等待在“Succeeded”中使用“provisioningState”创建。
| 属性 | 值 |
|---|---|
| 参数组: | Wait Condition Arguments |
| 默认值: | False |
等待条件满足自定义 JMESPath 查询。 例如 provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running']。
| 属性 | 值 |
|---|---|
| 参数组: | Wait Condition Arguments |
等到删除为止。
| 属性 | 值 |
|---|---|
| 参数组: | Wait Condition Arguments |
| 默认值: | False |
等待资源存在。
| 属性 | 值 |
|---|---|
| 参数组: | Wait Condition Arguments |
| 默认值: | False |
一个或多个资源 ID(以空格分隔)。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。
| 属性 | 值 |
|---|---|
| 参数组: | Resource Id Arguments |
轮询间隔(以秒为单位)。
| 属性 | 值 |
|---|---|
| 参数组: | Wait Condition Arguments |
| 默认值: | 30 |
来宾配置分配名称。
| 属性 | 值 |
|---|---|
| 参数组: | Resource Id Arguments |
资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。
| 属性 | 值 |
|---|---|
| 参数组: | Resource Id Arguments |
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。
| 属性 | 值 |
|---|---|
| 参数组: | Resource Id Arguments |
最大等待(以秒为单位)。
| 属性 | 值 |
|---|---|
| 参数组: | Wait Condition Arguments |
| 默认值: | 3600 |
等到 provisioningState 更新为“Succeeded”。
| 属性 | 值 |
|---|---|
| 参数组: | Wait Condition Arguments |
| 默认值: | False |
虚拟机的名称。
| 属性 | 值 |
|---|---|
| 参数组: | Resource Id Arguments |
全局参数
提高日志记录详细程度以显示所有调试日志。
| 属性 | 值 |
|---|---|
| 默认值: | False |
显示此帮助消息并退出。
仅显示错误,禁止显示警告。
| 属性 | 值 |
|---|---|
| 默认值: | False |
输出格式。
| 属性 | 值 |
|---|---|
| 默认值: | json |
| 接受的值: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
增加日志记录详细程度。 使用 --debug 获取完整的调试日志。
| 属性 | 值 |
|---|---|
| 默认值: | False |