exportation de configuration dsc

Synopsis

Génère un document de configuration qui définit les instances existantes d’un ensemble de ressources.

Syntaxe

Document de configuration à partir d’un fichier

dsc config export [Options] --file <FILE>

Document de configuration à partir de la chaîne d’options

dsc config export [Options] --input <INPUT>

Document de configuration à partir de stdin

cat <FILE> | dsc config export [Options] --file -

Document de configuration à partir d’un fichier avec les paramètres de stdin

cat <PARAMETERS_FILE> | dsc config --parameters-file - export [Options] --file <FILE>

Document de configuration à partir de la chaîne d’options avec les paramètres de stdin

cat <PARAMETERS_FILE> | dsc config --parameters-file - export [Options] --input <INPUT>

Descriptif

La export sous-commande génère un document de configuration qui inclut chaque instance d’un ensemble de ressources.

Le document de configuration doit être transmis à cette commande au format JSON ou YAML avec l’option --input or --file .

Le document d’entrée définit les ressources à exporter. DSC ignore les propriétés spécifiées pour les ressources dans la configuration d’entrée de l’opération, mais le document d’entrée et toutes les propriétés des instances de ressource doivent toujours être validés par rapport au document de configuration et aux schémas d’instance de ressource.

Spécifiez uniquement les ressources à l’aide d’un manifeste de ressource qui définit la section d’exportation dans la configuration d’entrée. Ne définissez chaque type de ressource qu’une seule fois. Si le document de configuration inclut une instance de ressource dont le type de ressource n’est pas exportable ou a déjà été déclaré dans la configuration, DSC génère une erreur.

Exemples

Exemple 1 : tester si les instances de ressources d’une configuration sont dans l’état souhaité

La commande inspecte le système pour renvoyer un document de configuration contenant toutes les instances découvertes des ressources définies dans le document de configuration enregistré sous le nom example.dsc.config.yaml. Il transmet le document de configuration à la commande de stdin à l’aide de l’option --file .

# example.dsc.config.yaml
$schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
resources:
- name: Operating system information
  type: Microsoft/OSInfo
  properties: {}
- name: Processes
  type: Microsoft/Process
  properties: {}

cat ./example.dsc.config.yaml | dsc config export --file -

Exemple 2 - Passage d’un fichier à lire en tant que document de configuration

La commande utilise l’option permettant d’exporter les --file ressources à partir de la configuration définie dans le example.dsc.config.yaml fichier.

dsc config export --file ./example.dsc.config.yaml

Exemple 3 - Passer un document de configuration en tant que variable

La commande utilise l’option --input permettant d’extraire des ressources de la configuration stockée dans la $desired variable.

dsc config export --input $desired

Paramètres

-i, --input

Spécifie le document de configuration pour lequel valider l’état.

Le document doit être une chaîne contenant un objet JSON ou YAML. DSC valide le document par rapport au schéma du document de configuration. 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 document de configuration pour valider l’état.

Le fichier spécifié doit contenir un document de configuration en tant qu’objet JSON ou YAML. DSC valide le document par rapport au schéma du document de configuration. Si la validation échoue ou si le fichier spécifié n’existe pas, DSC génère une erreur.

Vous pouvez également utiliser cette option pour passer un document de configuration à partir de stdin, comme illustré dans l’exemple 1.

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.