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 매개 변수

Name	In(다음 안에)	필수	형식	Description
guestConfigurationAssignmentName	path	True	string	게스트 구성 할당의 이름입니다.
resourceGroupName	path	True	string	리소스 그룹 이름입니다. regex 패턴: ^[-\w\._]+$
subscriptionId	path	True	string	Microsoft Azure 구독을 고유하게 식별하는 구독 ID입니다. 구독 ID는 모든 서비스 호출에 대한 URI의 일부를 형성합니다.
vmName	path	True	string	가상 머신의 이름입니다. regex 패턴: ^[a-zA-Z0-9][-a-zA-Z0-9_.]*[a-zA-Z0-9]$
api-version	query	True	string	클라이언트 API 버전입니다.

요청 본문

Name	형식	Description
location	string	VM이 있는 지역입니다.
name	string	게스트 구성 할당의 이름입니다.
properties	GuestConfigurationAssignmentProperties	게스트 구성 할당의 속성입니다.

응답

Name	형식	Description
200 OK	GuestConfigurationAssignment	그래. VM에 대한 게스트 구성 할당이 성공적으로 업데이트되었습니다.
201 Created	GuestConfigurationAssignment	만든. VM에 대한 게스트 구성 할당이 성공적으로 만들어졌습니다.
Other Status Codes	ErrorResponse	작업이 실패한 이유를 설명하는 오류 응답입니다.

보안

azure_auth

Azure Active Directory OAuth2 Flow

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name	Description
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

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

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/createOrUpdateGuestConfigurationAssignment.json
// this example is just showing the usage of "GuestConfigurationAssignments_CreateOrUpdate" 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 = "NotInstalledApplicationForWindows";
GuestConfigurationAssignmentData data = new GuestConfigurationAssignmentData()
{
    Properties = new GuestConfigurationAssignmentProperties()
    {
        GuestConfiguration = new GuestConfigurationNavigation()
        {
            Name = "NotInstalledApplicationForWindows",
            Version = "1.0.0.3",
            ContentUri = new Uri("https://thisisfake/pacakge"),
            ContentHash = "123contenthash",
            ContentManagedIdentity = "test_identity",
            AssignmentType = GuestConfigurationAssignmentType.ApplyAndAutoCorrect,
            ConfigurationParameters =
            {
            new GuestConfigurationParameter()
            {
            Name = "[InstalledApplication]NotInstalledApplicationResource1;Name",
            Value = "NotePad,sql",
            }
            },
        },
        Context = "Azure policy",
    },
    Name = "NotInstalledApplicationForWindows",
    Location = new AzureLocation("westcentralus"),
};
ArmOperation<GuestConfigurationVmAssignmentResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, guestConfigurationAssignmentName, data);
GuestConfigurationVmAssignmentResource result = lro.Value;

// 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

샘플 응답

상태 코드:

201

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

상태 코드:

200

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

정의

Name	Description
actionAfterReboot	구성을 애플리케이션하는 동안 다시 부팅한 후에 발생하는 동작을 지정합니다. 가능한 값은 ContinueConfiguration 및 StopConfiguration입니다.
AssignmentInfo	게스트 구성 할당에 대한 정보입니다.
AssignmentReport
AssignmentReportResource	게스트 구성 할당 리소스입니다.
AssignmentReportResourceComplianceReason	게스트 구성 할당 리소스의 준수 이유 및 코드입니다.
assignmentType	구성의 할당 유형 및 실행을 지정합니다. 가능한 값은 Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect 및 ApplyAndMonitor입니다.
complianceStatus	할당된 게스트 구성에 대한 컴퓨터의 준수 상태를 나타내는 값입니다.
ConfigurationInfo	구성에 대한 정보입니다.
configurationMode	LCM(로컬 구성 관리자)이 실제로 대상 노드에 구성을 적용하는 방법을 지정합니다. 가능한 값은 ApplyOnly, ApplyAndMonitor 및 ApplyAndAutoCorrect입니다.
ConfigurationParameter	구성 매개 변수를 나타냅니다.
ConfigurationSetting	LCM(로컬 구성 관리자)의 구성 설정입니다.
createdByType	리소스를 만든 ID의 형식입니다.
Error
ErrorResponse	작업 실패의 오류 응답
GuestConfigurationAssignment	게스트 구성 할당은 컴퓨터와 게스트 구성 간의 연결입니다.
GuestConfigurationAssignmentProperties	게스트 구성 할당 속성입니다.
GuestConfigurationNavigation	게스트 구성은 DSC 구성 및 해당 종속성을 캡슐화하는 아티팩트입니다. 아티팩트가 DSC 구성(MOF)과 종속 리소스 및 모듈과 같은 기타 종속성을 포함하는 zip 파일입니다.
kind	게스트 구성의 종류입니다. 예: DSC
provisioningState	응답에만 표시되는 프로비전 상태입니다.
systemData	리소스의 생성 및 마지막 수정과 관련된 메타데이터입니다.
type	보고서 유형, 일관성 또는 초기
VMInfo	VM에 대한 정보입니다.
VMSSVMInfo	VMSS VM에 대한 정보

