dsc-resourcetest

Synopsis

Roept de testbewerking van een resource aan.

Syntax

Exemplaareigenschappen van stdin

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

Exemplaareigenschappen van invoeroptie

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

Exemplaareigenschappen van bestand

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

Description

De test subopdracht valideert de werkelijke status van een resource-exemplaar op basis van een gewenste status.

Met deze subopdracht wordt één exemplaar van een specifieke DSC-resource getest. Als u meerdere resources wilt testen, gebruikt u een resourcegroep of de opdracht dsc config test .

De gewenste status van het te testen exemplaar moet worden doorgegeven aan deze opdracht als een JSON- of YAML-object. De objecteigenschappen moeten geldige eigenschappen voor de resource zijn. De exemplaareigenschappen kunnen aan deze opdracht worden doorgegeven vanuit stdin, als een tekenreeks met de --input optie, of vanuit een opgeslagen bestand met de --path optie.

Als deze opdracht wordt aangeroepen voor een DSC-resource op basis van een opdracht die geen eigen testbewerking definieert, voert DSC een synthetische test uit. De synthetische test vergelijkt elke eigenschap voor de gewenste status van een exemplaar met de werkelijke status. De synthetische test maakt gebruik van strikte, hoofdlettergevoelige equivalentie. Als de gewenste status voor een eigenschap en de werkelijke status niet hetzelfde zijn, markeert DSC de eigenschap als buiten de gewenste status.

Met deze opdracht worden alleen exemplaareigenschappen gevalideerd onder twee voorwaarden:

1. Wanneer de eigenschap expliciet is opgenomen in de gewenste statusinvoer.
2. Wanneer de eigenschap een standaardwaarde heeft en niet expliciet is opgenomen in de gewenste statusinvoer.

Voorbeelden

Voorbeeld 1: een resource testen met eigenschappen van stdin

Met de opdracht wordt getest of de Example sleutel bestaat in de huidige gebruikerscomponent. Hiermee geeft u de eigenschappen van het resource-exemplaar op als JSON en geeft u deze door vanuit stdin.

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

Voorbeeld 2: een resource testen met de invoeroptie

Met de opdracht wordt getest of de Example sleutel bestaat in de huidige gebruikerscomponent. Hiermee geeft u de eigenschappen van het resource-exemplaar op als JSON en geeft u deze door met de invoeroptie .

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

Voorbeeld 3: een resource testen met eigenschappen uit een YAML-bestand

Met de opdracht wordt getest of de Example sleutel bestaat in de huidige gebruikerscomponent. Hiermee wordt het pad opgegeven naar een YAML-bestand dat de eigenschappen van het resource-exemplaar definieert met de padoptie .

keyPath: HKCU\\Example
_exist:  true

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

Opties

-r, --resource

Hiermee geeft u de volledig gekwalificeerde typenaam van de DSC-resource te gebruiken, zoals Microsoft.Windows/Registry.

De syntaxis van de volledig gekwalificeerde typenaam is: <owner>[.<group>][.<area>]/<name>, waarbij:

• De owner is de onderhoudende auteur of organisatie voor de resource.
• De group en area zijn optionele naamonderdelen waarmee namespacing voor een resource mogelijk is.
• De name identificeert het onderdeel dat door de resource wordt beheerd.

Type:      String
Mandatory: true

-i, --input

Hiermee geeft u een JSON- of YAML-object op met de eigenschappen die de gewenste status van een DSC-resource-exemplaar definiëren. DSC valideert het object op basis van het exemplaarschema van de resource. Als de validatie mislukt, genereert DSC een fout.

Deze optie kan niet worden gebruikt met exemplaareigenschappen via stdin of de --path optie. Kies of u de exemplaareigenschappen wilt doorgeven aan de opdracht via stdin, vanuit een bestand met de --path optie of met de --input optie.

Type:      String
Mandatory: false

-p, --path

Definieert het pad naar een tekstbestand dat moet worden gelezen als invoer voor de opdracht in plaats van invoer uit stdin door te sluisen of door te geven als een tekenreeks met de --input optie. Het opgegeven bestand moet JSON of YAML bevatten die geldige eigenschappen voor de resource vertegenwoordigen. DSC valideert het object op basis van het exemplaarschema van de resource. Als de validatie mislukt of als het opgegeven bestand niet bestaat, genereert DSC een fout.

Deze optie is wederzijds exclusief met de --input optie. Wanneer u deze optie gebruikt, negeert DSC alle invoer van stdin.

Type:      String
Mandatory: false

-f, --format

De --format optie bepaalt de indeling van de console-uitvoer voor de opdracht. Als de uitvoer van de opdracht wordt omgeleid of vastgelegd als een variabele, is de uitvoer altijd JSON.

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

-h, --help

Geeft de Help weer voor de huidige opdracht of subopdracht. Wanneer u deze optie opgeeft, worden alle opties en argumenten na deze optie genegeerd.

Type:      Boolean
Mandatory: false

Uitvoer

Deze opdracht retourneert JSON-uitvoer die de gewenste status van het exemplaar bevat, de werkelijke status, de lijst met eigenschappen die niet de gewenste status hebben en een Booleaanse waarde die aangeeft of het exemplaar de gewenste status heeft. Zie voor meer informatie dsc resource test result schema.