Guest Configuration Assignments - Get

Layanan:: Guest Configuration

Versi API:: 2024-04-05

Mendapatkan informasi tentang penetapan konfigurasi tamu

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
guestConfigurationAssignmentName	path	True	string	Nama penetapan konfigurasi tamu.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nama grup sumber daya. Nama tidak sensitif terhadap penggunaan huruf besar atau kecil.
subscriptionId	path	True	string minLength: 1	ID langganan target.
vmName	path	True	string pattern: ^[a-zA-Z0-9][-a-zA-Z0-9_.]*[a-zA-Z0-9]$	Nama komputer virtual.
api-version	query	True	string minLength: 1	Versi API yang digunakan untuk operasi ini.

Respons

Nama	Jenis	Deskripsi
200 OK	GuestConfigurationAssignment	Operasi Azure berhasil diselesaikan.
Other Status Codes	ErrorResponse	Respons kesalahan tak terduga.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory.

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

Get a guest configuration assignment

Permintaan sampel

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

Respon sampel

Kode status:: 200

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

Definisi

Nama	Deskripsi
ActionAfterReboot	Menentukan apa yang terjadi setelah boot ulang selama aplikasi konfigurasi. Nilai yang mungkin adalah ContinueConfiguration dan StopConfiguration
AssignmentInfo	Informasi tentang penetapan konfigurasi tamu.
AssignmentReport
AssignmentReportResource	Sumber daya penetapan konfigurasi tamu.
AssignmentReportResourceComplianceReason	Alasan dan kode untuk kepatuhan sumber daya penetapan 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 adalah ApplyOnly, ApplyAndMonitor, dan ApplyAndAutoCorrect.
ConfigurationParameter	Mewakili parameter konfigurasi.
ConfigurationSetting	Pengaturan konfigurasi LCM (Local Configuration Manager).
createdByType	Jenis identitas yang membuat sumber daya.
Error
ErrorResponse	Respons kesalahan kegagalan operasi.
GuestConfigurationAssignment	Penetapan konfigurasi tamu adalah asosiasi 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.
systemData	Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.
Type	Jenis laporan, Konsistensi, atau Awal
VMInfo	Informasi tentang VM.
VMSSVMInfo	Informasi tentang VMSS VM

ActionAfterReboot

Enumeration

Menentukan apa yang terjadi setelah boot ulang selama aplikasi konfigurasi. Nilai yang mungkin adalah ContinueConfiguration dan StopConfiguration

Nilai	Deskripsi
ContinueConfiguration
StopConfiguration

AssignmentInfo

Objek

Informasi tentang penetapan konfigurasi tamu.

Nama	Jenis	Deskripsi
configuration	ConfigurationInfo	Informasi tentang konfigurasi.
name	string	Nama penetapan konfigurasi tamu.

AssignmentReport

Objek

Nama	Jenis	Deskripsi
assignment	AssignmentInfo	Detail konfigurasi penetapan konfigurasi tamu.
complianceStatus	ComplianceStatus	Nilai yang menunjukkan status kepatuhan komputer untuk konfigurasi tamu yang ditetapkan.
endTime	string (date-time)	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 tempat kepatuhan penetapan konfigurasi tamu diperiksa.
startTime	string (date-time)	Tanggal mulai dan waktu pemeriksaan status kepatuhan penetapan konfigurasi tamu.
vm	VMInfo	Informasi tentang VM.

AssignmentReportResource

Objek

Sumber daya penetapan konfigurasi tamu.

Nama	Jenis	Deskripsi
complianceStatus	ComplianceStatus	Nilai yang menunjukkan status kepatuhan komputer untuk konfigurasi tamu yang ditetapkan.
properties		Properti sumber daya penetapan konfigurasi tamu.
reasons	AssignmentReportResourceComplianceReason[]	Alasan kepatuhan dan kode alasan untuk sumber daya.
resourceId	string	Nama pengaturan sumber daya penetapan konfigurasi tamu.

AssignmentReportResourceComplianceReason

Objek

Alasan dan kode untuk kepatuhan sumber daya penetapan konfigurasi tamu.

Nama	Jenis	Deskripsi
code	string	Kode untuk kepatuhan sumber daya penetapan konfigurasi tamu.
phrase	string	Alasan kepatuhan sumber daya penetapan konfigurasi tamu.

AssignmentType

Enumeration

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

Nilai	Deskripsi
Audit
DeployAndAutoCorrect
ApplyAndAutoCorrect
ApplyAndMonitor

ComplianceStatus

Enumeration

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

Nilai	Deskripsi
Compliant
NonCompliant
Pending

ConfigurationInfo

Objek

Informasi tentang konfigurasi.

Nama	Jenis	Deskripsi
name	string	Nama konfigurasi.
version	string	Versi konfigurasi.

ConfigurationMode

Enumeration

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

Nilai	Deskripsi
ApplyOnly
ApplyAndMonitor
ApplyAndAutoCorrect

ConfigurationParameter

Objek

Mewakili parameter konfigurasi.

Nama	Jenis	Deskripsi
name	string	Nama parameter konfigurasi.
value	string	Nilai parameter konfigurasi.

ConfigurationSetting

Objek

Pengaturan konfigurasi LCM (Local Configuration Manager).

Nama	Jenis	Nilai default	Deskripsi
actionAfterReboot	ActionAfterReboot		Menentukan apa yang terjadi setelah boot ulang selama aplikasi 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 adalah ApplyOnly, ApplyAndMonitor, dan ApplyAndAutoCorrect.
configurationModeFrequencyMins	number (float)	15	Seberapa sering, dalam menit, konfigurasi saat ini diperiksa dan diterapkan. Properti ini diabaikan jika properti ConfigurationMode diatur ke ApplyOnly. Nilai defaultnya adalah 15.
rebootIfNeeded	boolean		Atur ini ke true untuk secara otomatis me-reboot simpul 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 (float)	30	Interval waktu, dalam menit, di mana LCM memeriksa layanan penarikan untuk mendapatkan konfigurasi yang diperbarui. Nilai ini diabaikan jika LCM tidak dikonfigurasi dalam mode penarikan. Nilai defaultnya adalah 30.

createdByType

Enumeration

Jenis identitas yang membuat sumber daya.

Nilai	Deskripsi
User
Application
ManagedIdentity
Key

Error

Objek

Nama	Jenis	Deskripsi
code	string	Kode kesalahan.
message	string	Pesan kesalahan detail yang menunjukkan mengapa operasi gagal.

ErrorResponse

Objek

Respons kesalahan kegagalan operasi.

Nama	Jenis	Deskripsi
error	Error