Exportation de ressources dsc

Synopsis

Génère un document de configuration qui définit les instances existantes d’une ressource spécifique.

Syntaxe

Sans propriétés d’instance

dsc resource export [Options] --resource <RESOURCE>

Propriétés d’instance à partir de l’option d’entrée

dsc resource export --input <INPUT> --resource <RESOURCE>

Propriétés d’instance à partir du fichier

dsc resource export --file <FILE> --resource <RESOURCE>

Propriétés d’instance à partir de stdin

cat <FILE> | dsc resource get [Options] --resource <RESOURCE> --file -

Descriptif

La export sous-commande génère un document de configuration qui inclut chaque instance d’une ressource spécifique. La ressource doit être spécifiée avec l’option --resource .

À partir de DSC 3.1.0, vous pouvez utiliser l’option --input ou --file pour spécifier une instance de ressource à utiliser comme filtre pour les ressources exportées. Lorsque vous le faites, l’instance spécifiée est transmise à la ressource pour être utilisée dans le filtrage. L’implémentation du filtrage dépend de chaque ressource, et non de DSC lui-même.

Spécifiez uniquement des ressources exportables à l’aide d’un manifeste de ressource qui définit la section d’exportation dans la configuration d’entrée. Si le type de ressource spécifié n’est pas exportable, DSC génère une erreur.

Paramètres

-r, --ressource

Spécifie le nom de type complet de la ressource DSC à exporter, par exemple Microsoft.Windows/Registry.

La syntaxe de nom de type complet est la suivante : <owner>[.<group>][.<area>]/<name>, où :

• Il owner s’agit de l’auteur ou de l’organisation responsable de la ressource.
• Les group et area sont des composants de nom facultatifs qui activent l’espacement des noms pour une ressource.
• Le identifie name le composant géré par la ressource.

Type        : string
Mandatory   : true
LongSyntax  : --resource <RESOURCE>
ShortSyntax : -r <RESOURCE>

-i, --input

Spécifie l’instance de ressource à utiliser comme filtre pour les instances de ressource exportées.

L’instance doit être une chaîne contenant un objet JSON ou YAML. DSC valide l’objet par rapport au schéma d’instance de la ressource. En cas d’échec de la validation, DSC génère une erreur.

Cette option s’exclut mutuellement avec l’option --file .

Type        : string
Mandatory   : false
LongSyntax  : --input <INPUT>
ShortSyntax : -i <INPUT>

-f, --fichier

Définit le chemin d’accès à un fichier définissant l’instance de ressource à utiliser comme filtre pour les instances de ressource exportées.

Le fichier spécifié doit contenir un objet JSON ou YAML qui représente des propriétés valides pour la ressource. DSC valide l’objet par rapport au schéma d’instance de la ressource. Si la validation échoue ou si le fichier spécifié n’existe pas, DSC génère une erreur.

Cette option s’exclut mutuellement avec l’option --input .

Type        : string
Mandatory   : false
LongSyntax  : --file <FILE>
ShortSyntax : -f <FILE>

-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 :

• json pour émettre les données sous la forme d’une ligne JSON.
• pretty-json pour émettre les données au format JSON avec des sauts de ligne, des retraits et des espaces pour plus de lisibilité.
• yaml pour émettre les données au format YAML.

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 au yaml format dans la console.
• Si la sortie de la commande est redirigée ou capturée, DSC émet les données au json format 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]
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 des données formatées qui définissent un document de configuration incluant chaque instance des ressources déclarées dans la configuration d’entrée. Pour plus d’informations, consultez Référence du schéma du document de configuration DSC.

Pour plus d’informations sur le formatage des données de sortie, consultez l’option --output-format.