你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
Microsoft.GuestConfiguration guestConfigurationAssignments
Bicep 资源定义
guestConfigurationAssignments 资源类型是一种 扩展资源，这意味着你可以将其应用到其他资源。
使用此资源的 scope 属性设置此资源的范围。 请参阅 在 Bicep中设置扩展资源的范围。
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.GuestConfiguration/guestConfigurationAssignments 资源，请将以下 Bicep 添加到模板。
resource symbolicname 'Microsoft.GuestConfiguration/guestConfigurationAssignments@2022-01-25' = {
name: 'string'
location: 'string'
scope: resourceSymbolicName
properties: {
context: 'string'
guestConfiguration: {
assignmentType: 'string'
configurationParameter: [
{
name: 'string'
value: 'string'
}
]
configurationProtectedParameter: [
{
name: 'string'
value: 'string'
}
]
contentHash: 'string'
contentUri: 'string'
kind: 'DSC'
name: 'string'
version: 'string'
}
latestAssignmentReport: {
assignment: {
configuration: {}
}
resources: [
{
reasons: [
{
}
]
}
]
vm: {}
}
vmssVMList: [
{
}
]
}
}
属性值
guestConfigurationAssignments
| 名字 | 描述 | 价值 |
|---|---|---|
| 名字 | 资源名称 | string （必需） |
| 位置 | VM 所在的区域。 | 字符串 |
| 范围 | 在与部署范围不同的范围内创建扩展资源时使用。 | 目标资源 对于 Bicep，请将此属性设置为资源的符号名称，以应用 扩展资源。 |
| 性能 | 来宾配置分配的属性。 | GuestConfigurationAssignmentProperties |
GuestConfigurationAssignmentProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| 上下文 | 启动来宾配置分配的源。 例如：Azure Policy | 字符串 |
| guestConfiguration | 要分配的来宾配置。 | GuestConfigurationNavigation |
| latestAssignmentReport | 上次报告的来宾配置分配报告。 | AssignmentReport |
| vmssVMList | VMSS 的 VM 符合性数据列表 | VmssvmInfo[] |
GuestConfigurationNavigation
| 名字 | 描述 | 价值 |
|---|---|---|
| assignmentType | 指定配置分配类型和执行。 可能的值为 Audit、DeployAndAutoCorrect、ApplyAndAutoCorrect 和 ApplyAndMonitor。 | “ApplyAndAutoCorrect” “ApplyAndMonitor” “Audit” “DeployAndAutoCorrect” |
| configurationParameter | 来宾配置的配置参数。 | ConfigurationParameter[] |
| configurationProtectedParameter | 来宾配置的受保护配置参数。 | ConfigurationParameter[] |
| contentHash | 来宾配置包和配置参数的组合哈希。 | 字符串 |
| contentUri | 上传来宾配置包的存储的 URI。 | 字符串 |
| 类 | 来宾配置的种类。 例如：DSC | “DSC” |
| 名字 | 来宾配置的名称。 | 字符串 |
| 版本 | 来宾配置的版本。 | 字符串 |
ConfigurationParameter
| 名字 | 描述 | 价值 |
|---|---|---|
| 名字 | 配置参数的名称。 | 字符串 |
| 价值 | 配置参数的值。 | 字符串 |
AssignmentReport
| 名字 | 描述 | 价值 |
|---|---|---|
| 分配 | 来宾配置分配的配置详细信息。 | AssignmentInfo |
| 资源 | 检查来宾配置分配符合性的资源列表。 | AssignmentReportResource[] |
| vm | 有关 VM 的信息。 | VMInfo |
AssignmentInfo
| 名字 | 描述 | 价值 |
|---|---|---|
| 配置 | 有关配置的信息。 | ConfigurationInfo |
ConfigurationInfo
此对象不包含在部署期间设置的任何属性。 所有属性都是 ReadOnly。
AssignmentReportResource
| 名字 | 描述 | 价值 |
|---|---|---|
| 原因 | 资源的符合性原因和原因代码。 | AssignmentReportResourceComplianceReason[] |
AssignmentReportResourceComplianceReason
此对象不包含在部署期间设置的任何属性。 所有属性都是 ReadOnly。
VMInfo
此对象不包含在部署期间设置的任何属性。 所有属性都是 ReadOnly。
VmssvmInfo
此对象不包含在部署期间设置的任何属性。 所有属性都是 ReadOnly。
快速入门模板
以下快速入门模板部署此资源类型。
| 模板 | 描述 |
|---|---|
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 资源类型是一种 扩展资源，这意味着你可以将其应用到其他资源。
使用此资源的 scope 属性设置此资源的范围。 请参阅 在 ARM 模板中设置扩展资源的范围。
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.GuestConfiguration/guestConfigurationAssignments 资源，请将以下 JSON 添加到模板。
{
"type": "Microsoft.GuestConfiguration/guestConfigurationAssignments",
"apiVersion": "2022-01-25",
"name": "string",
"location": "string",
"scope": "string",
"properties": {
"context": "string",
"guestConfiguration": {
"assignmentType": "string",
"configurationParameter": [
{
"name": "string",
"value": "string"
}
],
"configurationProtectedParameter": [
{
"name": "string",
"value": "string"
}
],
"contentHash": "string",
"contentUri": "string",
"kind": "DSC",
"name": "string",
"version": "string"
},
"latestAssignmentReport": {
"assignment": {
"configuration": {}
},
"resources": [
{
"reasons": [
{
}
]
}
],
"vm": {}
},
"vmssVMList": [
{
}
]
}
}
属性值
guestConfigurationAssignments
| 名字 | 描述 | 价值 |
|---|---|---|
| 类型 | 资源类型 | “Microsoft.GuestConfiguration/guestConfigurationAssignments” |
| apiVersion | 资源 API 版本 | '2022-01-25' |
| 名字 | 资源名称 | string （必需） |
| 位置 | VM 所在的区域。 | 字符串 |
| 范围 | 在与部署范围不同的范围内创建扩展资源时使用。 | 目标资源 对于 JSON，请将该值设置为资源全名，以将 扩展资源 应用到该资源。 |
| 性能 | 来宾配置分配的属性。 | GuestConfigurationAssignmentProperties |
GuestConfigurationAssignmentProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| 上下文 | 启动来宾配置分配的源。 例如：Azure Policy | 字符串 |
| guestConfiguration | 要分配的来宾配置。 | GuestConfigurationNavigation |
| latestAssignmentReport | 上次报告的来宾配置分配报告。 | AssignmentReport |
| vmssVMList | VMSS 的 VM 符合性数据列表 | VmssvmInfo[] |
GuestConfigurationNavigation
| 名字 | 描述 | 价值 |
|---|---|---|
| assignmentType | 指定配置分配类型和执行。 可能的值为 Audit、DeployAndAutoCorrect、ApplyAndAutoCorrect 和 ApplyAndMonitor。 | “ApplyAndAutoCorrect” “ApplyAndMonitor” “Audit” “DeployAndAutoCorrect” |
| configurationParameter | 来宾配置的配置参数。 | ConfigurationParameter[] |
| configurationProtectedParameter | 来宾配置的受保护配置参数。 | ConfigurationParameter[] |
| contentHash | 来宾配置包和配置参数的组合哈希。 | 字符串 |
| contentUri | 上传来宾配置包的存储的 URI。 | 字符串 |
| 类 | 来宾配置的种类。 例如：DSC | “DSC” |
| 名字 | 来宾配置的名称。 | 字符串 |
| 版本 | 来宾配置的版本。 | 字符串 |
ConfigurationParameter
| 名字 | 描述 | 价值 |
|---|---|---|
| 名字 | 配置参数的名称。 | 字符串 |
| 价值 | 配置参数的值。 | 字符串 |
AssignmentReport
| 名字 | 描述 | 价值 |
|---|---|---|
| 分配 | 来宾配置分配的配置详细信息。 | AssignmentInfo |
| 资源 | 检查来宾配置分配符合性的资源列表。 | AssignmentReportResource[] |
| vm | 有关 VM 的信息。 | VMInfo |
AssignmentInfo
| 名字 | 描述 | 价值 |
|---|---|---|
| 配置 | 有关配置的信息。 | ConfigurationInfo |
ConfigurationInfo
此对象不包含在部署期间设置的任何属性。 所有属性都是 ReadOnly。
AssignmentReportResource
| 名字 | 描述 | 价值 |
|---|---|---|
| 原因 | 资源的符合性原因和原因代码。 | AssignmentReportResourceComplianceReason[] |
AssignmentReportResourceComplianceReason
此对象不包含在部署期间设置的任何属性。 所有属性都是 ReadOnly。
VMInfo
此对象不包含在部署期间设置的任何属性。 所有属性都是 ReadOnly。
VmssvmInfo
此对象不包含在部署期间设置的任何属性。 所有属性都是 ReadOnly。
快速入门模板
以下快速入门模板部署此资源类型。
| 模板 | 描述 |
|---|---|
|
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 资源类型是一种 扩展资源，这意味着你可以将其应用到其他资源。
使用此资源的 parent_id 属性设置此资源的范围。
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.GuestConfiguration/guestConfigurationAssignments 资源，请将以下 Terraform 添加到模板。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.GuestConfiguration/guestConfigurationAssignments@2022-01-25"
name = "string"
location = "string"
parent_id = "string"
body = jsonencode({
properties = {
context = "string"
guestConfiguration = {
assignmentType = "string"
configurationParameter = [
{
name = "string"
value = "string"
}
]
configurationProtectedParameter = [
{
name = "string"
value = "string"
}
]
contentHash = "string"
contentUri = "string"
kind = "DSC"
name = "string"
version = "string"
}
latestAssignmentReport = {
assignment = {
configuration = {}
}
resources = [
{
reasons = [
{
}
]
}
]
vm = {}
}
vmssVMList = [
{
}
]
}
})
}
属性值
guestConfigurationAssignments
| 名字 | 描述 | 价值 |
|---|---|---|
| 类型 | 资源类型 | “Microsoft.GuestConfiguration/guestConfigurationAssignments@2022-01-25” |
| 名字 | 资源名称 | string （必需） |
| 位置 | VM 所在的区域。 | 字符串 |
| parent_id | 要向其应用此扩展资源的资源的 ID。 | string （必需） |
| 性能 | 来宾配置分配的属性。 | GuestConfigurationAssignmentProperties |
GuestConfigurationAssignmentProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| 上下文 | 启动来宾配置分配的源。 例如：Azure Policy | 字符串 |
| guestConfiguration | 要分配的来宾配置。 | GuestConfigurationNavigation |
| latestAssignmentReport | 上次报告的来宾配置分配报告。 | AssignmentReport |
| vmssVMList | VMSS 的 VM 符合性数据列表 | VmssvmInfo[] |
GuestConfigurationNavigation
| 名字 | 描述 | 价值 |
|---|---|---|
| assignmentType | 指定配置分配类型和执行。 可能的值为 Audit、DeployAndAutoCorrect、ApplyAndAutoCorrect 和 ApplyAndMonitor。 | “ApplyAndAutoCorrect” “ApplyAndMonitor” “审核” “DeployAndAutoCorrect” |
| configurationParameter | 来宾配置的配置参数。 | ConfigurationParameter[] |
| configurationProtectedParameter | 来宾配置的受保护配置参数。 | ConfigurationParameter[] |
| contentHash | 来宾配置包和配置参数的组合哈希。 | 字符串 |
| contentUri | 上传来宾配置包的存储的 URI。 | 字符串 |
| 类 | 来宾配置的种类。 例如：DSC | “DSC” |
| 名字 | 来宾配置的名称。 | 字符串 |
| 版本 | 来宾配置的版本。 | 字符串 |
ConfigurationParameter
| 名字 | 描述 | 价值 |
|---|---|---|
| 名字 | 配置参数的名称。 | 字符串 |
| 价值 | 配置参数的值。 | 字符串 |
AssignmentReport
| 名字 | 描述 | 价值 |
|---|---|---|
| 分配 | 来宾配置分配的配置详细信息。 | AssignmentInfo |
| 资源 | 检查来宾配置分配符合性的资源列表。 | AssignmentReportResource[] |
| vm | 有关 VM 的信息。 | VMInfo |
AssignmentInfo
| 名字 | 描述 | 价值 |
|---|---|---|
| 配置 | 有关配置的信息。 | ConfigurationInfo |
ConfigurationInfo
此对象不包含在部署期间设置的任何属性。 所有属性都是 ReadOnly。
AssignmentReportResource
| 名字 | 描述 | 价值 |
|---|---|---|
| 原因 | 资源的符合性原因和原因代码。 | AssignmentReportResourceComplianceReason[] |
AssignmentReportResourceComplianceReason
此对象不包含在部署期间设置的任何属性。 所有属性都是 ReadOnly。
VMInfo
此对象不包含在部署期间设置的任何属性。 所有属性都是 ReadOnly。
VmssvmInfo
此对象不包含在部署期间设置的任何属性。 所有属性都是 ReadOnly。