Freigeben über

dsc-Ressourcenlistenergebnisschemareferenz

  • Artikel

Zusammenfassung

Die Ergebnisausgabe des Befehls dsc resource list.

Metadaten

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

Beschreibung

Die Ausgabe des Befehls dsc resource list enthält eine Darstellung der ermittelten DSC-Ressourcen als Eine Reihe von JSON Lines. Dieses Schema beschreibt das JSON-Objekt, das für jede Ressource zurückgegeben wird.

Erforderliche Eigenschaften

Jede Ressource in der Ausgabe enthält immer die folgenden Eigenschaften:

Eigenschaften

Art

Gibt den vollqualifizierten Typnamen der Ressource an. Es wird verwendet, um die Ressource in Konfigurationsdokumenten und als Wert des --resource Flags bei Verwendung der dsc resource *-Befehle anzugeben. Weitere Informationen zu Ressourcentypnamen finden Sie unter DSC Resource fully qualified type name schema reference.

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

Art

Gibt an, ob es sich bei einer Ressource um eine Adapterressource, eine -Gruppenressourceoder keines handelt. Dieser Wert wird entweder im Ressourcenmanifest oder von DSC abgeleitet definiert. Weitere Informationen zu Ressourcentypen finden Sie unter DSC Resource kind schema reference.

Type:          string
Required:      true
ValidValues:  [Resource, Adapter, Group]

Version

Stellt die aktuelle Version der Ressource als gültige semantische Version (semver)-Zeichenfolge dar. Die Version gilt für die Ressource, nicht für die von ihr verwaltete Software.

Type:     string
Required: true
Pattern:  ^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$

Fähigkeiten

Definiert die Vorgänge und Verhaltensweisen, die die Ressource zur Unterstützung implementiert wird. Diese Eigenschaft ist ein Array von Funktionen. Ressourcen verfügen immer über die Get-Funktion, aber die anderen Funktionen sind optional und hängen von der Ressource ab.

In der folgenden Liste werden die verfügbaren Funktionen für eine Ressource beschrieben:

  • Get – Die Ressource unterstützt das Abrufen des aktuellen Zustands einer Instanz. Alle DSC-Ressourcen müssen über diese Funktion verfügen. Eine Ressource verfügt über diese Funktion, wenn sie die obligatorische abrufen Eigenschaft im Ressourcenmanifest definiert.

  • Set – Die Ressource unterstützt das Erzwingen des gewünschten Zustands einer Instanz. Eine Ressource verfügt über diese Funktion, wenn sie die festgelegt Eigenschaft im Ressourcenmanifest definiert. Ressourcen ohne diese Funktion können nicht mit dem dsc-Ressourcensatz oder dsc-Konfigurationssatz Befehle verwendet werden, es sei denn, sie befinden sich in einer Microsoft.DSC/Assertion-Gruppe als geschachtelte Instanz.

  • SetHandlesExist – Die Ressource unterstützt die _exist Eigenschaft direkt. Eine Ressource verfügt über diese Funktion, wenn sie die eigenschaft "handlesExist" als true in der Definition der festgelegten Befehlseigenschaft im Ressourcenmanifest definiert.

    Wenn eine Ressource über diese Funktion verfügt, ist die _exist Eigenschaft Teil des Instanzschemas der Ressource und die Ressource behandelt das Löschen von Instanzen der Ressource im set-Befehl.

    Wenn eine Ressource diese Funktion nicht hat, verarbeitet sie das Aufrufen des Löschens Vorgangs für die Ressource, wenn DSC eine Instanz der Ressource mit _exist auf falsefestgelegt ist.

    Wenn die Ressource nicht über diese Funktion oder die Delete-Funktion verfügt, löst DSC einen Fehler aus, wenn eine Instanz _exist als falsedefiniert.

  • WhatIf – Die Ressource unterstützt die Rückgabe expliziter Informationen darüber, wie der Zustand geändert wird, wenn ein Benutzer dsc config set mit der Option --what-if aufruft. Eine Ressource verfügt über diese Funktion, wenn sie die What-if-Methode definiert, die im Ressourcenmanifest.

    Wenn eine Ressource über diese Funktion verfügt, ruft DSC den definierten Befehl mit seinen Argumenten auf, wenn ein Benutzer den befehl dsc config set mit der Option --what-if ausführt.

    Wenn eine Ressource nicht über diese Funktion verfügt, synthetisiert DSC, wie sich die Ressource ändert und instanziert wird, indem das Test Ergebnis für die Instanz in ein Set Ergebnis konvertiert wird. Der synthetische Vorgang kann keine potenziellen Probleme oder Änderungen angeben, die nicht bestimmt werden können, indem das Ergebnis des Test Vorgangs mit dem gewünschten Zustand der Ressource verglichen wird. Beispielsweise können die zum Testen einer Ressource verwendeten Anmeldeinformationen für diesen Vorgang gültig sein, aber nicht über berechtigungen zum Tatsächlichen Ändern des Systemzustands verfügen. Nur eine Ressource mit dieser Funktion kann vollständig melden, ob und wie die Ressource den Systemzustand ändert.

  • Test – Die Ressource unterstützt die Überprüfung des gewünschten Zustands einer Instanz anhand des aktuellen Zustands der Instanz. Eine Ressource verfügt über diese Funktion, wenn sie die Test--Eigenschaft im Ressourcenmanifest definiert.

    Wenn eine Ressource nicht über die Test-Funktion verfügt, verwendet DSC einen synthetischen Test für Instanzen der Ressource. Der synthetische Test vergleicht jede Eigenschaft für den gewünschten Zustand einer Instanz mit dem tatsächlichen Zustand. Bei dem synthetischen Test werden strenge, zwischen Groß- und Kleinschreibung unterschiedene Äquivalenz verwendet. Wenn der gewünschte Zustand für eine Eigenschaft und der tatsächliche Zustand nicht identisch sind, markiert DSC die Eigenschaft als außerhalb des gewünschten Zustands.

  • Delete – Die Ressource unterstützt das Entfernen einer Instanz. Eine Ressource verfügt über diese Funktion, wenn sie die löschen Eigenschaft im Ressourcenmanifest definiert. Diese Funktion schließt sich nicht gegenseitig mit der SetHandlesExist-Eigenschaft aus. Eine Ressource kann die _exist Eigenschaft in Set-Vorgängen verarbeiten und direkt mit dsc-Ressourcenlöschung aufgerufen werden, um eine Instanz zu entfernen.

  • Export – Die Ressource unterstützt das Aufzählen jeder Instanz der Ressource. Eine Ressource verfügt über diese Funktion, wenn sie die Exportieren Eigenschaft im Ressourcenmanifest definiert. Nur Ressourcen mit dieser Funktion können mit dem dsc-Ressourcenexport und dsc config export Befehle verwendet werden.

  • Resolve – Die Ressource unterstützt das Auflösen von geschachtelten Ressourceninstanzen aus einer externen Quelle. Eine Ressource verfügt über diese Funktion, wenn sie die auflösen Eigenschaft im Ressourcenmanifest definiert. Diese Funktionalität wird in erster Linie von Importressourcenverwendet.

