Freigeben über

Referenz zum Abrufen des Ergebnisschemas der dsc-Ressource

  • Artikel

Zusammenfassung

Die Ergebnisausgabe des dsc resource get Befehls.

Metadaten

SchemaDialect: https://json-schema.org/draft/2020-12/schema
SchemaID:      https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/outputs/resource/get.json
Type:          object

Beschreibung

Beschreibt die Rückgabedaten für eine DSC-Ressourcen-instance aus dem dsc resource get Befehl. Die Rückgabedaten sind entweder ein einzelnes Objekt, das den tatsächlichen Zustand eines nicht geschachtelten instance beschreibt, oder ein Array von Objekten, die den tatsächlichen Zustand der geschachtelten Instanzen für eine Gruppen- oder Adapterressource beschreiben.

DSC gibt eine einfache get-Antwort zurück, wenn die instance keine Gruppenressource, Keine Adapterressource oder geschachtelt in einer Gruppe oder Adapterressource ist.

Wenn die abgerufene instance für eine Gruppenressource, adapterressource oder in einer Gruppen- oder Adapterressource geschachtelt ist, gibt DSC ein vollständiges Get-Ergebnis zurück, das auch den Ressourcentyp und instance Namen enthält.

Einfache Antwort abrufen

Beschreibt die Rückgabedaten für eine einzelne DSC Resource instance aus dem dsc resource get Befehl. Diese Daten werden für Instanzen zurückgegeben, bei denen es sich nicht um Gruppenressourcen, Adapterressourcen oder geschachtelte Gruppen- oder Adapterressourcen handelt.

Erforderliche Eigenschaften

Die Ausgabe enthält immer die folgenden Eigenschaften:

Eigenschaften

actualState

Die actualState -Eigenschaft enthält immer den Zustand der instance zurückgegeben, wenn DSC den Get-Vorgang der Ressource aufruft. DSC überprüft den Wert dieser Eigenschaft anhand des instance Schemas der Ressource.

Type:     object
Required: true

Vollständiges Abrufen des Ergebnisses

Beschreibt die Rückgabedaten für das vollständige Ergebnis des get Vorgangs für eine Ressource instance. Diese Daten werden zurückgegeben:

  • Für jede instance in einem Konfigurationsdokument, wenn Sie den dsc config get Befehl verwenden.
  • Für geschachtelte Instanzen einer Gruppen- oder Adapterressource, wenn Sie den dsc resource get Befehl verwenden.

Erforderliche Eigenschaften

Eigenschaften

metadata

Definiert Metadaten, die DSC für einen Konfigurationsvorgang zurückgibt. Die Eigenschaften unter der Microsoft.DSC -Eigenschaft beschreiben den Kontext des Vorgangs.

  • duration definiert die Dauer eines DSC-Vorgangs für ein Konfigurationsdokument oder eine Ressource instance als Zeichenfolge, die dem in ISO8601 ABNF für durationdefinierten Format folgt. Stellt beispielsweise PT0.611216S eine Dauer von etwa 0.61 Sekunden dar.
Type:     object
Required: true

Typ

Die type -Eigenschaft identifiziert die DSC-Ressource des instance anhand des vollqualifizierten Typnamens. Weitere Informationen zu Typnamen finden Sie unter Referenz zu vollqualifizierten DSC-Ressourcennamensschemas.

Type:     string
Required: true
Pattern:  ^\w+(\.\w+){0,2}\/\w+$

name

Die name -Eigenschaft identifiziert den instance anhand seines kurzen, eindeutigen, lesbaren Namens.

Type:     string
Required: true

result

Die result -Eigenschaft enthält den ist-Zustand für die Ressource. Dieser Wert ist entweder:

  • Die einfache Get-Antwort für die instance
  • Ein Array vollständiger Get-Ergebnisobjekte für jede geschachtelte instance, wenn es sich bei der Ressource um eine Gruppen- oder Adapterressource handelt.
Type: [object, array]
Required: true