Freigeben über


Guest Configuration Assignments - Subscription List

Listet alle Gastkonfigurationszuweisungen für ein Abonnement auf.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
subscriptionId
path True

string

Abonnement-ID, die das Microsoft Azure-Abonnement eindeutig identifiziert. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.

api-version
query True

string

Client-API-Version.

Antworten

Name Typ Beschreibung
200 OK

GuestConfigurationAssignmentList

OK

204 No Content

Kein Inhalt

Other Status Codes

ErrorResponse

Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

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

Scopes

Name Beschreibung
user_impersonation Identitätswechsel Ihres Benutzerkontos

Beispiele

List all guest configuration assignments for a subscription

Sample Request

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

Sample Response

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

Definitionen

Name Beschreibung
actionAfterReboot

Gibt an, was nach einem Neustart während der Anwendung einer Konfiguration passiert. Die möglichen Werte sind ContinueConfiguration und StopConfiguration.

AssignmentInfo

Informationen zur Gastkonfigurationszuweisung.

AssignmentReport
AssignmentReportResource

Die Gastkonfigurationszuweisungsressource.

AssignmentReportResourceComplianceReason

Grund und Code für die Konformität der Gastkonfigurationszuweisungsressource.

assignmentType

Gibt den Zuweisungstyp und die Ausführung der Konfiguration an. Mögliche Werte sind Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect und ApplyAndMonitor.

complianceStatus

Ein Wert, der die Konformität status des Computers für die zugewiesene Gastkonfiguration angibt.

ConfigurationInfo

Informationen zur Konfiguration.

configurationMode

Gibt an, wie der LCM(Local Configuration Manager) die Konfiguration tatsächlich auf die Zielknoten anwendet. Mögliche Werte sind ApplyOnly, ApplyAndMonitor und ApplyAndAutoCorrect.

ConfigurationParameter

Stellt einen Konfigurationsparameter dar.

ConfigurationSetting

Konfigurationseinstellung von LCM (Local Configuration Manager).

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

Error
ErrorResponse

Fehlerantwort eines Vorgangsfehlers

GuestConfigurationAssignment

Die Gastkonfigurationszuweisung ist eine Zuordnung zwischen einer Computer- und Gastkonfiguration.

GuestConfigurationAssignmentList

Die Antwort des Listengastkonfigurationszuweisungsvorgangs.

GuestConfigurationAssignmentProperties

Eigenschaften der Gastkonfigurationszuweisung.

GuestConfigurationNavigation

Die Gastkonfiguration ist ein Artefakt, das die DSC-Konfiguration und ihre Abhängigkeiten kapselt. Das Artefakt ist eine ZIP-Datei, die die DSC-Konfiguration (als MOF) und abhängige Ressourcen und andere Abhängigkeiten wie Module enthält.

kind

Art der Gastkonfiguration. Beispiel: DSC

provisioningState

Der Bereitstellungsstatus, der nur in der Antwort angezeigt wird.

systemData

Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

type

Berichtstyp, Konsistenz oder Initial

VMInfo

Informationen zur VM.

VMSSVMInfo

Informationen zur VMSS-VM

actionAfterReboot

Gibt an, was nach einem Neustart während der Anwendung einer Konfiguration passiert. Die möglichen Werte sind ContinueConfiguration und StopConfiguration.

Name Typ Beschreibung
ContinueConfiguration

string

StopConfiguration

string

AssignmentInfo

Informationen zur Gastkonfigurationszuweisung.

Name Typ Beschreibung
configuration

ConfigurationInfo

Informationen zur Konfiguration.

name

string

Name der Gastkonfigurationszuweisung.

AssignmentReport

Name Typ Beschreibung
assignment

AssignmentInfo

Konfigurationsdetails der Gastkonfigurationszuweisung.

complianceStatus

complianceStatus

Ein Wert, der die Konformität status des Computers für die zugewiesene Gastkonfiguration angibt.

endTime

string

Enddatum und -uhrzeit der Gastkonfigurationszuweisungskonformität status überprüfen.

id

string

ARM-Ressourcen-ID des Berichts für die Gastkonfigurationszuweisung.

operationType

type

Berichtstyp, Konsistenz oder Initial

reportId

string

GUID, die den Bericht zur Gastkonfigurationszuweisung unter einem Abonnement, einer Ressourcengruppe, identifiziert.

resources

AssignmentReportResource[]

Die Liste der Ressourcen, für die die Compliance der Gastkonfigurationszuweisung überprüft wird.

startTime

string

Startdatum und Uhrzeit der Kompatibilität der Gastkonfigurationszuweisung status überprüfen.

vm

VMInfo

Informationen zur VM.

AssignmentReportResource

Die Gastkonfigurationszuweisungsressource.

Name Typ Beschreibung
complianceStatus

complianceStatus

Ein Wert, der die Konformität status des Computers für die zugewiesene Gastkonfiguration angibt.

