Guest Configuration Assignments - RG List

Referencia

Szolgáltatás:: Guest Configuration

API-verzió:: 2024-04-05

Egy erőforráscsoport összes vendégkonfigurációs hozzárendelésének listázása.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
resourceGroupName	path	True	string pattern: ^[-\w\._]+$	Az erőforráscsoport neve.
subscriptionId	path	True	string	Előfizetés azonosítója, amely egyedileg azonosítja a Microsoft Azure-előfizetést. Az előfizetés azonosítója minden szolgáltatáshíváshoz az URI részét képezi.
api-version	query	True	string	Ügyfél API-verziója.

Válaszok

Name	Típus	Description
200 OK	GuestConfigurationAssignmentList	OKÉ
204 No Content		Nincs tartalom
Other Status Codes	ErrorResponse	Hibaválasz, amely leírja, hogy miért nem sikerült a művelet.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	a felhasználói fiók megszemélyesítése

Példák

List all guest configuration assignments for a resource group

Mintakérelem

HTTP

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

Mintaválasz

Állapotkód:: 200

[
  {
    "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
    }
  }
]

Állapotkód:: 204

Definíciók

Name	Description
actionAfterReboot	Megadja, hogy mi történik egy konfiguráció alkalmazása során végzett újraindítás után. A lehetséges értékek a ContinueConfiguration és a StopConfiguration
AssignmentInfo	A vendégkonfiguráció-hozzárendeléssel kapcsolatos információk.
AssignmentReport
AssignmentReportResource	A vendégkonfiguráció-hozzárendelés erőforrása.
AssignmentReportResourceComplianceReason	A vendégkonfiguráció-hozzárendelési erőforrás megfelelőségének oka és kódja.
assignmentType	Megadja a konfiguráció hozzárendelési típusát és végrehajtását. Lehetséges értékek a naplózás, az DeployAndAutoCorrect, az ApplyAndAutoCorrect és az ApplyAndMonitor.
complianceStatus	A gép megfelelőségi állapotát jelző érték a hozzárendelt vendégkonfigurációhoz.
ConfigurationInfo	A konfigurációval kapcsolatos információk.
configurationMode	Meghatározza, hogy az LCM (Local Configuration Manager) hogyan alkalmazza a konfigurációt a célcsomópontokra. Lehetséges értékek: ApplyOnly, ApplyAndMonitor és ApplyAndAutoCorrect.
ConfigurationParameter	Egy konfigurációs paramétert jelöl.
ConfigurationSetting	Az LCM (Local Configuration Manager) konfigurációs beállítása.
createdByType	Az erőforrást létrehozó identitás típusa.
Error
ErrorResponse	Művelethiba hibaválasza
GuestConfigurationAssignment	A vendégkonfiguráció-hozzárendelés a gép és a vendégkonfiguráció közötti társítás.
GuestConfigurationAssignmentList	A lista vendégkonfiguráció-hozzárendelési műveletének válasza.
GuestConfigurationAssignmentProperties	Vendégkonfiguráció-hozzárendelés tulajdonságai.
GuestConfigurationNavigation	A vendégkonfiguráció olyan összetevő, amely magában foglalja a DSC-konfigurációt és annak függőségeit. Az összetevő egy zip-fájl, amely DSC-konfigurációt (MOF-ként) és függő erőforrásokat és más függőségeket, például modulokat tartalmaz.
kind	A vendégkonfiguráció típusa. Például:DSC
provisioningState	A kiépítési állapot, amely csak a válaszban jelenik meg.
systemData	Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.
type	Jelentés típusa, konzisztencia vagy kezdeti
VMInfo	Információ a virtuális gépről.
VMSSVMInfo	Információk a VMSS virtuális gépről

actionAfterReboot

Enumerálás

Megadja, hogy mi történik egy konfiguráció alkalmazása során végzett újraindítás után. A lehetséges értékek a ContinueConfiguration és a StopConfiguration

Érték	Description
ContinueConfiguration
StopConfiguration

AssignmentInfo

Objektum

A vendégkonfiguráció-hozzárendeléssel kapcsolatos információk.

Name	Típus	Description
configuration	ConfigurationInfo	A konfigurációval kapcsolatos információk.
name	string	A vendégkonfiguráció-hozzárendelés neve.

