test de configuration dsc

Synopsis

Vérifie si les instances de ressources d’un document de configuration sont dans l’état souhaité.

Syntaxe

Document de configuration à partir d’un fichier

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

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

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

Document de configuration à partir de stdin

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

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

cat <PARAMETERS_FILE> | dsc config --parameters-file - test [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 - test [Options] --input <INPUT>

Descriptif

La test sous-commande vérifie si les instances de ressource d’un document de configuration sont dans l’état souhaité. Lorsque cette commande s’exécute, DSC valide le document de configuration avant d’appeler l’opération de test pour chaque instance de ressource définie dans le document.

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

Exemples

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

La commande renvoie l’état, l’état souhaité, l’état réel et les différentes propriétés des instances de ressource 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: Windows only
  type: Microsoft.DSC/Assertion
  properties:
    $schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
    resources:
    - name: os
      type: Microsoft/OSInfo
      properties:
        family: Windows
- name: Current user registry example
  type: Microsoft.Windows/Registry
  properties:
    keyPath: HKCU\example
    _exist: true
  dependsOn:
    - "[resourceId('Microsoft.DSC/Assertion', 'Windows only')"

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

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

La commande utilise l’option --file permettant de valider la configuration définie dans le example.dsc.config.yaml fichier.

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

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

La commande utilise l’option --input pour valider la configuration stockée dans la $desired variable.

dsc config test --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 indiquent si l’opération ou les ressources ont généré des erreurs, la collecte des messages émis pendant l’opération et les résultats de l’opération de test pour chaque instance. Pour plus d’informations, consultez Schéma de résultat du test de configuration dsc.

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