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

Microsoft.GuestConfiguration guestConfigurationAssignments

• 最新
• 2024-04-05
• 2022-01-25
• 2021-01-25
• 2020-06-25
• 2018-11-20
• 2018-06-30-preview
• 2018-01-20-preview

Bicep 资源定义

可以使用目标操作部署 guestConfigurationAssignments 资源类型：

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.GuestConfiguration/guestConfigurationAssignments 资源，请将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.GuestConfiguration/guestConfigurationAssignments@2024-04-05' = {
  scope: resourceSymbolicName or scope
  location: 'string'
  name: 'string'
  properties: {
    context: 'string'
    guestConfiguration: {
      assignmentType: 'string'
      configurationParameter: [
        {
          name: 'string'
          value: 'string'
        }
      ]
      configurationProtectedParameter: [
        {
          name: 'string'
          value: 'string'
        }
      ]
      contentHash: 'string'
      contentManagedIdentity: 'string'
      contentUri: 'string'
      kind: 'string'
      name: 'string'
      version: 'string'
    }
    latestAssignmentReport: {
      assignment: {
        configuration: {}
      }
      resources: [
        {
          reasons: [
            {}
          ]
        }
      ]
      vm: {}
    }
    vmssVMList: [
      {}
    ]
  }
}

属性值

AssignmentInfo

名字	描述	价值
配置	有关配置的信息。	ConfigurationInfo

AssignmentReport

名字	描述	价值
分配	来宾配置分配的配置详细信息。	AssignmentInfo
资源	检查来宾配置分配符合性的资源列表。	AssignmentReportResource[]
vm	有关 VM 的信息。	VMInfo

AssignmentReportResource

名字	描述	价值
原因	资源的符合性原因和原因代码。	AssignmentReportResourceComplianceReason[]

AssignmentReportResourceComplianceReason

名字	描述	价值

ConfigurationInfo

名字	描述	价值

ConfigurationParameter

名字	描述	价值
名字	配置参数的名称。	字符串
价值	配置参数的值。	字符串

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	来宾配置包和配置参数的组合哈希。	字符串
contentManagedIdentity	具有来宾配置包和配置参数存储访问权限的托管标识。	字符串
contentUri	上传来宾配置包的存储的 URI。	字符串
类	来宾配置的种类。 例如：DSC	“DSC”
名字	来宾配置的名称。	字符串
版本	来宾配置的版本。	字符串

Microsoft.GuestConfiguration/guestConfigurationAssignments

名字	描述	价值
位置	VM 所在的区域。	字符串
名字	资源名称	string （必需）
性能	来宾配置分配的属性。	GuestConfigurationAssignmentProperties
范围	在与部署范围不同的范围内创建资源时使用。	将此属性设置为资源的符号名称，以应用 扩展资源。

VMInfo

名字	描述	价值

VmssvmInfo

名字	描述	价值

快速入门示例

以下快速入门示例部署此资源类型。

Bicep 文件	描述
SQL Server 2014 VM & IIS VM	在 VNET 中创建 1 或 2 个 IIS Windows 2012 R2 Web 服务器和一个后端 SQL Server 2014。
使用 Azure 安全基线 Windows VM	该模板使用公共 IP 地址在新虚拟网络中创建运行 Windows Server 的虚拟机。 部署计算机后，将安装来宾配置扩展，并应用 Windows Server 的 Azure 安全基线。 如果计算机配置偏移，可以通过再次部署模板来重新应用设置。

ARM 模板资源定义

可以使用目标操作部署 guestConfigurationAssignments 资源类型：

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.GuestConfiguration/guestConfigurationAssignments 资源，请将以下 JSON 添加到模板。

{
  "type": "Microsoft.GuestConfiguration/guestConfigurationAssignments",
  "apiVersion": "2024-04-05",
  "name": "string",
  "location": "string",
  "properties": {
    "context": "string",
    "guestConfiguration": {
      "assignmentType": "string",
      "configurationParameter": [
        {
          "name": "string",
          "value": "string"
        }
      ],
      "configurationProtectedParameter": [
        {
          "name": "string",
          "value": "string"
        }
      ],
      "contentHash": "string",
      "contentManagedIdentity": "string",
      "contentUri": "string",
      "kind": "string",
      "name": "string",
      "version": "string"
    },
    "latestAssignmentReport": {
      "assignment": {
        "configuration": {
        }
      },
      "resources": [
        {
          "reasons": [
            {
            }
          ]
        }
      ],
      "vm": {
      }
    },
    "vmssVMList": [
      {
      }
    ]
  }
}

属性值

AssignmentInfo

名字	描述	价值
配置	有关配置的信息。	ConfigurationInfo

AssignmentReport