properties

object

Eigenschaften einer Gastkonfigurationszuweisungsressource.

reasons

AssignmentReportResourceComplianceReason[]

Konformitätsgrund und -grundcode für eine Ressource.

resourceId

string

Name der Ressourceneinstellung für die Gastkonfigurationszuweisung.

AssignmentReportResourceComplianceReason

Grund und Code für die Konformität der Gastkonfigurationszuweisungsressource.

Name Typ Beschreibung
code

string

Code für die Konformität der Gastkonfigurationszuweisungsressource.

phrase

string

Grund für die Konformität der Gastkonfigurationszuweisungsressource.

assignmentType

Gibt den Zuweisungstyp und die Ausführung der Konfiguration an. Mögliche Werte sind Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect und ApplyAndMonitor.

Name Typ Beschreibung
ApplyAndAutoCorrect

string

ApplyAndMonitor

string

Audit

string

DeployAndAutoCorrect

string

complianceStatus

Ein Wert, der die Konformität status des Computers für die zugewiesene Gastkonfiguration angibt.

Name Typ Beschreibung
Compliant

string

NonCompliant

string

Pending

string

ConfigurationInfo

Informationen zur Konfiguration.

Name Typ Beschreibung
name

string

Name der Konfiguration.

version

string

Version der Konfiguration.

configurationMode

Gibt an, wie der LCM(Local Configuration Manager) die Konfiguration tatsächlich auf die Zielknoten anwendet. Mögliche Werte sind ApplyOnly, ApplyAndMonitor und ApplyAndAutoCorrect.

Name Typ Beschreibung
ApplyAndAutoCorrect

string

ApplyAndMonitor

string

ApplyOnly

string

ConfigurationParameter

Stellt einen Konfigurationsparameter dar.

Name Typ Beschreibung
name

string

Name des Konfigurationsparameters.

value

string

Wert des Konfigurationsparameters.

ConfigurationSetting

Konfigurationseinstellung von LCM (Local Configuration Manager).

Name Typ Standardwert Beschreibung
actionAfterReboot

actionAfterReboot

Gibt an, was nach einem Neustart während der Anwendung einer Konfiguration passiert. Die möglichen Werte sind ContinueConfiguration und StopConfiguration.

allowModuleOverwrite

boolean

Wenn true: Neue Konfigurationen, die vom Pulldienst heruntergeladen wurden, können die alten Konfigurationen auf dem Zielknoten überschreiben. Andernfalls false

configurationMode

configurationMode

Gibt an, wie die LCM(Local Configuration Manager) die Konfiguration tatsächlich auf die Zielknoten anwendet. Mögliche Werte sind ApplyOnly, ApplyAndMonitor und ApplyAndAutoCorrect.

configurationModeFrequencyMins

number

15

Gibt (in Minuten) an, wie oft die aktuelle Konfiguration überprüft und angewendet wird. Diese Eigenschaft wird ignoriert, wenn die „ConfigurationMode“-Eigenschaft auf „ApplyOnly“ festgelegt ist. Der Standardwert ist 15.

rebootIfNeeded

boolean

Legen Sie dies auf true fest, um den Knoten automatisch neu zu starten, nachdem eine Konfiguration angewendet wurde, die einen Neustart erfordert. Andernfalls müssen Sie den Knoten für jede Konfiguration manuell neu starten, die dies erfordert. Der Standardwert ist „FALSE“. Um diese Einstellung zu verwenden, wenn eine Neustartbedingung von einer anderen Komponente als von DSC in Kraft gesetzt wird (z.B. Windows Installer), kombinieren Sie diese Einstellung mit dem Modul xPendingReboot.

refreshFrequencyMins

number

30

Das Zeitintervall (in Minuten), in dem der LCM einen Pulldienst auf aktualisierte Konfigurationen abfragt. Dieser Wert wird ignoriert, wenn der LCM nicht im Pullmodus konfiguriert ist. Der Standardwert ist 30.

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

Name Typ Beschreibung
Application

string

Key

string

ManagedIdentity

string

User

string

Error

Name Typ Beschreibung
code

string

Fehlercode

message

string

Detailfehlermeldung, die angibt, warum der Vorgang fehlgeschlagen ist.

ErrorResponse

Fehlerantwort eines Vorgangsfehlers

Name Typ Beschreibung
error

Error

GuestConfigurationAssignment

Die Gastkonfigurationszuweisung ist eine Zuordnung zwischen einer Computer- und Gastkonfiguration.

Name Typ Beschreibung
id

string

ARM-Ressourcen-ID der Gastkonfigurationszuweisung.

location

string

Region, in der sich die VM befindet.

name

string

Name der Gastkonfigurationszuweisung.

properties

GuestConfigurationAssignmentProperties

Eigenschaften der Gastkonfigurationszuweisung.

systemData

systemData