actionAfterReboot

구성을 애플리케이션하는 동안 다시 부팅한 후에 발생하는 동작을 지정합니다. 가능한 값은 ContinueConfiguration 및 StopConfiguration입니다.

Name	형식	Description
ContinueConfiguration	string
StopConfiguration	string

AssignmentInfo

게스트 구성 할당에 대한 정보입니다.

Name	형식	Description
configuration	ConfigurationInfo	구성에 대한 정보입니다.
name	string	게스트 구성 할당의 이름입니다.

AssignmentReport

Name	형식	Description
assignment	AssignmentInfo	게스트 구성 할당의 구성 세부 정보입니다.
complianceStatus	complianceStatus	할당된 게스트 구성에 대한 컴퓨터의 준수 상태를 나타내는 값입니다.
endTime	string	게스트 구성 할당 준수 상태 확인의 종료 날짜 및 시간입니다.
id	string	게스트 구성 할당에 대한 보고서의 ARM 리소스 ID입니다.
operationType	type	보고서 유형, 일관성 또는 초기
reportId	string	구독, 리소스 그룹에서 게스트 구성 할당 보고서를 식별하는 GUID입니다.
resources	AssignmentReportResource[]	게스트 구성 할당 준수를 검사할 리소스 목록입니다.
startTime	string	게스트 구성 할당 준수 상태 확인의 시작 날짜 및 시간입니다.
vm	VMInfo	VM에 대한 정보입니다.

AssignmentReportResource

게스트 구성 할당 리소스입니다.

Name	형식	Description
complianceStatus	complianceStatus	할당된 게스트 구성에 대한 컴퓨터의 준수 상태를 나타내는 값입니다.
properties	object	게스트 구성 할당 리소스의 속성입니다.
reasons	AssignmentReportResourceComplianceReason[]	리소스에 대한 규정 준수 이유 및 이유 코드입니다.
resourceId	string	게스트 구성 할당 리소스 설정의 이름입니다.

AssignmentReportResourceComplianceReason

게스트 구성 할당 리소스의 준수 이유 및 코드입니다.

Name	형식	Description
code	string	게스트 구성 할당 리소스의 준수를 위한 코드입니다.
phrase	string	게스트 구성 할당 리소스를 준수하는 이유입니다.

assignmentType

구성의 할당 유형 및 실행을 지정합니다. 가능한 값은 Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect 및 ApplyAndMonitor입니다.

Name	형식	Description
ApplyAndAutoCorrect	string
ApplyAndMonitor	string
Audit	string
DeployAndAutoCorrect	string

complianceStatus

할당된 게스트 구성에 대한 컴퓨터의 준수 상태를 나타내는 값입니다.

Name	형식	Description
Compliant	string
NonCompliant	string
Pending	string

ConfigurationInfo

구성에 대한 정보입니다.

Name	형식	Description
name	string	구성의 이름입니다.
version	string	구성의 버전입니다.

configurationMode

LCM(로컬 구성 관리자)이 실제로 대상 노드에 구성을 적용하는 방법을 지정합니다. 가능한 값은 ApplyOnly, ApplyAndMonitor 및 ApplyAndAutoCorrect입니다.

Name	형식	Description
ApplyAndAutoCorrect	string
ApplyAndMonitor	string
ApplyOnly	string

ConfigurationParameter

구성 매개 변수를 나타냅니다.

Name	형식	Description
name	string	구성 매개 변수의 이름입니다.
value	string	구성 매개 변수의 값입니다.

ConfigurationSetting

