Bagikan melalui


Guest Configuration Assignments - Subscription List

Mencantumkan semua penugasan konfigurasi tamu untuk langganan.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments?api-version=2022-01-25

Parameter URI

Nama Dalam Diperlukan Jenis Deskripsi
subscriptionId
path True

string

ID langganan yang secara unik mengidentifikasi langganan Microsoft Azure. ID langganan membentuk bagian dari URI untuk setiap panggilan layanan.

api-version
query True

string

Versi Api Klien.

Respons

Nama Jenis Deskripsi
200 OK

GuestConfigurationAssignmentList

OK

204 No Content

Tidak ada Konten

Other Status Codes

ErrorResponse

Respons kesalahan yang menjelaskan mengapa operasi gagal.

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

List all guest configuration assignments for a subscription

Permintaan sampel

GET https://management.azure.com/subscriptions/mySubscriptionId/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments?api-version=2022-01-25

Respon sampel

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

Definisi

Nama Deskripsi
actionAfterReboot

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

AssignmentInfo

Informasi tentang penugasan 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).

createdByType

Jenis identitas yang membuat sumber daya.

Error
ErrorResponse

Respons kesalahan kegagalan operasi

GuestConfigurationAssignment

Penugasan konfigurasi tamu adalah hubungan antara mesin dan konfigurasi tamu.

GuestConfigurationAssignmentList

Respons operasi penetapan konfigurasi tamu daftar.

GuestConfigurationAssignmentProperties

Properti penugasan 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 penyediaan, 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

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

Nama Jenis Deskripsi
ContinueConfiguration

string

StopConfiguration

string

AssignmentInfo

Informasi tentang penugasan konfigurasi tamu.

Nama Jenis Deskripsi
configuration

ConfigurationInfo

Informasi tentang konfigurasi.

name

string

Nama penugasan konfigurasi tamu.

AssignmentReport

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

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

Tanggal mulai dan waktu pemeriksaan status kepatuhan penetapan konfigurasi tamu.

vm

VMInfo

Informasi tentang VM.

AssignmentReportResource

Sumber daya penugasan konfigurasi tamu.

Nama Jenis Deskripsi
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.

Nama Jenis Deskripsi
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.

Nama Jenis Deskripsi
ApplyAndAutoCorrect

string

ApplyAndMonitor

string

Audit

string

DeployAndAutoCorrect

string

complianceStatus

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

Nama Jenis Deskripsi
Compliant

string

NonCompliant

string

Pending

string

ConfigurationInfo

Informasi tentang konfigurasi.

Nama Jenis Deskripsi
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.

Nama Jenis Deskripsi
ApplyAndAutoCorrect

string

ApplyAndMonitor

string

ApplyOnly

string

ConfigurationParameter

Mewakili parameter konfigurasi.

Nama Jenis Deskripsi
name

string

Nama parameter konfigurasi.

value

string

Nilai parameter konfigurasi.

ConfigurationSetting

Pengaturan konfigurasi LCM (Configuration Manager Lokal).

Nama Jenis Nilai default Deskripsi
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, salah

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 secara otomatis me-reboot node 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 Pemasang Windows), 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.

createdByType

Jenis identitas yang membuat sumber daya.

Nama Jenis Deskripsi
Application

string

Key

string

ManagedIdentity

string

User

string

Error

Nama Jenis Deskripsi
code

string

Kode Kesalahan.

message

string

Pesan kesalahan detail yang menunjukkan mengapa operasi gagal.

ErrorResponse

Respons kesalahan kegagalan operasi

Nama Jenis Deskripsi
error

Error

GuestConfigurationAssignment

Penugasan konfigurasi tamu adalah hubungan antara mesin dan konfigurasi tamu.

Nama Jenis Deskripsi
id

string

ID sumber daya ARM dari penugasan konfigurasi tamu.

location

string

Wilayah tempat VM berada.

name

string

Nama penugasan konfigurasi tamu.

properties

GuestConfigurationAssignmentProperties

Properti penetapan konfigurasi Tamu.

systemData

systemData

Metadata Azure Resource Manager yang berisi informasi createdBy dan modifiedBy.

type

string

Jenis sumber daya.

GuestConfigurationAssignmentList

Respons operasi penetapan konfigurasi tamu daftar.

Nama Jenis Deskripsi
value

GuestConfigurationAssignment[]

Hasil operasi penetapan konfigurasi tamu daftar.

GuestConfigurationAssignmentProperties

Properti penugasan konfigurasi tamu.

Nama Jenis Deskripsi
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 penugasan konfigurasi tamu.

parameterHash

string

hash parameter untuk penetapan konfigurasi tamu.

provisioningState

provisioningState

Status penyediaan, 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.

Nama Jenis Deskripsi
assignmentSource

string

Menentukan asal konfigurasi.

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

Nama Jenis Deskripsi
DSC

string

provisioningState

Status penyediaan, yang hanya muncul dalam respons.

Nama Jenis Deskripsi
Canceled

string

Created

string

Failed

string

Succeeded

string

systemData

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

Nama Jenis Deskripsi
createdAt

string

Tanda waktu pembuatan sumber daya (UTC).

createdBy

string

Identitas yang membuat sumber daya.

createdByType

createdByType

Jenis identitas yang membuat sumber daya.

lastModifiedAt

string

Tanda waktu modifikasi terakhir sumber daya (UTC)

lastModifiedBy

string

Identitas yang terakhir memodifikasi sumber daya.

lastModifiedByType

createdByType

Jenis identitas yang terakhir mengubah sumber daya.

type

Jenis laporan, Konsistensi, atau Awal

Nama Jenis Deskripsi
Consistency

string

Initial

string

VMInfo

Informasi tentang VM.

Nama Jenis Deskripsi
id

string

Id sumber daya Azure dari VM.

uuid

string

UUID(Pengidentifikasi Unik Universal) VM.

VMSSVMInfo

Informasi tentang VMSS VM

Nama Jenis Deskripsi
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 penugasan konfigurasi tamu.

vmId

string

UUID of the VM.

vmResourceId

string

Id sumber daya Azure dari VM.