名字	描述	价值
分配	来宾配置分配的配置详细信息。	AssignmentInfo
资源	检查来宾配置分配符合性的资源列表。	AssignmentReportResource[]
vm	有关 VM 的信息。	VMInfo

AssignmentReportResource

名字	描述	价值
原因	资源的符合性原因和原因代码。	AssignmentReportResourceComplianceReason[]

AssignmentReportResourceComplianceReason

名字	描述	价值

ConfigurationInfo

名字	描述	价值

ConfigurationParameter

名字	描述	价值
名字	配置参数的名称。	字符串
价值	配置参数的值。	字符串

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	来宾配置包和配置参数的组合哈希。	字符串
contentManagedIdentity	具有来宾配置包和配置参数存储访问权限的托管标识。	字符串
contentUri	上传来宾配置包的存储的 URI。	字符串
类	来宾配置的种类。 例如：DSC	“DSC”
名字	来宾配置的名称。	字符串
版本	来宾配置的版本。	字符串

Microsoft.GuestConfiguration/guestConfigurationAssignments

名字	描述	价值
apiVersion	API 版本	'2024-04-05'
位置	VM 所在的区域。	字符串
名字	资源名称	string （必需）
性能	来宾配置分配的属性。	GuestConfigurationAssignmentProperties
类型	资源类型	“Microsoft.GuestConfiguration/guestConfigurationAssignments”

VMInfo

名字	描述	价值

VmssvmInfo

名字	描述	价值

快速入门模板

以下快速入门模板部署此资源类型。

模板	描述
SQL Server 2014 VM & IIS VM	在 VNET 中创建 1 或 2 个 IIS Windows 2012 R2 Web 服务器和一个后端 SQL Server 2014。
使用 Azure 安全基线 Windows VM	该模板使用公共 IP 地址在新虚拟网络中创建运行 Windows Server 的虚拟机。 部署计算机后，将安装来宾配置扩展，并应用 Windows Server 的 Azure 安全基线。 如果计算机配置偏移，可以通过再次部署模板来重新应用设置。

Terraform （AzAPI 提供程序）资源定义

可以使用目标操作部署 guestConfigurationAssignments 资源类型：

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.GuestConfiguration/guestConfigurationAssignments 资源，请将以下 Terraform 添加到模板。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.GuestConfiguration/guestConfigurationAssignments@2024-04-05"
  name = "string"
  parent_id = "string"
  location = "string"
  body = jsonencode({
    properties = {
      context = "string"
      guestConfiguration = {
        assignmentType = "string"
        configurationParameter = [
          {
            name = "string"
            value = "string"
          }
        ]
        configurationProtectedParameter = [
          {
            name = "string"
            value = "string"
          }
        ]
        contentHash = "string"
        contentManagedIdentity = "string"
        contentUri = "string"
        kind = "string"
        name = "string"
        version = "string"
      }
      latestAssignmentReport = {
        assignment = {
          configuration = {
          }
        }
        resources = [
          {
            reasons = [
              {
              }
            ]
          }
        ]
        vm = {
        }
      }
      vmssVMList = [
        {
        }
      ]
    }
  })
}

属性值

AssignmentInfo

名字	描述	价值
配置	有关配置的信息。	ConfigurationInfo

AssignmentReport

名字	描述	价值
分配	来宾配置分配的配置详细信息。	AssignmentInfo
资源	检查来宾配置分配符合性的资源列表。	AssignmentReportResource[]
vm	有关 VM 的信息。	VMInfo

AssignmentReportResource

名字	描述	价值
原因	资源的符合性原因和原因代码。	AssignmentReportResourceComplianceReason[]

AssignmentReportResourceComplianceReason

名字	描述	价值

ConfigurationInfo

名字	描述	价值

ConfigurationParameter

名字	描述	价值
名字	配置参数的名称。	字符串
价值	配置参数的值。	字符串

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	来宾配置包和配置参数的组合哈希。	字符串
contentManagedIdentity	具有来宾配置包和配置参数存储访问权限的托管标识。	字符串
contentUri	上传来宾配置包的存储的 URI。	字符串
类	来宾配置的种类。 例如：DSC	“DSC”
名字	来宾配置的名称。	字符串
版本	来宾配置的版本。	字符串

Microsoft.GuestConfiguration/guestConfigurationAssignments

名字	描述	价值
位置	VM 所在的区域。	字符串
名字	资源名称	string （必需）
parent_id	要向其应用此扩展资源的资源的 ID。	string （必需）
性能	来宾配置分配的属性。	GuestConfigurationAssignmentProperties
类型	资源类型	“Microsoft.GuestConfiguration/guestConfigurationAssignments@2024-04-05”

VMInfo

名字	描述	价值

VmssvmInfo

名字	描述	价值