Remarque
L’accès à cette page nécessite une autorisation. Vous pouvez essayer de vous connecter ou de modifier des répertoires.
L’accès à cette page nécessite une autorisation. Vous pouvez essayer de modifier des répertoires.
Synopsis
Récupère la liste des ressources DSC disponibles à l’aide d’un filtre facultatif.
Syntaxe
dsc resource list [Options] <RESOURCE_NAME>
Descriptif
La list sous-commande recherche les ressources DSC disponibles et renvoie leurs informations. DSC découvre les ressources en recherchant d’abord , PATHet DSC_RESOURCE_PATH les fichiers dans la variable .dsc.resource.jsond’environnement .dsc.resource.yml oudsc.resource.yaml. Pour plus d’informations sur les variables d’environnement utilisées par DSC, consultez Variables d’environnement
Si l’une des ressources découvertes est des adaptateurs de ressources, DSC appelle l’opération list pour ces adaptateurs si l’option --adapter spécifie un filtre correspondant. Par défaut, DSC ne retourne aucune ressource adaptée. Lorsque vous utilisez l’option --adapter , la commande ne renvoie pas de ressources non adaptées.
DSC retourne la liste des ressources découvertes avec leurs informations d’implémentation et leurs métadonnées. Si la commande inclut l’argument RESOURCE_NAME , DSC filtre la liste des ressources découvertes avant de les renvoyer. Les --description options et --tags filtrent les résultats en fonction des descriptions et des balises des ressources. Les filtres sont toujours appliqués après la découverte de ressources.
Cache de ressources adapté
DSC gère un cache des ressources adaptées découvertes pour l’optimisation des performances. L’emplacement du cache dépend du système d’exploitation, comme indiqué dans le tableau suivant.
| Système d’exploitation | Chemin d’accès au cache |
|---|---|
| Linux | ~/.dsc/AdaptedResourcesLookupTable.json |
| macOS | ~/.dsc/AdaptedResourcesLookupTable.json |
| Fenêtres | %LOCALAPPDATA%\dsc\AdaptedResourcesLookupTable.json |
Exemples
Exemple 1 - Répertorier toutes les ressources non adaptées
Sans aucun filtre, la commande retourne toutes les ressources DSC découvertes, mais n’appelle pas l’opération pour les list ressources d’adaptateur afin d’énumérer les ressources adaptées.
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.
Exemple 2 - Répertorier une ressource spécifique
Lorsque l’argument RESOURCE_NAME n’inclut pas de caractère générique, la commande renvoie uniquement la ressource avec le nom de type spécifié.
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.
Exemple 3 - Répertorier les ressources avec un nom de type correspondant
Lorsque l’argument RESOURCE_NAME inclut un caractère générique, la commande renvoie chaque ressource avec un nom de type correspondant.
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.
Exemple 4 - Répertorier les ressources avec une description correspondante
Lorsque la commande inclut l’option *--description , les résultats incluent les ressources dont la description contient la valeur spécifiée.
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.
Exemple 5 - Répertorier les ressources avec des balises correspondantes
Lorsque la commande inclut plusieurs instances de l’option --tags , les résultats incluent les ressources qui ont l’une des balises spécifiées.
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.
Exemple 6 : répertorier les ressources d’un adaptateur spécifique
Lorsque la commande inclut l’option --adapter , DSC recherche les adaptateurs de ressources découverts avec un nom correspondant. S’il en découvre, il appelle ensuite l’opération list pour l’adaptateur et ajoute la liste renvoyée des ressources adaptées à la liste des ressources découvertes. DSC applique d’autres filtres spécifiés avec la commande après cette énumération.
dsc resource list --adapter Microsoft.Windows/WindowsPowerShell
La commande suivante spécifie le filtre *Windows*de nom de ressource , limitant la liste des ressources renvoyées :
dsc resource list --adapter Microsoft.Windows/WindowsPowerShell *Windows*
Les arguments
RESOURCE_NAME
Spécifie un filtre facultatif à appliquer pour les noms de type des ressources DSC découvertes. Le filtre peut inclure des caractères génériques (*). Le filtre ne respecte pas la casse.
Lorsque cet argument est spécifié, DSC filtre les résultats pour inclure uniquement les ressources où le nom du type de ressource correspond au filtre.
Par exemple, la spécification du filtre Microsoft.* renvoie uniquement les ressources publiées par Microsoft.
La spécification du filtre *Sql* renvoie toute ressource dont le nom contient la chaîne Sql , quelle que soit la casse.
Type : string
Mandatory : false
Options
-a, --adaptateur
Spécifie un filtre pour définir les ressources d’adaptateur pour lesquelles énumérer les ressources adaptées. Par défaut, la commande n’appelle pas la commande pour les ressources de l’adaptateur list . Lorsque vous spécifiez cette option, DSC recherche des ressources d’adaptateur avec des noms de type qui correspondent au filtre. S’il découvre des adaptateurs correspondant au filtre, il appelle la list commande de ces adaptateurs et renvoie les ressources adaptées. DSC récupère les ressources adaptées avant d’appliquer d’autres filtres pour la commande.
Lorsque vous utilisez cette option, la commande ne renvoie pas de ressources non adaptées.
Si vous spécifiez cette option avec le filtre *, DSC appelle list chaque ressource d’adaptateur qu’il trouve avant d’appliquer les autres filtres.
Type : string
Mandatory : false
LongSyntax : --adapter <ADAPTER_NAME>
ShortSyntax : -a <ADAPTER_NAME>
-d, --description
Spécifie une chaîne à mettre en correspondance dans la description d’une ressource. Lorsque cette option est spécifiée, DSC filtre les ressources par leurs chaînes de description. Le filtre ne respecte pas la casse et correspond à la valeur n’importe où dans la chaîne de description. Les caractères génériques ne sont pas autorisés.
Type : string
Mandatory : false
LongSyntax : --description <DESCRIPTION>
ShortSyntax : -d <DESCRIPTION>
-t, --tags
Spécifie une balise de ressource sur laquelle filtrer. Lorsque cette option est spécifiée, DSC filtre les ressources et inclut uniquement celles avec une balise correspondante. Le filtre ne respecte pas la casse. Les caractères génériques ne sont pas autorisés.
Vous pouvez spécifier cette option plusieurs fois pour filtrer sur un ensemble de balises. Les résultats incluent les ressources qui ont au moins l’une des balises spécifiées avec cette option.
Type : string
Mandatory : false
LongSyntax : --tags <TAGS>
ShortSyntax : -t <TAGS>
-o, --format-de-sortie
L’option --output-format contrôle le format utilisé par DSC pour les données renvoyées par la commande. Les formats disponibles sont les suivants :
-
jsonpour émettre les données sous la forme d’une ligne JSON. -
pretty-jsonpour émettre les données au format JSON avec des sauts de ligne, des retraits et des espaces pour plus de lisibilité. -
yamlpour émettre les données au format YAML. -
table-no-truncatepour émettre les données sous forme de table récapitulative sans tronquer chaque ligne à la largeur actuelle de la console.
Le format de sortie par défaut varie selon que DSC détecte que la sortie est redirigée ou capturée en tant que variable :
- Si la commande n’est pas redirigée ou capturée, DSC affiche la sortie sous la forme d’un tableau récapitulatif décrit dans la section Sortie de ce document.
- Si la sortie de la commande est redirigée ou capturée, DSC émet les données au
jsonformat stdout.
Lorsque vous utilisez cette option, DSC utilise le format spécifié, que la commande soit redirigée ou capturée.
Lorsque la commande n’est pas redirigée ou capturée, la sortie de la console est formatée pour une meilleure lisibilité. Lorsque la commande n’est pas redirigée ou capturée, la sortie inclut des séquences terminales pour la mise en forme.
Type : string
Mandatory : false
ValidValues : [json, pretty-json, yaml, table-no-truncate]
LongSyntax : --output-format <OUTPUT_FORMAT>
ShortSyntax : -o <OUTPUT_FORMAT>
-h, --help
Affiche l’aide de la commande ou de la sous-commande actuelle. Lorsque vous spécifiez cette option, l’application ignore toutes les autres options et arguments.
Type : boolean
Mandatory : false
LongSyntax : --help
ShortSyntax : -h
Sortie
Cette commande renvoie un tableau formaté contenant un objet pour chaque ressource qui inclut le type, la version, les paramètres de manifeste et d’autres métadonnées de la ressource. Pour plus d’informations, consultez Schéma de résultat de la liste de ressources dsc.
Si la sortie de la commande n’est pas capturée ou redirigée, elle s’affiche dans la console par défaut sous la forme d’une table récapitulative pour les ressources retournées. Le tableau récapitulative comprend les colonnes suivantes, affichées dans l’ordre indiqué :
Type : nom de type complet de la ressource.
Type : si la ressource est un ,
adapter,groupou unimporterResource. Pour plus d’informations, consultez Référence de schéma du type de ressource DSC.Version : version sémantique de la ressource.
Capacités : affichage des capacités de la ressource sous forme d’indicateurs. Les fonctionnalités sont affichées dans l’ordre suivant, à l’aide de a
-au lieu de la lettre appropriée si la ressource n’a pas de capacité spécifique :-
gIndique que la ressource dispose de la capacité GET. -
sIndique que la ressource dispose de la capacité définie -
xindique que la ressource dispose de la fonctionnalité setHandlesExist -
windique que la ressource dispose de la capacité whatIf -
tIndique que la ressource dispose de la capacité de test -
dindique que la ressource dispose de la capacité de suppression -
eindique que la ressource dispose de la capacité d’exportation -
rIndique que la ressource dispose de la capacité de résolution
Par exemple, la
Microsoft.Windows/Registryressource possède les fonctionnalités suivantes :gs--d-, indiquant qu’elle a lesgetcapacités ,setetdelete.-
RequireAdapter : nom de type complet de la ressource d’adaptateur que DSC utilise pour appeler la ressource renvoyée.
Description : brève description de l’objectif et de l’utilisation de la ressource.
Pour plus d’informations sur le formatage des données de sortie, consultez l’option --output-format.
Collaborer avec nous sur GitHub
La source de ce contenu se trouve sur GitHub, où vous pouvez également créer et examiner les problèmes et les demandes de tirage. Pour plus d’informations, consultez notre guide du contributeur.
