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

Guest Configuration Assignments - Get

服务:

Guest Configuration

API 版本:

2024-04-05

获取有关来宾配置分配的信息

GET 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	资源组名称。 正则表达式模式: ^[-\w\._]+$
subscriptionId	path	True	string	唯一标识 azure 订阅Microsoft的订阅 ID。 订阅 ID 构成了每个服务调用的 URI 的一部分。
vmName	path	True	string	虚拟机的名称。 正则表达式模式: ^[a-zA-Z0-9][-a-zA-Z0-9_.]*[a-zA-Z0-9]$
api-version	query	True	string	客户端 API 版本。

响应

名称	类型	说明
200 OK	GuestConfigurationAssignment	还行。 已成功返回来宾配置分配。
Other Status Codes	ErrorResponse	描述操作失败的原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

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

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

Get a guest configuration assignment

示例请求

HTTP

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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.GuestConfiguration.Models;
using Azure.ResourceManager.GuestConfiguration;

// Generated from example definition: specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/getGuestConfigurationAssignment.json
// this example is just showing the usage of "GuestConfigurationAssignments_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ArmResource created on azure
// for more information of creating ArmResource, please refer to the document of ArmResource

// get the collection of this GuestConfigurationVmAssignmentResource
string subscriptionId = "mySubscriptionId";
string resourceGroupName = "myResourceGroupName";
string vmName = "myVMName";
ResourceIdentifier scopeId = new ResourceIdentifier(string.Format("/subscriptions/{0}/resourceGroups/{1}/providers/Microsoft.Compute/virtualMachines/{2}", subscriptionId, resourceGroupName, vmName));
GuestConfigurationVmAssignmentCollection collection = client.GetGuestConfigurationVmAssignments(scopeId);

