Guest Configuration Assignments - Create Or Update

Referensi

Service:: Guest Configuration

API Version:: 2020-06-25

Membuat hubungan antara VM dan konfigurasi tamu

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

Parameter URI

Name	In	Required	Type	Description
guestConfigurationAssignmentName	path	True	string	Nama penugasan konfigurasi tamu.
resourceGroupName	path	True	string	Nama grup sumber daya. Regex pattern: `^[-\w\._]+$`
subscriptionId	path	True	string	ID langganan yang secara unik mengidentifikasi langganan Microsoft Azure. ID langganan membentuk bagian dari URI untuk setiap panggilan layanan.
vmName	path	True	string	Nama mesin virtual.
api-version	query	True	string	Versi Api Klien.

Isi Permintaan

Name	Type	Description
location	string	Wilayah tempat VM berada.
name	string	Nama penugasan konfigurasi tamu.
properties	GuestConfigurationAssignmentProperties	Properti penetapan konfigurasi Tamu.

Respons

Name	Type	Description
200 OK	GuestConfigurationAssignment	OK. Penetapan konfigurasi tamu untuk VM berhasil diperbarui.
201 Created	GuestConfigurationAssignment	Dibuat. Penetapan konfigurasi tamu untuk VM berhasil dibuat.
Other Status Codes	ErrorResponse	Respons kesalahan yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Azure Active Directory Flow OAuth2

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	meniru akun pengguna Anda

Contoh

Create or update guest configuration assignment

PUT https://management.azure.com/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myVMName/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/WhitelistedApplication?api-version=2020-06-25

{
  "location": "westcentralus",
  "name": "WhitelistedApplication",
  "properties": {
    "context": "Azure policy",
    "guestConfiguration": {
      "name": "WhitelistedApplication",
      "version": "1.*",
      "contentUri": "https://thisisfake/pacakge",
      "contentHash": "123contenthash",
      "assignmentType": "ApplyAndAutoCorrect",
      "configurationParameter": [
        {
          "name": "[InstalledApplication]bwhitelistedapp;Name",
          "value": "NotePad,sql"
        }
      ]
    }
  }
}

