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

Guest Configuration Assignments - Create Or Update

服务:: Guest Configuration

API 版本:: 2024-04-05

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

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/{guestConfigurationAssignmentName}?api-version=2024-04-05

URI 参数

名称	在	必需	类型	说明
guestConfigurationAssignmentName	path	True	string	来宾配置分配名称。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	资源组的名称。此名称不区分大小写。
subscriptionId	path	True	string minLength: 1	目标订阅的 ID。
vmName	path	True	string pattern: ^[a-zA-Z0-9][-a-zA-Z0-9_.]*[a-zA-Z0-9]$	虚拟机的名称。
api-version	query	True	string minLength: 1	用于此操作的 API 版本。

请求正文

名称	必需	类型	说明
name	True	string	来宾配置分配名称。
location		string	VM 所在的区域。
properties		GuestConfigurationAssignmentProperties	来宾配置分配的属性。

响应

名称	类型	说明
200 OK	GuestConfigurationAssignment	资源“GuestConfigurationAssignment”更新作成功
201 Created	GuestConfigurationAssignment	资源“GuestConfigurationAssignment”创建作成功
Other Status Codes	ErrorResponse	意外的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流程。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

Create or update guest configuration assignment

示例请求

HTTP

PUT https://management.azure.com/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myVMName/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/NotInstalledApplicationForWindows?api-version=2024-04-05

{
  "name": "NotInstalledApplicationForWindows",
  "location": "westcentralus",
  "properties": {
    "context": "Azure policy",
    "guestConfiguration": {
      "name": "NotInstalledApplicationForWindows",
      "assignmentType": "ApplyAndAutoCorrect",
      "configurationParameter": [
        {
          "name": "[InstalledApplication]NotInstalledApplicationResource1;Name",
          "value": "NotePad,sql"
        }
      ],
      "contentHash": "123contenthash",
      "contentManagedIdentity": "test_identity",
      "contentUri": "https://thisisfake/pacakge",
      "version": "1.0.0.3"
    }
  }
}

示例响应

状态代码:: 200

{
  "name": "NotInstalledApplicationForWindows",
  "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/NotInstalledApplicationForWindows",
  "location": "westcentralus",
  "properties": {
    "assignmentHash": null,
    "complianceStatus": "Pending",
    "context": "Azure policy",
    "guestConfiguration": {
      "name": "NotInstalledApplicationForWindows",
      "assignmentSource": "AzurePolicy",
      "configurationParameter": [
        {
          "name": "[InstalledApplication]NotInstalledApplicationResource1;Name",
          "value": "NotePad,sql"
        }
      ],
      "contentHash": null,
      "contentManagedIdentity": null,
      "contentType": null,
      "contentUri": null,
      "kind": null,
      "version": "1.0.0.3"
    },
    "lastComplianceStatusChecked": null,
    "latestReportId": null,
    "provisioningState": "Succeeded",
    "resourceType": null,
    "vmssVMList": null
  }
}

状态代码:: 201

{
  "name": "NotInstalledApplicationForWindows",
  "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/NotInstalledApplicationForWindows",
  "location": "westcentralus",
  "properties": {
    "assignmentHash": null,
    "complianceStatus": "Pending",
    "context": "Azure policy",
    "guestConfiguration": {
      "name": "NotInstalledApplicationForWindows",
      "assignmentSource": "AzurePolicy",
      "configurationParameter": [
        {
          "name": "[InstalledApplication]NotInstalledApplicationResource1;Name",
          "value": "NotePad,sql"
        }
      ],
      "contentHash": null,
      "contentManagedIdentity": null,
      "contentType": null,
      "contentUri": null,
      "kind": null,
      "version": "1.0.0.3"
    },
    "lastComplianceStatusChecked": null,
    "latestReportId": null,
    "provisioningState": "Succeeded",
    "resourceType": null,
    "vmssVMList": null
  }
}

定义

名称	说明
ActionAfterReboot	指定在配置应用程序期间重新启动后发生的情况。可能的值为 ContinueConfiguration 和 StopConfiguration
AssignmentInfo	有关来宾配置分配的信息。
AssignmentReport
AssignmentReportResource	来宾配置分配资源。
AssignmentReportResourceComplianceReason	来宾配置分配资源符合性的原因和代码。
AssignmentType	指定配置分配类型和执行。可能的值为 Audit、DeployAndAutoCorrect、ApplyAndAutoCorrect 和 ApplyAndMonitor。
ComplianceStatus	一个值，指示已分配来宾配置的计算机的符合性状态。
ConfigurationInfo	有关配置的信息。
ConfigurationMode	指定 LCM（本地配置管理器）如何实际将配置应用于目标节点。可能的值为 ApplyOnly、ApplyAndMonitor 和 ApplyAndAutoCorrect。
ConfigurationParameter	表示配置参数。
ConfigurationSetting	LCM（本地配置管理器）的配置设置。
createdByType	创建资源的标识的类型。
Error
ErrorResponse	作失败的错误响应。
GuestConfigurationAssignment	来宾配置分配是计算机与来宾配置之间的关联。
GuestConfigurationAssignmentProperties	来宾配置分配属性。
GuestConfigurationNavigation	来宾配置是封装 DSC 配置及其依赖项的项目。项目是一个 zip 文件，其中包含 DSC 配置（如 MOF）以及依赖的资源和其他依赖项（如模块）。
Kind	来宾配置的种类。例如：DSC
ProvisioningState	预配状态，仅出现在响应中。
systemData	与创建和上次修改资源相关的元数据。
Type	报表类型、一致性或初始类型
VMInfo	有关 VM 的信息。
VMSSVMInfo	有关 VMSS VM 的信息

