Test prostředků dsc

Článek
03/06/2024

Synopse

Vyvolá testovací operaci prostředku.

Syntax

Vlastnosti instance ze stdin

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

Vlastnosti instance ze vstupní možnosti

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

Vlastnosti instance ze souboru

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

Description

Podpříkaz test ověří skutečný stav instance prostředku proti požadovanému stavu.

Tento podpříkaz testuje jednu instanci konkrétního prostředku DSC. K otestování více prostředků použijte skupinu prostředků nebo příkaz dsc config test .

Požadovaný stav instance, která se má testovat, musí být předán tomuto příkazu jako objekt JSON nebo YAML. Vlastnosti objektu musí být platnými vlastnostmi prostředku. Vlastnosti instance lze tomuto příkazu předat ze stdin jako řetězec s --input možností nebo z uloženého souboru s --path možností .

Pokud se tento příkaz vyvolá pro prostředek DSC založený na příkazech, který nedefinuje vlastní testovací operaci, provede DSC syntetický test. Syntetický test porovnává každou vlastnost požadovaného stavu instance se skutečným stavem. Syntetický test používá striktní ekvivalenci s rozlišováním velkých a malých písmen. Pokud požadovaný stav vlastnosti a skutečný stav nejsou stejné, DSC označí vlastnost jako mimo požadovaný stav.

Tento příkaz ověřuje vlastnosti instance pouze za dvou podmínek:

Když je vlastnost explicitně zahrnuta v požadovaném stavu vstup.
Pokud má vlastnost výchozí hodnotu a není explicitně zahrnuta do vstupu požadovaného stavu.

Příklady

Příklad 1 – Testování prostředku s vlastnostmi ze stdin

Příkaz testuje, jestli Example klíč existuje v podregistru aktuálního uživatele. Určuje vlastnosti instance prostředku jako JSON a předává je ze stdinu.

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

Příklad 2 – Testování prostředku s možností vstupu

Příkaz testuje, jestli Example klíč existuje v podregistru aktuálního uživatele. Určuje vlastnosti instance prostředku jako JSON a předá je s možností vstupu .

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

Příklad 3 – Testování prostředku s vlastnostmi ze souboru YAML

Příkaz testuje, jestli Example klíč existuje v podregistru aktuálního uživatele. Určuje cestu k souboru YAML definující vlastnosti instance prostředku s možností cesty .

keyPath: HKCU\\Example
_exist:  true

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

Možnosti

-r, --resource

Určuje plně kvalifikovaný název typu prostředku DSC, který se má použít, například Microsoft.Windows/Registry.

Plně kvalifikovaná syntaxe názvu typu je: <owner>[.<group>][.<area>]/<name>, kde:

Jedná se owner o autora nebo organizaci, který spravuje prostředek.
area A group jsou volitelné komponenty názvů, které umožňují vytváření názvů pro prostředek.
Identifikuje name komponentu, která prostředek spravuje.

Type:      String
Mandatory: true

-i, --input

Určuje objekt JSON nebo YAML s vlastnostmi definujícím požadovaný stav instance prostředku DSC. DSC ověří objekt proti schématu instance prostředku. Pokud se ověření nezdaří, DSC vyvolá chybu.

Tuto možnost nelze použít s vlastnostmi instance nad stdin nebo --path možností. Zvolte, jestli chcete předat vlastnosti instance příkazu přes stdin, ze souboru s --path možností nebo s --input možností .

Type:      String
Mandatory: false

-p, --path

Definuje cestu k textovému souboru, který se má číst jako vstup pro příkaz místo propojení vstupu ze stdin nebo jeho předání jako řetězce s --input možností . Zadaný soubor musí obsahovat JSON nebo YAML, které představují platné vlastnosti prostředku. DSC ověří objekt proti schématu instance prostředku. Pokud se ověření nezdaří nebo pokud zadaný soubor neexistuje, DSC vyvolá chybu.

Tato možnost se s možností vzájemně vylučuje --input . Když použijete tuto možnost, DSC ignoruje všechny vstupy ze stdin.

Type:      String
Mandatory: false

-f, --format

Možnost --format řídí formát výstupu konzoly pro příkaz. Pokud je výstup příkazu přesměrovaný nebo zachycený jako proměnná, je výstup vždy JSON.

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

-h, --help

Zobrazí nápovědu k aktuálnímu příkazu nebo dílčímu příkazu. Když zadáte tuto možnost, aplikace ignoruje všechny možnosti a argumenty za touto možností.

Type:      Boolean
Mandatory: false

Výstup

Tento příkaz vrátí výstup JSON, který obsahuje požadovaný stav instance, skutečný stav, seznam vlastností, které jsou mimo požadovaný stav, a logickou hodnotu označující, jestli je instance v požadovaném stavu. Další informace najdete v tématu schéma výsledků testu prostředků dsc.

Sdílet prostřednictvím