Type:              array
Required:          true
ItemsMustBeUnique: true
ItemsType:         string
ItemsValidValues: [Get, Set, SetHandlesExist, Test, Delete, Export]

Beschreibung

Definiert eine Synopse für den Zweck der Ressource als kurze Zeichenfolge. Wenn die Ressource keine Beschreibung hat, ist diese Eigenschaft null.

Type:     [string, 'null']
Required: true

Pfad

Stellt den Pfad zum Manifest der Ressource auf dem Computer dar. Bei angepassten Ressourcen identifiziert diese Eigenschaft stattdessen den Pfad zu der Datei, die die Ressource definiert.

Type:     string
Required: true

Verzeichnis

Stellt den Pfad zum Ordner dar, der das Manifest der Ressource auf dem Computer enthält. Bei angepassten Ressourcen identifiziert diese Eigenschaft den Pfad zum Ordner, der die Datei enthält, die die Ressource definiert.

Type:     string
Required: true

implementedAs

Gibt an, wie die DSC-Ressource implementiert wurde. Für befehlsbasierte Ressourcen ist dieser Wert immer Command.

Verfasser

Gibt den Namen der Person oder Organisation an, die die DSC-Ressource entwickelt und verwaltet. Wenn diese Eigenschaft nullist, ist der Autor unbekannt.

Type:     [string, 'null']
Required: true

Eigenschaften

Definiert die Eigenschaftennamen für angepasste Ressourcen. Bei nicht angepassten Ressourcen ist diese Eigenschaft ein leeres Array.

Type:         array
Required:     true
ItemsType:    string
ItemsPattern: ^\w+$

requireAdapter

Definiert den vollqualifizierten Typnamen des DSC-Ressourcenadapters, über den diese Ressource verfügbar gemacht wird. Dieser Wert wird nur für angepasste Ressourcen definiert. Bei nicht angepassten Ressourcen ist dieser Wert immer null.

Type:     [string, 'null']
Required: true

manifest

Stellt die werte dar, die im Manifest der Ressource definiert sind. Dieser Wert ist null für Ressourcen, die nicht befehlsbasiert sind. Weitere Informationen zum Wert für diese Eigenschaft finden Sie unter Befehlsbasierten DSC-Ressourcenmanifestschemareferenz.

Type:     [object, 'null']
Required: true