dsc-Ressourcenliste

2025-07-10

Zusammenfassung

Ruft die Liste der verfügbaren DSC-Ressourcen mit einem optionalen Filter ab.

Syntax

dsc resource list [Options] <RESOURCE_NAME>

Beschreibung

Der list Unterbefehl sucht nach verfügbaren DSC-Ressourcen und gibt deren Informationen zurück. DSC ermittelt Ressourcen, indem zuerst die Umgebungsvariable oder DSC_RESOURCE_PATH nach .dsc.resource.ymlPATH.dsc.resource.json, und dsc.resource.yaml Dateien durchsucht wird. Weitere Informationen zu den Umgebungsvariablen, die DSC verwendet, finden Sie unter Umgebungsvariablen

Wenn es sich bei den ermittelten Ressourcen um Ressourcenadapter handelt, ruft DSC den list Vorgang für diese Adapter auf, wenn die Option --adapter einen entsprechenden Filter angibt. Standardmäßig gibt DSC keine angepassten Ressourcen zurück. Wenn Sie die --adapter Option verwenden, gibt der Befehl keine nicht angepassten Ressourcen zurück.

DSC gibt die Liste der ermittelten Ressourcen mit ihren Implementierungsinformationen und Metadaten zurück. Wenn der Befehl das RESOURCE_NAME Argument enthält, filtert DSC die Liste der ermittelten Ressourcen, bevor sie zurückgegeben werden. Die --description Optionen und --tags filtern die Ergebnisse nach den Ressourcenbeschreibungen und Tags. Filter werden nach der Ressourcenermittlung immer angewendet.

Angepasster Ressourcen-Cache

DSC verwaltet einen Cache mit ermittelten angepassten Ressourcen zur Leistungsoptimierung. Der Speicherort des Caches hängt vom Betriebssystem ab, wie in der folgenden Tabelle dargestellt.

Betriebssystem	Cache-Pfad
Linux	`~/.dsc/AdaptedResourcesLookupTable.json`
macOS	`~/.dsc/AdaptedResourcesLookupTable.json`
Fenster	`%LOCALAPPDATA%\dsc\AdaptedResourcesLookupTable.json`

Beispiele

Beispiel 1 : Auflisten aller nicht angepassten Ressourcen

Ohne Filter gibt der Befehl jede ermittelte DSC-Ressource zurück, ruft jedoch nicht den list Vorgang für Adapterressourcen auf, um angepasste Ressourcen aufzulisten.

dsc resource list

Type                                        Kind      Version  Capabilities  RequireAdapter  Description
--------------------------------------------------------------------------------------------------------------------------------------------------------------
Microsoft.DSC.Debug/Echo                    Resource  1.0.0    gs--t---
Microsoft.DSC.Transitional/RunCommandOnSet  Resource  0.1.0    gs------                      Takes a single-command line to execute on DSC set operation      
Microsoft.DSC/Assertion                     Group     0.1.0    gs--t---                      `test` will be invoked for all resources in the supplied configu…
Microsoft.DSC/Group                         Group     0.1.0    gs--t---                      All resources in the supplied configuration is treated as a grou…
Microsoft.DSC/Include                       Importer  0.1.0    gs--t---                      Allows including a configuration file with optional parameter fi…
Microsoft.DSC/PowerShell                    Adapter   0.1.0    gs--t-e-                      Resource adapter to classic DSC Powershell resources.
Microsoft.Windows/RebootPending             Resource  0.1.0    g-------                      Returns info about pending reboot.
Microsoft.Windows/Registry                  Resource  0.1.0    gs-w-d--                      Manage Windows Registry keys and values
Microsoft.Windows/WMI                       Adapter   0.1.0    g-------                      Resource adapter to WMI resources.
Microsoft.Windows/WindowsPowerShell         Adapter   0.1.0    gs--t---                      Resource adapter to classic DSC Powershell resources in Windows …
Microsoft/OSInfo                            Resource  0.1.0    g-----e-                      Returns information about the operating system.

Beispiel 2 – Auflisten einer bestimmten Ressource

Wenn das RESOURCE_NAME Argument keinen Platzhalter enthält, gibt der Befehl nur die Ressource mit dem angegebenen Typnamen zurück.

dsc resource list Microsoft.DSC/Group

Type                 Kind   Version  Capabilities  RequireAdapter  Description
-------------------------------------------------------------------------------------------------------------------------------------
Microsoft.DSC/Group  Group  0.1.0    gs--t---                      All resources in the supplied configuration is treated as a group.

Beispiel 3 : Auflisten von Ressourcen mit einem übereinstimmenden Typnamen

Wenn das RESOURCE_NAME Argument einen Platzhalter enthält, gibt der Befehl jede Ressource mit einem übereinstimmenden Typnamen zurück.