AssignmentReport

Objektum

Name	Típus	Description
assignment	AssignmentInfo	A vendégkonfiguráció-hozzárendelés konfigurációs részletei.
complianceStatus	complianceStatus	A gép megfelelőségi állapotát jelző érték a hozzárendelt vendégkonfigurációhoz.
endTime	string (date-time)	A vendégkonfiguráció-hozzárendelés megfelelőségi állapotának ellenőrzésének záró dátuma és időpontja.
id	string	A vendégkonfiguráció-hozzárendelés jelentésének ARM-erőforrás-azonosítója.
operationType	type	Jelentés típusa, konzisztencia vagy kezdeti
reportId	string	GUID, amely azonosítja a vendégkonfiguráció-hozzárendelési jelentést egy előfizetés, erőforráscsoport alatt.
resources	AssignmentReportResource[]	Azon erőforrások listája, amelyek esetében a vendégkonfiguráció-hozzárendelés megfelelőségét ellenőrzi a rendszer.
startTime	string (date-time)	A vendégkonfiguráció-hozzárendelés megfelelőségi állapotának ellenőrzésének kezdő dátuma és időpontja.
vm	VMInfo	Információ a virtuális gépről.

AssignmentReportResource

Objektum

A vendégkonfiguráció-hozzárendelés erőforrása.

Name	Típus	Description
complianceStatus	complianceStatus	A gép megfelelőségi állapotát jelző érték a hozzárendelt vendégkonfigurációhoz.
properties	object	Vendégkonfiguráció-hozzárendelési erőforrás tulajdonságai.
reasons	AssignmentReportResourceComplianceReason[]	Egy erőforrás megfelelőségi oka és okkódja.
resourceId	string	A vendégkonfiguráció-hozzárendelés erőforrás-beállításának neve.

AssignmentReportResourceComplianceReason

Objektum

A vendégkonfiguráció-hozzárendelési erőforrás megfelelőségének oka és kódja.

Name	Típus	Description
code	string	A vendégkonfiguráció-hozzárendelési erőforrás megfelelőségének kódja.
phrase	string	A vendégkonfiguráció-hozzárendelési erőforrás megfelelőségének oka.

assignmentType

Enumerálás

Megadja a konfiguráció hozzárendelési típusát és végrehajtását. Lehetséges értékek a naplózás, az DeployAndAutoCorrect, az ApplyAndAutoCorrect és az ApplyAndMonitor.

Érték	Description
ApplyAndAutoCorrect
ApplyAndMonitor
Audit
DeployAndAutoCorrect

complianceStatus

Enumerálás

A gép megfelelőségi állapotát jelző érték a hozzárendelt vendégkonfigurációhoz.

Érték	Description
Compliant
NonCompliant
Pending

ConfigurationInfo

Objektum

A konfigurációval kapcsolatos információk.

Name	Típus	Description
name	string	A konfiguráció neve.
version	string	A konfiguráció verziója.

configurationMode

Enumerálás

Meghatározza, hogy az LCM (Local Configuration Manager) hogyan alkalmazza a konfigurációt a célcsomópontokra. Lehetséges értékek: ApplyOnly, ApplyAndMonitor és ApplyAndAutoCorrect.

Érték	Description
ApplyAndAutoCorrect
ApplyAndMonitor
ApplyOnly

ConfigurationParameter

Objektum

Egy konfigurációs paramétert jelöl.

Name	Típus	Description
name	string	A konfigurációs paraméter neve.
value	string	A konfigurációs paraméter értéke.

ConfigurationSetting

Objektum

Az LCM (Local Configuration Manager) konfigurációs beállítása.

