Guest Configuration Assignments - Subscription List

Odwołanie

Usługa:: Guest Configuration

Wersja interfejsu API:: 2024-04-05

Wyświetl listę wszystkich przypisań konfiguracji gościa dla subskrypcji.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
subscriptionId	path	True	string	Identyfikator subskrypcji, który jednoznacznie identyfikuje subskrypcję platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora URI dla każdego wywołania usługi.
api-version	query	True	string	Wersja interfejsu API klienta.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	GuestConfigurationAssignmentList	OK
204 No Content		Brak zawartości
Other Status Codes	ErrorResponse	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

List all guest configuration assignments for a subscription

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:: 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
    }
  }
]

Kod stanu:: 204

Definicje

Nazwa	Opis
actionAfterReboot	Określa, co się stanie po ponownym uruchomieniu podczas stosowania konfiguracji. Możliwe wartości to ContinueConfiguration i StopConfiguration
AssignmentInfo	Informacje o przypisaniu konfiguracji gościa.
AssignmentReport
AssignmentReportResource	Zasób przypisania konfiguracji gościa.
AssignmentReportResourceComplianceReason	Przyczyna i kod zgodności zasobu przypisania konfiguracji gościa.
assignmentType	Określa typ przypisania i wykonywanie konfiguracji. Możliwe wartości to Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect i ApplyAndMonitor.
complianceStatus	Wartość wskazująca stan zgodności maszyny dla przypisanej konfiguracji gościa.
ConfigurationInfo	Informacje o konfiguracji.
configurationMode	Określa, jak LCM(Local Configuration Manager) rzeczywiście stosuje konfigurację do węzłów docelowych. Możliwe wartości to ApplyOnly, ApplyAndMonitor i ApplyAndAutoCorrect.
ConfigurationParameter	Reprezentuje parametr konfiguracji.
ConfigurationSetting	Ustawienie konfiguracji LCM (Local Configuration Manager).
createdByType	Typ tożsamości, która utworzyła zasób.
Error
ErrorResponse	Odpowiedź na błąd operacji
GuestConfigurationAssignment	Przypisanie konfiguracji gościa jest skojarzeniem między maszyną a konfiguracją gościa.
GuestConfigurationAssignmentList	Odpowiedź operacji przypisywania konfiguracji gościa listy.
GuestConfigurationAssignmentProperties	Właściwości przypisania konfiguracji gościa.
GuestConfigurationNavigation	Konfiguracja gościa to artefakt, który hermetyzuje konfigurację DSC i jej zależności. Artefakt jest plikiem zip zawierającym konfigurację DSC (jako moF) i zasoby zależne oraz inne zależności, takie jak moduły.
kind	Rodzaj konfiguracji gościa. Na przykład:DSC
provisioningState	Stan aprowizacji, który pojawia się tylko w odpowiedzi.
systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.
type	Typ raportu, spójności lub początkowego
VMInfo	Informacje o maszynie wirtualnej.
VMSSVMInfo	Informacje o maszynie wirtualnej zestawu skalowania maszyn wirtualnych

actionAfterReboot

Określa, co się stanie po ponownym uruchomieniu podczas stosowania konfiguracji. Możliwe wartości to ContinueConfiguration i StopConfiguration

Nazwa	Typ	Opis
ContinueConfiguration	string
StopConfiguration	string

AssignmentInfo

Informacje o przypisaniu konfiguracji gościa.

Nazwa	Typ	Opis
configuration	ConfigurationInfo	Informacje o konfiguracji.
name	string	Nazwa przypisania konfiguracji gościa.

AssignmentReport

Nazwa	Typ	Opis
assignment	AssignmentInfo	Szczegóły konfiguracji przypisania konfiguracji gościa.
complianceStatus	complianceStatus	Wartość wskazująca stan zgodności maszyny dla przypisanej konfiguracji gościa.
endTime	string	Data i godzina zakończenia sprawdzania stanu zgodności przypisania konfiguracji gościa.
id	string	Identyfikator zasobu usługi ARM raportu dla przypisania konfiguracji gościa.
operationType	type	Typ raportu, spójności lub początkowego
reportId	string	Identyfikator GUID identyfikujący raport przypisania konfiguracji gościa w ramach subskrypcji, grupy zasobów.
resources	AssignmentReportResource[]	Lista zasobów, dla których jest sprawdzana zgodność przypisania konfiguracji gościa.
startTime	string	Data i godzina rozpoczęcia sprawdzania stanu zgodności przypisania konfiguracji gościa.
vm	VMInfo	Informacje o maszynie wirtualnej.

