你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
Microsoft.GuestConfiguration guestConfigurationAssignments 2018-06-30-preview
Bicep 资源定义
可以使用目标操作部署 guestConfigurationAssignments 资源类型：
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.GuestConfiguration/guestConfigurationAssignments 资源，请将以下 Bicep 添加到模板。
resource symbolicname 'Microsoft.GuestConfiguration/guestConfigurationAssignments@2018-06-30-preview' = {
scope: resourceSymbolicName or scope
location: 'string'
name: 'string'
properties: {
context: 'string'
guestConfiguration: {
configurationParameter: [
{}
]
configurationSetting: {
actionAfterReboot: 'string'
allowModuleOverwrite: bool
configurationMode: 'string'
configurationModeFrequencyMins: int
rebootIfNeeded: bool
refreshFrequencyMins: int
}
kind: 'string'
name: 'string'
version: 'string'
}
}
}
属性值
ConfigurationParameter
| 名字 | 描述 | 价值 |
|---|
ConfigurationSetting
| 名字 | 描述 | 价值 |
|---|---|---|
| actionAfterReboot | 指定在配置应用程序期间重新启动后发生的情况。 可能的值为 ContinueConfiguration 和 StopConfiguration | “ContinueConfiguration” 'StopConfiguration' |
| allowModuleOverwrite | 如果为 true - 允许从请求服务下载的新配置覆盖目标节点上的旧配置。 否则为 false | bool |
| configurationMode | 指定 LCM（本地配置管理器）如何实际将配置应用于目标节点。 可能的值为 ApplyOnly、ApplyAndMonitor 和 ApplyAndAutoCorrect。 | “ApplyAndAutoCorrect” “ApplyAndMonitor” “ApplyOnly” |
| configurationModeFrequencyMins | 检查并应用当前配置的频率（以分钟为单位）。 如果将 ConfigurationMode 属性设置为 ApplyOnly，则忽略此属性。 默认值为 15。 | int |
| rebootIfNeeded | 将此设置为 true，以在应用需要重新启动的配置后自动重新启动节点。 否则，必须针对需要节点的任何配置手动重新启动节点。 默认值为 false。 若要在 DSC 以外的内容（如 Windows Installer）颁布重新启动条件时使用此设置，请结合使用此设置与 xPendingReboot 模块。 | bool |
| refreshFrequencyMins | LCM 检查请求服务以获取更新配置的时间间隔（以分钟为单位）。 如果未在拉取模式下配置 LCM，则忽略此值。 默认值为 30。 | int |
GuestConfigurationAssignmentProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| 上下文 | 启动来宾配置分配的源。 例如：Azure Policy | 字符串 |
| guestConfiguration | 要分配的来宾配置。 | GuestConfigurationNavigation |
GuestConfigurationNavigation
| 名字 | 描述 | 价值 |
|---|---|---|
| configurationParameter | 来宾配置的配置参数。 | ConfigurationParameter[] |
| configurationSetting | 来宾配置的配置设置。 | ConfigurationSetting |
| 类 | 来宾配置的种类。 例如：DSC | “DSC” |
| 名字 | 来宾配置的名称。 | 字符串 |
| 版本 | 来宾配置的版本。 | 字符串 |
Microsoft.GuestConfiguration/guestConfigurationAssignments
| 名字 | 描述 | 价值 |
|---|---|---|
| 位置 | VM 所在的区域。 | 字符串 |
| 名字 | 资源名称 | string （必需） |
| 性能 | 来宾配置分配的属性。 | GuestConfigurationAssignmentProperties |
| 范围 | 在与部署范围不同的范围内创建资源时使用。 | 将此属性设置为资源的符号名称，以应用 扩展资源。 |
快速入门示例
以下快速入门示例部署此资源类型。
| Bicep 文件 | 描述 |
|---|---|
| SQL Server 2014 VM & IIS VM | 在 VNET 中创建 1 或 2 个 IIS Windows 2012 R2 Web 服务器和一个后端 SQL Server 2014。 |
| 使用 Azure 安全基线 |
该模板使用公共 IP 地址在新虚拟网络中创建运行 Windows Server 的虚拟机。 部署计算机后，将安装来宾配置扩展，并应用 Windows Server 的 Azure 安全基线。 如果计算机配置偏移，可以通过再次部署模板来重新应用设置。 |
ARM 模板资源定义
可以使用目标操作部署 guestConfigurationAssignments 资源类型：
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.GuestConfiguration/guestConfigurationAssignments 资源，请将以下 JSON 添加到模板。
{
"type": "Microsoft.GuestConfiguration/guestConfigurationAssignments",
"apiVersion": "2018-06-30-preview",
"name": "string",
"location": "string",
"properties": {
"context": "string",
"guestConfiguration": {
"configurationParameter": [
{
}
],
"configurationSetting": {
"actionAfterReboot": "string",
"allowModuleOverwrite": "bool",
"configurationMode": "string",
"configurationModeFrequencyMins": "int",
"rebootIfNeeded": "bool",
"refreshFrequencyMins": "int"
},
"kind": "string",
"name": "string",
"version": "string"
}
}
}
属性值
ConfigurationParameter
| 名字 | 描述 | 价值 |
|---|
ConfigurationSetting
| 名字 | 描述 | 价值 |
|---|---|---|
| actionAfterReboot | 指定在配置应用程序期间重新启动后发生的情况。 可能的值为 ContinueConfiguration 和 StopConfiguration | “ContinueConfiguration” 'StopConfiguration' |
| allowModuleOverwrite | 如果为 true - 允许从请求服务下载的新配置覆盖目标节点上的旧配置。 否则为 false | bool |
| configurationMode | 指定 LCM（本地配置管理器）如何实际将配置应用于目标节点。 可能的值为 ApplyOnly、ApplyAndMonitor 和 ApplyAndAutoCorrect。 | “ApplyAndAutoCorrect” “ApplyAndMonitor” “ApplyOnly” |
| configurationModeFrequencyMins | 检查并应用当前配置的频率（以分钟为单位）。 如果将 ConfigurationMode 属性设置为 ApplyOnly，则忽略此属性。 默认值为 15。 | int |
| rebootIfNeeded | 将此设置为 true，以在应用需要重新启动的配置后自动重新启动节点。 否则，必须针对需要节点的任何配置手动重新启动节点。 默认值为 false。 若要在 DSC 以外的内容（如 Windows Installer）颁布重新启动条件时使用此设置，请结合使用此设置与 xPendingReboot 模块。 | bool |
| refreshFrequencyMins | LCM 检查请求服务以获取更新配置的时间间隔（以分钟为单位）。 如果未在拉取模式下配置 LCM，则忽略此值。 默认值为 30。 | int |
GuestConfigurationAssignmentProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| 上下文 | 启动来宾配置分配的源。 例如：Azure Policy | 字符串 |
| guestConfiguration | 要分配的来宾配置。 | GuestConfigurationNavigation |
GuestConfigurationNavigation
| 名字 | 描述 | 价值 |
|---|---|---|
| configurationParameter | 来宾配置的配置参数。 | ConfigurationParameter[] |
| configurationSetting | 来宾配置的配置设置。 | ConfigurationSetting |
| 类 | 来宾配置的种类。 例如：DSC | “DSC” |
| 名字 | 来宾配置的名称。 | 字符串 |
| 版本 | 来宾配置的版本。 | 字符串 |
Microsoft.GuestConfiguration/guestConfigurationAssignments
| 名字 | 描述 | 价值 |
|---|---|---|
| apiVersion | API 版本 | '2018-06-30-preview' |
| 位置 | VM 所在的区域。 | 字符串 |
| 名字 | 资源名称 | string （必需） |
| 性能 | 来宾配置分配的属性。 | GuestConfigurationAssignmentProperties |
| 类型 | 资源类型 | “Microsoft.GuestConfiguration/guestConfigurationAssignments” |
快速入门模板
以下快速入门模板部署此资源类型。
| 模板 | 描述 |
|---|---|
SQL Server 2014 VM & IIS VM
|
在 VNET 中创建 1 或 2 个 IIS Windows 2012 R2 Web 服务器和一个后端 SQL Server 2014。 |
| 使用 Azure 安全基线
|
该模板使用公共 IP 地址在新虚拟网络中创建运行 Windows Server 的虚拟机。 部署计算机后，将安装来宾配置扩展，并应用 Windows Server 的 Azure 安全基线。 如果计算机配置偏移，可以通过再次部署模板来重新应用设置。 |
Terraform （AzAPI 提供程序）资源定义
可以使用目标操作部署 guestConfigurationAssignments 资源类型：
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.GuestConfiguration/guestConfigurationAssignments 资源，请将以下 Terraform 添加到模板。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.GuestConfiguration/guestConfigurationAssignments@2018-06-30-preview"
name = "string"
parent_id = "string"
location = "string"
body = jsonencode({
properties = {
context = "string"
guestConfiguration = {
configurationParameter = [
{
}
]
configurationSetting = {
actionAfterReboot = "string"
allowModuleOverwrite = bool
configurationMode = "string"
configurationModeFrequencyMins = int
rebootIfNeeded = bool
refreshFrequencyMins = int
}
kind = "string"
name = "string"
version = "string"
}
}
})
}
属性值
ConfigurationParameter
| 名字 | 描述 | 价值 |
|---|
ConfigurationSetting
| 名字 | 描述 | 价值 |
|---|---|---|
| actionAfterReboot | 指定在配置应用程序期间重新启动后发生的情况。 可能的值为 ContinueConfiguration 和 StopConfiguration | “ContinueConfiguration” 'StopConfiguration' |
| allowModuleOverwrite | 如果为 true - 允许从请求服务下载的新配置覆盖目标节点上的旧配置。 否则为 false | bool |
| configurationMode | 指定 LCM（本地配置管理器）如何实际将配置应用于目标节点。 可能的值为 ApplyOnly、ApplyAndMonitor 和 ApplyAndAutoCorrect。 | “ApplyAndAutoCorrect” “ApplyAndMonitor” “ApplyOnly” |
| configurationModeFrequencyMins | 检查并应用当前配置的频率（以分钟为单位）。 如果将 ConfigurationMode 属性设置为 ApplyOnly，则忽略此属性。 默认值为 15。 | int |
| rebootIfNeeded | 将此设置为 true，以在应用需要重新启动的配置后自动重新启动节点。 否则，必须针对需要节点的任何配置手动重新启动节点。 默认值为 false。 若要在 DSC 以外的内容（如 Windows Installer）颁布重新启动条件时使用此设置，请结合使用此设置与 xPendingReboot 模块。 | bool |
| refreshFrequencyMins | LCM 检查请求服务以获取更新配置的时间间隔（以分钟为单位）。 如果未在拉取模式下配置 LCM，则忽略此值。 默认值为 30。 | int |
GuestConfigurationAssignmentProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| 上下文 | 启动来宾配置分配的源。 例如：Azure Policy | 字符串 |
| guestConfiguration | 要分配的来宾配置。 | GuestConfigurationNavigation |
GuestConfigurationNavigation
| 名字 | 描述 | 价值 |
|---|---|---|
| configurationParameter | 来宾配置的配置参数。 | ConfigurationParameter[] |
| configurationSetting | 来宾配置的配置设置。 | ConfigurationSetting |
| 类 | 来宾配置的种类。 例如：DSC | “DSC” |
| 名字 | 来宾配置的名称。 | 字符串 |
| 版本 | 来宾配置的版本。 | 字符串 |
Microsoft.GuestConfiguration/guestConfigurationAssignments
| 名字 | 描述 | 价值 |
|---|---|---|
| 位置 | VM 所在的区域。 | 字符串 |
| 名字 | 资源名称 | string （必需） |
| parent_id | 要向其应用此扩展资源的资源的 ID。 | string （必需） |
| 性能 | 来宾配置分配的属性。 | GuestConfigurationAssignmentProperties |
| 类型 | 资源类型 | “Microsoft.GuestConfiguration/guestConfigurationAssignments@2018-06-30-preview” |