package armguestconfiguration_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/guestconfiguration/armguestconfiguration"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2020-06-25/examples/createOrUpdateGuestConfigurationAssignment.json
func ExampleAssignmentsClient_CreateOrUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armguestconfiguration.NewAssignmentsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	res, err := client.CreateOrUpdate(ctx,
		"<guest-configuration-assignment-name>",
		"<resource-group-name>",
		"<vm-name>",
		armguestconfiguration.Assignment{
			Name:     to.Ptr("<name>"),
			Location: to.Ptr("<location>"),
			Properties: &armguestconfiguration.AssignmentProperties{
				Context: to.Ptr("<context>"),
				GuestConfiguration: &armguestconfiguration.Navigation{
					Name:           to.Ptr("<name>"),
					AssignmentType: to.Ptr(armguestconfiguration.AssignmentTypeApplyAndAutoCorrect),
					ConfigurationParameter: []*armguestconfiguration.ConfigurationParameter{
						{
							Name:  to.Ptr("<name>"),
							Value: to.Ptr("<value>"),
						}},
					ContentHash: to.Ptr("<content-hash>"),
					ContentURI:  to.Ptr("<content-uri>"),
					Version:     to.Ptr("<version>"),
				},
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

Sample Response

Status code:: 201

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

Status code:: 200

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

Definisi

actionAfterReboot	Menentukan apa yang terjadi setelah reboot selama penerapan konfigurasi. Nilai yang mungkin adalah ContinueConfiguration dan StopConfiguration
AssignmentInfo	Informasi tentang penetapan konfigurasi tamu.
AssignmentReport
AssignmentReportResource	Sumber daya penugasan konfigurasi tamu.
AssignmentReportResourceComplianceReason	Alasan dan kode untuk kepatuhan sumber daya penugasan konfigurasi tamu.
assignmentType	Menentukan jenis penugasan dan eksekusi konfigurasi. Nilai yang mungkin adalah Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect, dan ApplyAndMonitor.
complianceStatus	Nilai yang menunjukkan status kepatuhan komputer untuk konfigurasi tamu yang ditetapkan.
ConfigurationInfo	Informasi tentang konfigurasi.
configurationMode	Menentukan bagaimana LCM(Local Configuration Manager) benar-benar menerapkan konfigurasi ke simpul target. Nilai yang mungkin berlaku adalah ApplyOnly, ApplyAndMonitor, dan ApplyAndAutoCorrect.
ConfigurationParameter	Mewakili parameter konfigurasi.
ConfigurationSetting	Pengaturan konfigurasi LCM (Configuration Manager Lokal).
Error
ErrorResponse	Respons kesalahan kegagalan operasi
GuestConfigurationAssignment	Penugasan konfigurasi tamu adalah hubungan antara mesin dan konfigurasi tamu.
GuestConfigurationAssignmentProperties	Properti penetapan konfigurasi tamu.
GuestConfigurationNavigation	Konfigurasi tamu adalah artefak yang merangkum konfigurasi DSC dan dependensinya. Artefak adalah file zip yang berisi konfigurasi DSC (sebagai MOF) dan sumber daya dependen dan dependensi lainnya seperti modul.
kind	Jenis konfigurasi tamu. Misalnya:DSC
provisioningState	Status provisi, yang hanya muncul dalam respons.
type	Jenis laporan, Konsistensi, atau Awal
VMInfo	Informasi tentang VM.
VMSSVMInfo	Informasi tentang VMSS VM

actionAfterReboot

Menentukan apa yang terjadi setelah reboot selama penerapan konfigurasi. Nilai yang mungkin adalah ContinueConfiguration dan StopConfiguration

Name	Type	Description
ContinueConfiguration	string
StopConfiguration	string

AssignmentInfo

Informasi tentang penetapan konfigurasi tamu.

Name	Type	Description
configuration	ConfigurationInfo	Informasi tentang konfigurasi.
name	string	Nama penugasan konfigurasi tamu.

AssignmentReport

Name	Type	Description
assignment	AssignmentInfo	Detail konfigurasi penetapan konfigurasi tamu.
complianceStatus	complianceStatus	Nilai yang menunjukkan status kepatuhan komputer untuk konfigurasi tamu yang ditetapkan.
endTime	string	Tanggal akhir dan waktu pemeriksaan status kepatuhan penetapan konfigurasi tamu.
id	string	Id sumber daya ARM dari laporan untuk penetapan konfigurasi tamu.
operationType	type	Jenis laporan, Konsistensi, atau Awal
reportId	string	GUID yang mengidentifikasi laporan penetapan konfigurasi tamu di bawah langganan, grup sumber daya.
resources	AssignmentReportResource[]	Daftar sumber daya yang kepatuhan penetapan konfigurasi tamunya diperiksa.
startTime	string	Tanggal mulai dan waktu pemeriksaan status kepatuhan penetapan konfigurasi tamu.
vm	VMInfo	Informasi tentang VM.

AssignmentReportResource

Sumber daya penugasan konfigurasi tamu.

Name	Type	Description
complianceStatus	complianceStatus	Nilai yang menunjukkan status kepatuhan komputer untuk konfigurasi tamu yang ditetapkan.
properties	object	Properti sumber daya penugasan konfigurasi tamu.
reasons	AssignmentReportResourceComplianceReason[]	Alasan kepatuhan dan kode alasan untuk sumber daya.
resourceId	string	Nama pengaturan sumber daya penugasan konfigurasi tamu.

AssignmentReportResourceComplianceReason

Alasan dan kode untuk kepatuhan sumber daya penugasan konfigurasi tamu.

Name	Type	Description
code	string	Kode untuk kepatuhan sumber daya penetapan konfigurasi tamu.
phrase	string	Alasan kepatuhan sumber daya penetapan konfigurasi tamu.

assignmentType

Menentukan jenis penugasan dan eksekusi konfigurasi. Nilai yang mungkin adalah Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect, dan ApplyAndMonitor.

Name	Type	Description
ApplyAndAutoCorrect	string
ApplyAndMonitor	string
Audit	string
DeployAndAutoCorrect	string

complianceStatus

Nilai yang menunjukkan status kepatuhan komputer untuk konfigurasi tamu yang ditetapkan.

Name	Type	Description
Compliant	string
NonCompliant	string
Pending	string

ConfigurationInfo

Informasi tentang konfigurasi.

Name	Type	Description
name	string	Nama konfigurasi.
version	string	Versi konfigurasi.

configurationMode

Menentukan bagaimana LCM(Local Configuration Manager) benar-benar menerapkan konfigurasi ke simpul target. Nilai yang mungkin berlaku adalah ApplyOnly, ApplyAndMonitor, dan ApplyAndAutoCorrect.

Name	Type	Description
ApplyAndAutoCorrect	string
ApplyAndMonitor	string
ApplyOnly	string

ConfigurationParameter

Mewakili parameter konfigurasi.

Name	Type	Description
name	string	Nama parameter konfigurasi.
value	string	Nilai parameter konfigurasi.

ConfigurationSetting

Pengaturan konfigurasi LCM (Configuration Manager Lokal).

Name	Type	Default Value	Description
actionAfterReboot	actionAfterReboot		Menentukan apa yang terjadi setelah reboot selama penerapan konfigurasi. Nilai yang mungkin adalah ContinueConfiguration dan StopConfiguration
allowModuleOverwrite	boolean		Jika true - konfigurasi baru yang diunduh dari layanan penarikan diizinkan untuk menimpa yang lama pada simpul target. Jika tidak, false
configurationMode	configurationMode		Menentukan bagaimana LCM(Local Configuration Manager) benar-benar menerapkan konfigurasi ke simpul target. Nilai yang mungkin berlaku adalah ApplyOnly, ApplyAndMonitor, dan ApplyAndAutoCorrect.
configurationModeFrequencyMins	number	15	Seberapa sering, dalam hitungan menit, konfigurasi saat ini diperiksa dan diterapkan. Properti ini diabaikan jika properti ConfigurationMode diatur ke ApplyOnly. Nilai default-nya adalah 15.
rebootIfNeeded	boolean		Atur ini ke true untuk me-reboot simpul secara otomatis setelah konfigurasi yang memerlukan reboot diterapkan. Jika tidak, Anda harus me-reboot simpul secara manual untuk konfigurasi apa pun yang memerlukannya. Nilai defaultnya adalah false. Untuk menggunakan pengaturan ini ketika kondisi reboot diberlakukan oleh sesuatu selain DSC (seperti Windows Installer), gabungkan pengaturan ini dengan modul xPendingReboot.
refreshFrequencyMins	number	30	Interval waktu, dalam hitungan menit, di mana LCM memeriksa layanan penarikan untuk mendapatkan konfigurasi yang diperbarui. Nilai ini diabaikan jika LCM tidak dikonfigurasi dalam mode penarikan. Nilai default adalah 30.

Error

Name	Type	Description
code	string	Kode Kesalahan.
message	string	Pesan kesalahan detail yang menunjukkan mengapa operasi gagal.

ErrorResponse

Respons kesalahan kegagalan operasi

Name	Type	Description
error	Error

GuestConfigurationAssignment

Penugasan konfigurasi tamu adalah hubungan antara mesin dan konfigurasi tamu.

Name	Type	Description
id	string	ID sumber daya ARM dari penetapan konfigurasi tamu.
location	string	Wilayah tempat VM berada.
name	string	Nama penugasan konfigurasi tamu.
properties	GuestConfigurationAssignmentProperties	Properti penetapan konfigurasi Tamu.
type	string	Jenis sumber daya.

GuestConfigurationAssignmentProperties

Properti penetapan konfigurasi tamu.

Name	Type	Description
assignmentHash	string	Hash gabungan dari paket konfigurasi dan parameter.
complianceStatus	complianceStatus	Nilai yang menunjukkan status kepatuhan komputer untuk konfigurasi tamu yang ditetapkan.
context	string	Sumber yang memulai penetapan konfigurasi tamu. Misalnya: Azure Policy
guestConfiguration	GuestConfigurationNavigation	Konfigurasi tamu yang akan ditetapkan.
lastComplianceStatusChecked	string	Tanggal dan waktu ketika status kepatuhan terakhir diperiksa.
latestAssignmentReport	AssignmentReport	Laporan penugasan konfigurasi tamu terakhir yang dilaporkan.
latestReportId	string	Id laporan terbaru untuk penetapan konfigurasi tamu.
parameterHash	string	hash parameter untuk penetapan konfigurasi tamu.
provisioningState	provisioningState	Status provisi, yang hanya muncul dalam respons.
resourceType	string	Jenis sumber daya - VMSS / VM
targetResourceId	string	Id sumber daya VM.
vmssVMList	VMSSVMInfo[]	Daftar data Kepatuhan VM untuk VMSS

GuestConfigurationNavigation

Konfigurasi tamu adalah artefak yang merangkum konfigurasi DSC dan dependensinya. Artefak adalah file zip yang berisi konfigurasi DSC (sebagai MOF) dan sumber daya dependen dan dependensi lainnya seperti modul.

Name	Type	Description
assignmentType	assignmentType	Menentukan jenis penugasan dan eksekusi konfigurasi. Nilai yang mungkin adalah Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect, dan ApplyAndMonitor.
configurationParameter	ConfigurationParameter[]	Parameter konfigurasi untuk konfigurasi tamu.
configurationProtectedParameter	ConfigurationParameter[]	Parameter konfigurasi yang dilindungi untuk konfigurasi tamu.
configurationSetting	ConfigurationSetting	Pengaturan konfigurasi untuk konfigurasi tamu.
contentHash	string	Hash gabungan dari paket konfigurasi tamu dan parameter konfigurasi.
contentType	string	Menentukan tipe isi konfigurasi. Nilai yang mungkin dapat berupa Bawaan atau Kustom.
contentUri	string	Uri penyimpanan tempat paket konfigurasi tamu diunggah.
kind	kind	Jenis konfigurasi tamu. Misalnya:DSC
name	string	Nama konfigurasi tamu.
version	string	Versi konfigurasi tamu.

kind

Jenis konfigurasi tamu. Misalnya:DSC

Name	Type	Description
DSC	string

provisioningState

Status provisi, yang hanya muncul dalam respons.

Name	Type	Description
Canceled	string
Created	string
Failed	string
Succeeded	string

type

Jenis laporan, Konsistensi, atau Awal

Name	Type	Description
Consistency	string
Initial	string

VMInfo

Informasi tentang VM.

Name	Type	Description
id	string	Id sumber daya Azure VM.
uuid	string	UUID(Pengidentifikasi Unik Universal) VM.

VMSSVMInfo

Informasi tentang VMSS VM

Name	Type	Description
complianceStatus	complianceStatus	Nilai yang menunjukkan status kepatuhan komputer untuk konfigurasi tamu yang ditetapkan.
lastComplianceChecked	string	Tanggal dan waktu ketika status kepatuhan terakhir diperiksa.
latestReportId	string	Id laporan terbaru untuk penetapan konfigurasi tamu.
vmId	string	UUID of the VM.
vmResourceId	string	Id sumber daya Azure VM.