AssignmentReportResource

Zasób przypisania konfiguracji gościa.

Nazwa	Typ	Opis
complianceStatus	complianceStatus	Wartość wskazująca stan zgodności maszyny dla przypisanej konfiguracji gościa.
properties	object	Właściwości zasobu przypisania konfiguracji gościa.
reasons	AssignmentReportResourceComplianceReason[]	Przyczyna zgodności i kod przyczyny zasobu.
resourceId	string	Nazwa ustawienia zasobu przypisania konfiguracji gościa.

AssignmentReportResourceComplianceReason

Przyczyna i kod zgodności zasobu przypisania konfiguracji gościa.

Nazwa	Typ	Opis
code	string	Kod zgodności zasobu przypisania konfiguracji gościa.
phrase	string	Przyczyna zgodności zasobu przypisania konfiguracji gościa.

assignmentType

Określa typ przypisania i wykonywanie konfiguracji. Możliwe wartości to Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect i ApplyAndMonitor.

Nazwa	Typ	Opis
ApplyAndAutoCorrect	string
ApplyAndMonitor	string
Audit	string
DeployAndAutoCorrect	string

complianceStatus

Wartość wskazująca stan zgodności maszyny dla przypisanej konfiguracji gościa.

Nazwa	Typ	Opis
Compliant	string
NonCompliant	string
Pending	string

ConfigurationInfo

Informacje o konfiguracji.

Nazwa	Typ	Opis
name	string	Nazwa konfiguracji.
version	string	Wersja konfiguracji.

configurationMode

Określa, jak LCM(Local Configuration Manager) rzeczywiście stosuje konfigurację do węzłów docelowych. Możliwe wartości to ApplyOnly, ApplyAndMonitor i ApplyAndAutoCorrect.

Nazwa	Typ	Opis
ApplyAndAutoCorrect	string
ApplyAndMonitor	string
ApplyOnly	string

ConfigurationParameter

Reprezentuje parametr konfiguracji.

Nazwa	Typ	Opis
name	string	Nazwa parametru konfiguracji.
value	string	Wartość parametru konfiguracji.

ConfigurationSetting

Ustawienie konfiguracji LCM (Local Configuration Manager).

Nazwa	Typ	Domyślna wartość	Opis
actionAfterReboot	actionAfterReboot		Określa, co się stanie po ponownym uruchomieniu podczas stosowania konfiguracji. Możliwe wartości to ContinueConfiguration i StopConfiguration
allowModuleOverwrite	boolean		Jeśli wartość true — nowe konfiguracje pobrane z usługi ściągania mogą zastąpić stare w węźle docelowym. W przeciwnym razie fałsz
configurationMode	configurationMode		Określa, jak LCM(Local Configuration Manager) rzeczywiście stosuje konfigurację do węzłów docelowych. Możliwe wartości to ApplyOnly, ApplyAndMonitor i ApplyAndAutoCorrect.
configurationModeFrequencyMins	number	15	Jak często w minutach bieżąca konfiguracja jest sprawdzana i stosowana. Ta właściwość jest ignorowana, jeśli właściwość ConfigurationMode jest ustawiona na ApplyOnly. Wartość domyślna to 15.
rebootIfNeeded	boolean		Ustaw wartość true, aby automatycznie ponownie uruchomić węzeł po zastosowaniu konfiguracji wymagającej ponownego uruchomienia. W przeciwnym razie konieczne będzie ręczne ponowne uruchomienie węzła dla każdej wymaganej konfiguracji. Wartość domyślna to false. Aby użyć tego ustawienia, gdy warunek ponownego uruchomienia zostanie uchwalony przez coś innego niż DSC (np. Instalator Windows), połącz to ustawienie z modułem xPendingReboot.
refreshFrequencyMins	number	30	Interwał czasu w minutach, w którym LCM sprawdza usługę ściągania, aby uzyskać zaktualizowane konfiguracje. Ta wartość jest ignorowana, jeśli funkcja LCM nie jest skonfigurowana w trybie ściągania. Wartość domyślna to 30.

createdByType

Typ tożsamości, która utworzyła zasób.

Nazwa	Typ	Opis
Application	string
Key	string
ManagedIdentity	string
User	string

Error

Nazwa	Typ	Opis
code	string	Kod błędu.
message	string	Szczegółowy komunikat o błędzie wskazujący, dlaczego operacja nie powiodła się.

ErrorResponse

Odpowiedź na błąd operacji

Nazwa	Typ	Opis
error	Error