LCM(로컬 구성 관리자)의 구성 설정입니다.

Name	형식	Default value	Description
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

리소스를 만든 ID의 형식입니다.

Name	형식	Description
Application	string
Key	string
ManagedIdentity	string
User	string

Error

Name	형식	Description
code	string	오류 코드입니다.
message	string	작업이 실패한 이유를 나타내는 세부 오류 메시지입니다.

ErrorResponse

작업 실패의 오류 응답

Name	형식	Description
error	Error

GuestConfigurationAssignment

게스트 구성 할당은 컴퓨터와 게스트 구성 간의 연결입니다.

Name	형식	Description
id	string	게스트 구성 할당의 ARM 리소스 ID입니다.
location	string	VM이 있는 지역입니다.
name	string	게스트 구성 할당의 이름입니다.
properties	GuestConfigurationAssignmentProperties	게스트 구성 할당의 속성입니다.
systemData	systemData	createdBy 및 modifiedBy 정보가 포함된 Azure Resource Manager 메타데이터입니다.
type	string	리소스의 형식입니다.

GuestConfigurationAssignmentProperties

게스트 구성 할당 속성입니다.

Name	형식	Description
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 구성 및 해당 종속성을 캡슐화하는 아티팩트입니다. 아티팩트가 DSC 구성(MOF)과 종속 리소스 및 모듈과 같은 기타 종속성을 포함하는 zip 파일입니다.

Name	형식	Description
assignmentSource	string	구성의 원본을 지정합니다.
assignmentType	assignmentType	구성의 할당 유형 및 실행을 지정합니다. 가능한 값은 Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect 및 ApplyAndMonitor입니다.
configurationParameter	ConfigurationParameter[]	게스트 구성에 대한 구성 매개 변수입니다.
configurationProtectedParameter	ConfigurationParameter[]	게스트 구성에 대한 보호된 구성 매개 변수입니다.
configurationSetting	ConfigurationSetting	게스트 구성에 대한 구성 설정입니다.
contentHash	string	게스트 구성 패키지 및 구성 매개 변수의 결합된 해시입니다.
contentManagedIdentity	string	게스트 구성 패키지 및 구성 매개 변수의 스토리지 액세스 권한이 있는 관리 ID입니다.
contentType	string	구성의 콘텐츠 형식을 지정합니다. 가능한 값은 Builtin 또는 Custom일 수 있습니다.
contentUri	string	게스트 구성 패키지가 업로드되는 스토리지의 URI입니다.
kind	kind	게스트 구성의 종류입니다. 예: DSC
name	string	게스트 구성의 이름입니다.
version	string	게스트 구성의 버전입니다.

kind

게스트 구성의 종류입니다. 예: DSC

Name	형식	Description
DSC	string

provisioningState

응답에만 표시되는 프로비전 상태입니다.

Name	형식	Description
Canceled	string
Created	string
Failed	string
Succeeded	string

systemData

리소스의 생성 및 마지막 수정과 관련된 메타데이터입니다.

Name	형식	Description
createdAt	string	리소스 만들기의 타임스탬프(UTC)입니다.
createdBy	string	리소스를 만든 ID입니다.
createdByType	createdByType	리소스를 만든 ID의 형식입니다.
lastModifiedAt	string	리소스 마지막 수정의 타임스탬프(UTC)
lastModifiedBy	string	리소스를 마지막으로 수정한 ID입니다.
lastModifiedByType	createdByType	리소스를 마지막으로 수정한 ID의 형식입니다.

type

보고서 유형, 일관성 또는 초기

Name	형식	Description
Consistency	string
Initial	string

VMInfo

VM에 대한 정보입니다.

Name	형식	Description
id	string	VM의 Azure 리소스 ID입니다.
uuid	string	VM의 UUID(범용 고유 식별자)입니다.

VMSSVMInfo

VMSS VM에 대한 정보

Name	형식	Description
complianceStatus	complianceStatus	할당된 게스트 구성에 대한 컴퓨터의 준수 상태를 나타내는 값입니다.
lastComplianceChecked	string	마지막 준수 상태를 확인한 날짜 및 시간입니다.
latestReportId	string	게스트 구성 할당에 대한 최신 보고서의 ID입니다.
vmId	string	VM의 UUID입니다.
vmResourceId	string	VM의 Azure 리소스 ID입니다.