ActionAfterReboot

枚举

指定在配置应用程序期间重新启动后发生的情况。可能的值为 ContinueConfiguration 和 StopConfiguration

值	说明
ContinueConfiguration
StopConfiguration

AssignmentInfo

Object

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

名称	类型	说明
configuration	ConfigurationInfo	有关配置的信息。
name	string	来宾配置分配的名称。

AssignmentReport

Object

名称	类型	说明
assignment	AssignmentInfo	来宾配置分配的配置详细信息。
complianceStatus	ComplianceStatus	一个值，指示已分配来宾配置的计算机的符合性状态。
endTime	string (date-time)	来宾配置分配符合性状态检查的结束日期和时间。
id	string	来宾配置分配报表的 ARM 资源 ID。
operationType	Type	报表类型、一致性或初始类型
reportId	string	用于标识订阅、资源组下来宾配置分配报告的 GUID。
resources	AssignmentReportResource[]	检查来宾配置分配符合性的资源列表。
startTime	string (date-time)	来宾配置分配符合性状态检查的开始日期和时间。
vm	VMInfo	有关 VM 的信息。

AssignmentReportResource

Object

来宾配置分配资源。

名称	类型	说明
complianceStatus	ComplianceStatus	一个值，指示已分配来宾配置的计算机的符合性状态。
properties		来宾配置分配资源的属性。
reasons	AssignmentReportResourceComplianceReason[]	资源的符合性原因和原因代码。
resourceId	string	来宾配置分配资源设置的名称。

AssignmentReportResourceComplianceReason

Object

来宾配置分配资源符合性的原因和代码。

名称	类型	说明
code	string	来宾配置分配资源的符合性代码。
phrase	string	来宾配置分配资源的符合性的原因。

AssignmentType

枚举

指定配置分配类型和执行。可能的值为 Audit、DeployAndAutoCorrect、ApplyAndAutoCorrect 和 ApplyAndMonitor。

值	说明
Audit
DeployAndAutoCorrect
ApplyAndAutoCorrect
ApplyAndMonitor

ComplianceStatus

枚举

一个值，指示已分配来宾配置的计算机的符合性状态。

值	说明
Compliant
NonCompliant
Pending

ConfigurationInfo

Object

有关配置的信息。

名称	类型	说明
name	string	配置的名称。
version	string	配置的版本。

ConfigurationMode

枚举

指定 LCM（本地配置管理器）如何实际将配置应用于目标节点。可能的值为 ApplyOnly、ApplyAndMonitor 和 ApplyAndAutoCorrect。

值	说明
ApplyOnly
ApplyAndMonitor
ApplyAndAutoCorrect

ConfigurationParameter

Object

表示配置参数。

名称	类型	说明
name	string	配置参数的名称。
value	string	配置参数的值。

ConfigurationSetting

Object

LCM（本地配置管理器）的配置设置。

名称	类型	默认值	说明
actionAfterReboot	ActionAfterReboot		指定在配置应用程序期间重新启动后发生的情况。可能的值为 ContinueConfiguration 和 StopConfiguration
allowModuleOverwrite	boolean		如果为 true - 允许从请求服务下载的新配置覆盖目标节点上的旧配置。否则为 false
configurationMode	ConfigurationMode		指定 LCM（本地配置管理器）如何实际将配置应用于目标节点。可能的值为 ApplyOnly、ApplyAndMonitor 和 ApplyAndAutoCorrect。
configurationModeFrequencyMins	number (float)	15	检查并应用当前配置的频率（以分钟为单位）。如果将 ConfigurationMode 属性设置为 ApplyOnly，则忽略此属性。默认值为 15。
rebootIfNeeded	boolean		将此设置为 true，以在应用需要重新启动的配置后自动重新启动节点。否则，必须针对需要节点的任何配置手动重新启动节点。默认值为 false。若要在 DSC 以外的内容（如 Windows Installer）颁布重新启动条件时使用此设置，请结合使用此设置与 xPendingReboot 模块。
refreshFrequencyMins	number (float)	30	LCM 检查请求服务以获取更新配置的时间间隔（以分钟为单位）。如果未在拉取模式下配置 LCM，则忽略此值。默认值为 30。

createdByType

枚举

创建资源的标识的类型。

值	说明
User
Application
ManagedIdentity
Key

Error

Object

名称	类型	说明
code	string	错误代码。
message	string	详细错误消息，指示操作失败的原因。

ErrorResponse

Object

作失败的错误响应。

名称	类型	说明
error	Error