Azure Resource Manager-Metadaten mit createdBy- und modifiedBy-Informationen.

type

string

Der Typ der Ressource.

GuestConfigurationAssignmentList

Die Antwort des Listengastkonfigurationszuweisungsvorgangs.

Name Typ Beschreibung
value

GuestConfigurationAssignment[]

Ergebnis des Listengastkonfigurationszuweisungsvorgangs.

GuestConfigurationAssignmentProperties

Eigenschaften der Gastkonfigurationszuweisung.

Name Typ Beschreibung
assignmentHash

string

Kombinierter Hash des Konfigurationspakets und der Parameter.

complianceStatus

complianceStatus

Ein Wert, der die Konformität status des Computers für die zugewiesene Gastkonfiguration angibt.

context

string

Die Quelle, die die Gastkonfigurationszuweisung initiiert hat. Beispiel: Azure Policy

guestConfiguration

GuestConfigurationNavigation

Die zuzuweisende Gastkonfiguration.

lastComplianceStatusChecked

string

Datum und Uhrzeit, zu dem die letzte Compliance-status überprüft wurde.

latestAssignmentReport

AssignmentReport

Zuletzt gemeldeter Gastkonfigurationszuweisungsbericht.

latestReportId

string

ID des neuesten Berichts für die Gastkonfigurationszuweisung.

parameterHash

string

Parameterhash für die Gastkonfigurationszuweisung.

provisioningState

provisioningState

Der Bereitstellungsstatus, der nur in der Antwort angezeigt wird.

resourceType

string

Ressourcentyp: VMSS/VM

targetResourceId

string

VM-Ressourcen-ID.

vmssVMList

VMSSVMInfo[]

Liste der VM-Compliancedaten für VMSS

GuestConfigurationNavigation

Die Gastkonfiguration ist ein Artefakt, das die DSC-Konfiguration und ihre Abhängigkeiten kapselt. Das Artefakt ist eine ZIP-Datei, die die DSC-Konfiguration (als MOF) und abhängige Ressourcen und andere Abhängigkeiten wie Module enthält.

Name Typ Beschreibung
assignmentSource

string

Gibt den Ursprung der Konfiguration an.

assignmentType

assignmentType

Gibt den Zuweisungstyp und die Ausführung der Konfiguration an. Mögliche Werte sind Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect und ApplyAndMonitor.

configurationParameter

ConfigurationParameter[]

Die Konfigurationsparameter für die Gastkonfiguration.

configurationProtectedParameter

ConfigurationParameter[]

Die geschützten Konfigurationsparameter für die Gastkonfiguration.

configurationSetting

ConfigurationSetting

Die Konfigurationseinstellung für die Gastkonfiguration.

contentHash

string

Kombinierter Hash des Gastkonfigurationspakets und der Konfigurationsparameter.

contentType

string

Gibt den Inhaltstyp der Konfiguration an. Mögliche Werte können "Builtin" oder "Custom" sein.

contentUri

string

URI des Speichers, in den das Gastkonfigurationspaket hochgeladen wird.

kind

kind

Art der Gastkonfiguration. Beispiel: DSC

name

string

Name der Gastkonfiguration.

version

string

Version der Gastkonfiguration.

kind

Art der Gastkonfiguration. Beispiel: DSC

Name Typ Beschreibung
DSC

string

provisioningState

Der Bereitstellungsstatus, der nur in der Antwort angezeigt wird.

Name Typ Beschreibung
Canceled

string

Created

string

Failed

string

Succeeded

string

systemData

Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

Name Typ Beschreibung
createdAt

string

Der Zeitstempel der Ressourcenerstellung (UTC).

createdBy

string

Die Identität, die die Ressource erstellt hat.

createdByType

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

lastModifiedAt

string

Der Zeitstempel der letzten Änderung der Ressource (UTC)

lastModifiedBy

string

Die Identität, die die Ressource zuletzt geändert hat.

lastModifiedByType

createdByType

Der Identitätstyp, der die Ressource zuletzt geändert hat.

type

Berichtstyp, Konsistenz oder Initial

Name Typ Beschreibung
Consistency

string

Initial

string

VMInfo

Informationen zur VM.

Name Typ Beschreibung
id

string

Azure-Ressourcen-ID des virtuellen Computers.

uuid

string

UUID (Universally Unique Identifier) des virtuellen Computers.

VMSSVMInfo

Informationen zur VMSS-VM

Name Typ Beschreibung
complianceStatus

complianceStatus

Ein Wert, der die Konformität status des Computers für die zugewiesene Gastkonfiguration angibt.

lastComplianceChecked

string

Datum und Uhrzeit, zu dem die letzte Compliance-status überprüft wurde.

latestReportId

string

ID des neuesten Berichts für die Gastkonfigurationszuweisung.

vmId

string

UUID des virtuellen Computers.

vmResourceId

string

Azure-Ressourcen-ID des virtuellen Computers.