dsc resource list Microsoft.DSC/*

Type                      Kind      Version  Capabilities  RequireAdapter  Description
--------------------------------------------------------------------------------------------------------------------------------------------------
Microsoft.DSC/Assertion   Group     0.1.0    gs--t---                      `test` will be invoked for all resources in the supplied configuration.
Microsoft.DSC/Group       Group     0.1.0    gs--t---                      All resources in the supplied configuration is treated as a group.
Microsoft.DSC/Include     Importer  0.1.0    gs--t---                      Allows including a configuration file with optional parameter file.
Microsoft.DSC/PowerShell  Adapter   0.1.0    gs--t-e-                      Resource adapter to classic DSC Powershell resources.

Beispiel 4 : Auflisten von Ressourcen mit einer übereinstimmenden Beschreibung

Wenn der Befehl die Option *--description enthält, enthalten die Ergebnisse Ressourcen, deren Beschreibung den angegebenen Wert enthält.

dsc resource list --description 'supplied configuration'

Type                     Kind   Version  Capabilities  RequireAdapter  Description
----------------------------------------------------------------------------------------------------------------------------------------------
Microsoft.DSC/Assertion  Group  0.1.0    gs--t---                      `test` will be invoked for all resources in the supplied configuration.
Microsoft.DSC/Group      Group  0.1.0    gs--t---                      All resources in the supplied configuration is treated as a group.

Beispiel 5 : Auflisten von Ressourcen mit übereinstimmenden Tags

Wenn der Befehl mehrere Instanzen der --tags Option enthält, enthalten die Ergebnisse Ressourcen, die über eines der angegebenen Tags verfügen.

dsc resource list --tags Windows --tags Linux

Type                        Kind      Version  Capabilities  RequireAdapter  Description
----------------------------------------------------------------------------------------------------------------------------
Microsoft.Windows/Registry  Resource  0.1.0    gs-w-d--                      Manage Windows Registry keys and values
Microsoft/OSInfo            Resource  0.1.0    g-----e-                      Returns information about the operating system.

Beispiel 6: Auflisten von Ressourcen für einen bestimmten Adapter

Wenn der Befehl die --adapter Option enthält, sucht DSC nach ermittelten Ressourcenadaptern mit einem übereinstimmenden Namen. Wenn eine Ressource erkannt wird, ruft sie den list Vorgang für den Adapter auf und fügt die zurückgegebene Liste der angepassten Ressourcen der ermittelten Ressourcenliste hinzu. DSC wendet alle weiteren Filter an, die nach dieser Enumeration mit dem Befehl angegeben sind.

dsc resource list --adapter Microsoft.Windows/WindowsPowerShell

Der nächste Befehl gibt den Ressourcennamenfilter *Windows*an, der die Liste der zurückgegebenen Ressourcen einschränkt:

dsc resource list --adapter Microsoft.Windows/WindowsPowerShell *Windows*

Argumente

RESOURCE_NAME

Gibt einen optionalen Filter an, der für die Typnamen der ermittelten DSC-Ressourcen angewendet werden soll. Der Filter kann Platzhalter (*) enthalten. Bei dem Filter wird die Groß-/Kleinschreibung nicht beachtet.

Wenn dieses Argument angegeben wird, filtert DSC die Ergebnisse so, dass nur Ressourcen einbezogen werden, bei denen der Ressourcentypname mit dem Filter übereinstimmt.

Wenn Sie z. B. den Filter Microsoft.* angeben, werden nur die von Microsoft veröffentlichten Ressourcen zurückgegeben. Wenn Sie den Filter *Sql* angeben, wird eine beliebige Ressource mit der Zeichenfolge Sql im Namen zurückgegeben, unabhängig von der Groß-/Kleinschreibung.

Type      : string
Mandatory : false

Optionen

-a, --adapter

Gibt einen Filter an, der definiert, für welche Adapterressourcen angepasste Ressourcen aufgezählt werden sollen. Standardmäßig ruft der Befehl den list Befehl für Adapterressourcen nicht auf. Wenn Sie diese Option angeben, sucht DSC nach Adapterressourcen mit Typnamen, die dem Filter entsprechen. Wenn Adapter gefunden werden, die dem Filter entsprechen, ruft er den list Befehl für diese Adapter auf und gibt die angepassten Ressourcen zurück. DSC ruft angepasste Ressourcen ab, bevor andere Filter für den Befehl angewendet werden.

Wenn Sie diese Option verwenden, gibt der Befehl keine nicht angepassten Ressourcen zurück.

Wenn Sie diese Option mit dem Filter *angeben, ruft DSC jede gefundene Adapterressource auf list , bevor die anderen Filter angewendet werden.

Type        : string
Mandatory   : false
LongSyntax  : --adapter <ADAPTER_NAME>
ShortSyntax : -a <ADAPTER_NAME>

-d, --Beschreibung

Gibt eine Zeichenfolge an, die in der Beschreibung einer Ressource übereinstimmen soll. Wenn diese Option angegeben wird, filtert DSC die Ressourcen nach ihren Beschreibungszeichenfolgen. Bei dem Filter wird zwischen Groß- und Kleinschreibung unterschieden und der Wert an einer beliebigen Stelle in der Beschreibungszeichenfolge übereinstimmen. Wildcards sind nicht zulässig.

Type        : string
Mandatory   : false
LongSyntax  : --description <DESCRIPTION>
ShortSyntax : -d <DESCRIPTION>

-t, --tags

Gibt ein Ressourcentag an, nach dem gefiltert werden soll. Wenn diese Option angegeben ist, filtert DSC die Ressourcen und enthält nur diejenigen mit einem übereinstimmenden Tag. Bei dem Filter wird die Groß-/Kleinschreibung nicht beachtet. Wildcards sind nicht zulässig.

Sie können diese Option mehrmals angeben, um nach einer Gruppe von Tags zu filtern. Die Ergebnisse enthalten Ressourcen, die mindestens eine der tags enthalten, die mit dieser Option angegeben sind.

Type        : string
Mandatory   : false
LongSyntax  : --tags <TAGS>
ShortSyntax : -t <TAGS>

-o, --output-format

Die --output-format Option steuert, welches Format DSC für die Daten verwendet, die der Befehl zurückgibt. Die verfügbaren Formate sind:

json , um die Daten als JSON-Zeile auszugeben.
pretty-json , um die Daten als JSON mit Zeilenumbrüchen, Einzügen und Leerzeichen zur besseren Lesbarkeit auszugeben.
yaml , um die Daten als YAML auszugeben.
table-no-truncate , um die Daten als Zusammenfassungstabelle auszugeben, ohne jede Zeile auf die aktuelle Konsolenbreite zu kürzen.

Das Standardausgabeformat hängt davon ab, ob DSC erkennt, dass die Ausgabe umgeleitet oder als Variable erfasst wird:

Wenn der Befehl nicht umgeleitet oder erfasst wird, zeigt DSC die Ausgabe als Zusammenfassungstabelle an, die im Abschnitt Ausgabe dieses Dokuments beschrieben wird.
Wenn die Befehlsausgabe umgeleitet oder erfasst wird, gibt DSC die Daten im json Format stdout aus.

Wenn Sie diese Option verwenden, verwendet DSC das angegebene Format, unabhängig davon, ob der Befehl umgeleitet oder erfasst wird.

Wenn der Befehl nicht umgeleitet oder erfasst wird, wird die Ausgabe in der Konsole formatiert, um die Lesbarkeit zu verbessern. Wenn der Befehl nicht umgeleitet oder erfasst wird, enthält die Ausgabe Terminalsequenzen für die Formatierung.

Type        : string
Mandatory   : false
ValidValues : [json, pretty-json, yaml, table-no-truncate]
LongSyntax  : --output-format <OUTPUT_FORMAT>
ShortSyntax : -o <OUTPUT_FORMAT>

-h, --help (Hilfe)

Zeigt die Hilfe für den aktuellen Befehl oder Unterbefehl an. Wenn Sie diese Option angeben, ignoriert die Anwendung alle anderen Optionen und Argumente.

Type        : boolean
Mandatory   : false
LongSyntax  : --help
ShortSyntax : -h

Ausgabe

Dieser Befehl gibt ein formatiertes Array zurück, das für jede Ressource ein Objekt enthält, das den Typ, die Version, die Manifesteinstellungen und andere Metadaten der Ressource enthält. Weitere Informationen finden Sie unter DSC-Ressourcenlisten-Ergebnisschema.

Wenn die Ausgabe des Befehls nicht erfasst oder umgeleitet wird, wird er standardmäßig in der Konsole als Zusammenfassungstabelle für die zurückgegebenen Ressourcen angezeigt. Die Zusammenfassungstabelle enthält die folgenden Spalten, die in der aufgeführten Reihenfolge angezeigt werden:

Typ : Der vollqualifizierte Typname der Ressource.
Art : Gibt an, ob es sich bei der Ressource um eine adapter, group, importeroder eine typische Resource. Weitere Informationen finden Sie unter Referenz zum DSC-Ressourcenartschema.
Version : Die semantische Version der Ressource.
Funktionen : Eine Anzeige der Funktionen der Ressource als Flags. Die Funktionen werden in der folgenden Reihenfolge angezeigt, wobei ein - anstelle des entsprechenden Buchstabens verwendet wird, wenn die Ressource nicht über eine bestimmte Funktion verfügt:
- g Gibt an, dass die Ressource über die GET-Funktion verfügt.
- sGibt an, dass die Ressource über die festgelegte Funktion verfügt
- xgibt an, dass die Ressource über die setHandlesExist-Funktion verfügt
- wgibt an, dass die Ressource über die whatIf-Funktion verfügt
- tGibt an, dass die Ressource über die Testfunktion verfügt
- dGibt an, dass die Ressource über die Löschfunktion verfügt
- eGibt an, dass die Ressource über die Exportfunktion verfügt
- rGibt an, dass die Ressource über die Auflösungsfunktion verfügt
Die Microsoft.Windows/Registry Ressource verfügt beispielsweise über die folgenden Funktionen: gs--d-, was bedeutet, dass sie über die getFunktionen , setund delete verfügt.
RequireAdapter: Der vollqualifizierte Typname der Adapterressource, die DSC zum Aufrufen der zurückgegebenen Ressource verwendet.
Beschreibung : Die kurze Beschreibung des Zwecks und der Verwendung der Ressource.

Weitere Informationen zur Formatierung der Ausgabedaten finden Sie unter der Option --output-format.