Name	Típus	Alapértelmezett érték	Description
actionAfterReboot	actionAfterReboot		Megadja, hogy mi történik egy konfiguráció alkalmazása során végzett újraindítás után. A lehetséges értékek a ContinueConfiguration és a StopConfiguration
allowModuleOverwrite	boolean		Ha igaz , a lekérési szolgáltatásból letöltött új konfigurációk felülírhatják a régieket a célcsomóponton. Ellenkező esetben hamis
configurationMode	configurationMode		Meghatározza, hogy az LCM (Local Configuration Manager) hogyan alkalmazza a konfigurációt a célcsomópontokra. Lehetséges értékek: ApplyOnly, ApplyAndMonitor és ApplyAndAutoCorrect.
configurationModeFrequencyMins	number	15	A rendszer percek alatt ellenőrzi és alkalmazza az aktuális konfigurációt. Ez a tulajdonság figyelmen kívül lesz hagyva, ha a ConfigurationMode tulajdonság ApplyOnly értékre van állítva. Az alapértelmezett érték 15.
rebootIfNeeded	boolean		Állítsa ezt igaz értékre, hogy automatikusan újraindítsa a csomópontot egy újraindítást igénylő konfiguráció alkalmazása után. Ellenkező esetben manuálisan kell újraindítania a csomópontot minden olyan konfigurációhoz, amelyhez szükség van rá. Az alapértelmezett érték hamis. Ha ezt a beállítást a DSC-n (például a Windows Installeren) kívül más rendszer is életbe lépteti, használja ezt a beállítást az xPendingReboot modullal.
refreshFrequencyMins	number	30	Az az időintervallum percekben, amikor az LCM ellenőrzi a lekéréses szolgáltatást a frissített konfigurációk lekéréséhez. Ez az érték figyelmen kívül lesz hagyva, ha az LCM nincs lekéréses módban konfigurálva. Az alapértelmezett érték 30.

createdByType

Enumerálás

Az erőforrást létrehozó identitás típusa.

Érték	Description
Application
Key
ManagedIdentity
User

Error

Objektum

Name	Típus	Description
code	string	Hibakód.
message	string	Részletes hibaüzenet, amely jelzi, hogy a művelet miért nem sikerült.

ErrorResponse

Objektum

Művelethiba hibaválasza

Name	Típus	Description
error	Error

GuestConfigurationAssignment

Objektum

A vendégkonfiguráció-hozzárendelés a gép és a vendégkonfiguráció közötti társítás.

Name	Típus	Description
id	string	A vendégkonfiguráció-hozzárendelés ARM-erőforrás-azonosítója.
location	string	Régió, ahol a virtuális gép található.
name	string	A vendégkonfiguráció-hozzárendelés neve.
properties	GuestConfigurationAssignmentProperties	A vendégkonfiguráció-hozzárendelés tulajdonságai.
systemData	systemData	A createdBy és a modifiedBy adatokat tartalmazó Azure Resource Manager-metaadatok.
type	string	Az erőforrás típusa.

GuestConfigurationAssignmentList

Objektum

A lista vendégkonfiguráció-hozzárendelési műveletének válasza.

Name	Típus	Description
value	GuestConfigurationAssignment[]	A lista vendégkonfiguráció-hozzárendelési műveletének eredménye.

GuestConfigurationAssignmentProperties

Objektum

Vendégkonfiguráció-hozzárendelés tulajdonságai.

Name	Típus	Description
assignmentHash	string	A konfigurációs csomag és a paraméterek kombinált kivonata.
complianceStatus	complianceStatus	A gép megfelelőségi állapotát jelző érték a hozzárendelt vendégkonfigurációhoz.
context	string	A vendégkonfiguráció-hozzárendelést kezdeményező forrás. Például: Azure Policy
guestConfiguration	GuestConfigurationNavigation	A hozzárendelni kívánt vendégkonfiguráció.
lastComplianceStatusChecked	string (date-time)	A legutóbbi megfelelőségi állapot ellenőrzésének dátuma és időpontja.
latestAssignmentReport	AssignmentReport	Legutóbb jelentett vendégkonfiguráció-hozzárendelési jelentés.
latestReportId	string	A vendégkonfiguráció-hozzárendelés legújabb jelentésének azonosítója.
parameterHash	string	paraméterkivonat a vendégkonfiguráció-hozzárendeléshez.
provisioningState	provisioningState	A kiépítési állapot, amely csak a válaszban jelenik meg.
resourceType	string	Az erőforrás típusa – VMSS/virtuális gép
targetResourceId	string	Virtuálisgép-erőforrás azonosítója.
vmssVMList	VMSSVMInfo[]	A VMSS virtuálisgép-megfelelőségi adatainak listája

GuestConfigurationNavigation

Objektum