// invoke the operation
string guestConfigurationAssignmentName = "SecureProtocol";
NullableResponse<GuestConfigurationVmAssignmentResource> response = await collection.GetIfExistsAsync(guestConfigurationAssignmentName);
GuestConfigurationVmAssignmentResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine($"Succeeded with null as result");
}
else
{
    // the variable result is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    GuestConfigurationAssignmentData resourceData = result.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

示例响应

状态代码:

200

{
  "location": "centraluseuap",
  "id": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol",
  "name": "AuditSecureProtocol",
  "properties": {
    "complianceStatus": "Compliant",
    "assignmentHash": "E0D8941DD713F284284561648C00C18FA76C8602943C7CD38AFD73B56AE4C35F.E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855",
    "latestReportId": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol/reports/7367cbb8-ae99-47d0-a33b-a283564d2cb1",
    "lastComplianceStatusChecked": "2018-08-29T22:14:13Z",
    "context": null,
    "guestConfiguration": {
      "kind": null,
      "name": "AuditSecureProtocol",
      "version": "1.0.0.3",
      "contentUri": "https://mystorageaccount.blob.core.windows.net/builtinconfig/AuditSecureProtocol/AuditSecureProtocol_1.0.0.3.zip",
      "contentHash": "content hash",
      "contentManagedIdentity": "test_identity",
      "configurationParameter": [],
      "configurationSetting": null
    },
    "provisioningState": "Succeeded"
  }
}

定义

名称	说明
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	string
StopConfiguration	string

AssignmentInfo

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

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

AssignmentReport

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

AssignmentReportResource

来宾配置分配资源。

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

AssignmentReportResourceComplianceReason

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

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

assignmentType

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

名称	类型	说明
ApplyAndAutoCorrect	string
ApplyAndMonitor	string
Audit	string
DeployAndAutoCorrect	string

complianceStatus

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

名称	类型	说明
Compliant	string
NonCompliant	string
Pending	string

ConfigurationInfo

有关配置的信息。

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

configurationMode

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

名称	类型	说明
ApplyAndAutoCorrect	string
ApplyAndMonitor	string
ApplyOnly	string

ConfigurationParameter

表示配置参数。

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

ConfigurationSetting

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

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

createdByType

创建资源的标识的类型。

名称	类型	说明
Application	string
Key	string
ManagedIdentity	string
User	string

Error

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

ErrorResponse

操作失败的错误响应

名称	类型	说明
error	Error

GuestConfigurationAssignment

来宾配置分配是计算机与来宾配置之间的关联。

名称	类型	说明
id	string	来宾配置分配的 ARM 资源 ID。
location	string	VM 所在的区域。
name	string	来宾配置分配的名称。
properties	GuestConfigurationAssignmentProperties	来宾配置分配的属性。
systemData	systemData	包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。
type	string	资源的类型。

GuestConfigurationAssignmentProperties

来宾配置分配属性。

名称	类型	说明
assignmentHash	string	配置包和参数的组合哈希。
complianceStatus	complianceStatus	一个值，指示已分配来宾配置的计算机的符合性状态。
context	string	启动来宾配置分配的源。 例如：Azure Policy
guestConfiguration	GuestConfigurationNavigation	要分配的来宾配置。
lastComplianceStatusChecked	string	上次检查符合性状态的日期和时间。
latestAssignmentReport	AssignmentReport	上次报告的来宾配置分配报告。
latestReportId	string	来宾配置分配的最新报表的 ID。
parameterHash	string	来宾配置分配的参数哈希。
provisioningState	provisioningState	预配状态，仅出现在响应中。
resourceType	string	资源类型 - VMSS/VM
targetResourceId	string	VM 资源 ID。
vmssVMList	VMSSVMInfo[]	VMSS 的 VM 符合性数据列表

GuestConfigurationNavigation

来宾配置是封装 DSC 配置及其依赖项的项目。 项目是一个 zip 文件，其中包含 DSC 配置（如 MOF）以及依赖的资源和其他依赖项（如模块）。

名称	类型	说明
assignmentSource	string	指定配置的源。
assignmentType	assignmentType	指定配置分配类型和执行。 可能的值为 Audit、DeployAndAutoCorrect、ApplyAndAutoCorrect 和 ApplyAndMonitor。
configurationParameter	ConfigurationParameter[]	来宾配置的配置参数。
configurationProtectedParameter	ConfigurationParameter[]	来宾配置的受保护配置参数。
configurationSetting	ConfigurationSetting	来宾配置的配置设置。
contentHash	string	来宾配置包和配置参数的组合哈希。
contentManagedIdentity	string	具有来宾配置包和配置参数存储访问权限的托管标识。
contentType	string	指定配置的内容类型。 可能的值可以是 Builtin 或 Custom。
contentUri	string	上传来宾配置包的存储的 URI。
kind	kind	来宾配置的种类。 例如：DSC
name	string	来宾配置的名称。
version	string	来宾配置的版本。

kind

来宾配置的种类。 例如：DSC

名称	类型	说明
DSC	string

provisioningState

预配状态，仅出现在响应中。

名称	类型	说明
Canceled	string
Created	string
Failed	string
Succeeded	string

systemData

与创建和上次修改资源相关的元数据。

名称	类型	说明
createdAt	string	资源创建时间戳（UTC）。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识的类型。
lastModifiedAt	string	上次修改的资源时间戳（UTC）
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	createdByType	上次修改资源的标识的类型。

type

报表类型、一致性或初始类型

名称	类型	说明
Consistency	string
Initial	string

VMInfo

有关 VM 的信息。

名称	类型	说明
id	string	VM 的 Azure 资源 ID。
uuid	string	VM 的 UUID（通用唯一标识符）。

VMSSVMInfo

有关 VMSS VM 的信息

名称	类型	说明
complianceStatus	complianceStatus	一个值，指示已分配来宾配置的计算机的符合性状态。
lastComplianceChecked	string	上次检查符合性状态的日期和时间。
latestReportId	string	来宾配置分配的最新报表的 ID。
vmId	string	VM 的 UUID。
vmResourceId	string	VM 的 Azure 资源 ID。