Test de ressources dsc

Synopsis

Appelle l’opération de test d’une ressource.

Syntax

Propriétés d’instance de stdin

<instance-properties> | dsc resource set [Options] --resource <RESOURCE>

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

dsc resource set --input '<instance-properties>' --resource <RESOURCE>

Propriétés d’instance du fichier

dsc resource set --path <instance-properties-filepath> --resource <RESOURCE>

Description

La test sous-commande valide l’état réel d’une ressource instance par rapport à un état souhaité.

Cette sous-commande teste une instance d’une ressource DSC spécifique. Pour tester plusieurs ressources, utilisez un groupe de ressources ou la commande de test de configuration dsc .

L’état souhaité de l’instance à tester doit être passé à cette commande en tant qu’objet JSON ou YAML. Les propriétés de l’objet doivent être des propriétés valides pour la ressource. Les propriétés instance peuvent être passées à cette commande à partir de stdin, sous la forme d’une chaîne avec l’option --input ou d’un fichier enregistré avec l’option --path .

Si cette commande est appelée pour une ressource DSC basée sur une commande qui ne définit pas sa propre opération de test, DSC effectue un test synthétique. Le test synthétique compare chaque propriété pour l’état souhaité d’un instance à l’état réel. Le test synthétique utilise une équivalence stricte et sensible à la casse. Si l’état souhaité pour une propriété et l’état réel ne sont pas les mêmes, DSC marque la propriété comme étant hors de l’état souhaité.

Cette commande valide uniquement les propriétés instance dans deux conditions :

1. Lorsque la propriété est explicitement incluse dans l’entrée d’état souhaitée.
2. Lorsque la propriété a une valeur par défaut et n’est pas explicitement incluse dans l’entrée d’état souhaitée.

Exemples

Exemple 1 - Test d’une ressource avec les propriétés de stdin

La commande teste si la Example clé existe dans la ruche de l’utilisateur actuel. Il spécifie la ressource instance propriétés au format JSON et les transmet à partir de stdin.

'{
    "keyPath": "HKCU\\Example",
    "_exist": true
}' | dsc resource test --resource Microsoft.Windows/Registry

Exemple 2 - Test d’une ressource avec l’option d’entrée

La commande teste si la Example clé existe dans la ruche de l’utilisateur actuel. Il spécifie la ressource instance propriétés au format JSON et les transmet avec l’option d’entrée.

dsc resource test --resource Microsoft.Windows/Registry --input '{
    "keyPath": "HKCU\\Example",
    "_exist": true
}'

Exemple 3 - Test d’une ressource avec les propriétés d’un fichier YAML

La commande teste si la Example clé existe dans la ruche de l’utilisateur actuel. Il spécifie le chemin d’accès à un fichier YAML définissant la ressource instance propriétés avec l’option chemin d’accès.

keyPath: HKCU\\Example
_exist:  true

dsc resource test --resource Microsoft.Windows/Registry --path ./example.yaml

Options

-r, --resource

Spécifie le nom de type complet de la ressource DSC à utiliser, comme Microsoft.Windows/Registry.

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

• owner est l’auteur ou le organization de maintenance de la ressource.
• Et grouparea sont des composants de nom facultatifs qui activent l’espacement des noms pour une ressource.
• identifie name le composant que la ressource gère.

Type:      String
Mandatory: true

-i, --input

Spécifie un objet JSON ou YAML avec les propriétés définissant l’état souhaité d’une ressource DSC instance. DSC valide l’objet par rapport au schéma instance de la ressource. Si la validation échoue, DSC génère une erreur.

Cette option ne peut pas être utilisée avec instance propriétés sur stdin ou l’option --path . Choisissez de transmettre les propriétés instance à la commande sur stdin, à partir d’un fichier avec l’option --path ou avec l’option --input .

Type:      String
Mandatory: false

-p, --path

Définit le chemin d’accès à un fichier texte à lire en tant qu’entrée pour la commande au lieu de transmettre l’entrée à partir de stdin ou de la transmettre en tant que chaîne avec l’option --input . Le fichier spécifié doit contenir json ou YAML qui représente des propriétés valides pour la ressource. DSC valide l’objet par rapport au schéma 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 . Lorsque vous utilisez cette option, DSC ignore toute entrée de stdin.

Type:      String
Mandatory: false

-f, --format

L’option --format contrôle le format de sortie de la console pour la commande . Si la sortie de la commande est redirigée ou capturée en tant que variable, la sortie est toujours JSON.

Type:         String
Mandatory:    false
DefaultValue: yaml
ValidValues:  [json, pretty-json, yaml]

-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 options et arguments après celle-ci.

Type:      Boolean
Mandatory: false

Sortie

Cette commande retourne une sortie JSON qui inclut l’état souhaité de l’instance, l’état réel, la liste des propriétés qui ne sont pas dans l’état souhaité et une valeur booléenne indiquant si le instance est dans l’état souhaité. Pour plus d’informations, consultez Schéma de résultat du test de ressources dsc.