A vendégkonfiguráció olyan összetevő, amely magában foglalja a DSC-konfigurációt és annak függőségeit. Az összetevő egy zip-fájl, amely DSC-konfigurációt (MOF-ként) és függő erőforrásokat és más függőségeket, például modulokat tartalmaz.

Name	Típus	Description
assignmentSource	string	Megadja a konfiguráció eredetét.
assignmentType	assignmentType	Megadja a konfiguráció hozzárendelési típusát és végrehajtását. Lehetséges értékek a naplózás, az DeployAndAutoCorrect, az ApplyAndAutoCorrect és az ApplyAndMonitor.
configurationParameter	ConfigurationParameter[]	A vendégkonfiguráció konfigurációs paraméterei.
configurationProtectedParameter	ConfigurationParameter[]	A vendégkonfiguráció védett konfigurációs paraméterei.
configurationSetting	ConfigurationSetting	A vendégkonfiguráció konfigurációs beállítása.
contentHash	string	A vendégkonfigurációs csomag és a konfigurációs paraméterek kombinált kivonata.
contentManagedIdentity	string	Felügyelt identitás a vendégkonfigurációs csomag és a konfigurációs paraméterek tárolási hozzáférésével.
contentType	string	Megadja a konfiguráció tartalomtípusát. A lehetséges értékek lehetnek beépítettek vagy egyéniek.
contentUri	string	Annak a tárolónak az URI-ja, amelyben a vendégkonfigurációs csomag fel van töltve.
kind	kind	A vendégkonfiguráció típusa. Például:DSC
name	string	A vendégkonfiguráció neve.
version	string	A vendégkonfiguráció verziója.

kind

Enumerálás

A vendégkonfiguráció típusa. Például:DSC

Érték	Description
DSC

provisioningState

Enumerálás

A kiépítési állapot, amely csak a válaszban jelenik meg.

Érték	Description
Canceled
Created
Failed
Succeeded

systemData

Objektum

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

Name	Típus	Description
createdAt	string (date-time)	Az erőforrás-létrehozás időbélyege (UTC).
createdBy	string	Az erőforrást létrehozó identitás.
createdByType	createdByType	Az erőforrást létrehozó identitás típusa.
lastModifiedAt	string (date-time)	Az erőforrás utolsó módosításának időbélyege (UTC)
lastModifiedBy	string	Az erőforrást legutóbb módosító identitás.
lastModifiedByType	createdByType	Az erőforrást legutóbb módosító identitás típusa.

type

Enumerálás

Jelentés típusa, konzisztencia vagy kezdeti

Érték	Description
Consistency
Initial

VMInfo

Objektum

Információ a virtuális gépről.

Name	Típus	Description
id	string	A virtuális gép Azure-erőforrás-azonosítója.
uuid	string	A virtuális gép UUID-azonosítója (univerzálisan egyedi azonosító).

VMSSVMInfo

Objektum

Információk a VMSS virtuális gépről

Name	Típus	Description
complianceStatus	complianceStatus	A gép megfelelőségi állapotát jelző érték a hozzárendelt vendégkonfigurációhoz.
lastComplianceChecked	string (date-time)	A legutóbbi megfelelőségi állapot ellenőrzésének dátuma és időpontja.
latestReportId	string	A vendégkonfiguráció-hozzárendelés legújabb jelentésének azonosítója.
vmId	string	A virtuális gép UUID azonosítója.
vmResourceId	string	A virtuális gép Azure-erőforrás-azonosítója.

Megosztás a következőn keresztül:

Guest Configuration Assignments - RG List

URI-paraméterek

Válaszok

Biztonság

azure_auth

Hatókörök

Példák

List all guest configuration assignments for a resource group

Mintakérelem

Mintaválasz

Definíciók

actionAfterReboot

AssignmentInfo

AssignmentReport

AssignmentReportResource

AssignmentReportResourceComplianceReason

assignmentType

complianceStatus

ConfigurationInfo

configurationMode

ConfigurationParameter

ConfigurationSetting

createdByType

Error

ErrorResponse

GuestConfigurationAssignment

GuestConfigurationAssignmentList

GuestConfigurationAssignmentProperties

GuestConfigurationNavigation

kind

provisioningState

systemData

type

VMInfo

VMSSVMInfo