dsc-erőforrásteszt

Áttekintés

Meghívja egy erőforrás tesztműveletét.

Syntax

Példánytulajdonságok az stdinből

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

Példánytulajdonságok a bemeneti beállításból

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

Példánytulajdonságok fájlból

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

Description

Az test alparancs ellenőrzi egy erőforráspéldány tényleges állapotát a kívánt állapothoz.

Ez az alparancs egy adott DSC-erőforrás egy példányát teszteli. Több erőforrás teszteléséhez használjon erőforráscsoportot vagy a dsc config test parancsot.

A tesztelni kívánt példány állapotát JSON- vagy YAML-objektumként kell átadni ennek a parancsnak. Az objektumtulajdonságoknak érvényes tulajdonságoknak kell lenniük az erőforráshoz. A példánytulajdonságok átadhatók ennek a parancsnak az stdinből, a beállítással rendelkező --input sztringként vagy a beállítással --path rendelkező mentett fájlból.

Ha ez a parancs egy olyan parancsalapú DSC-erőforráshoz van meghívva, amely nem definiálja a saját tesztelési műveletet, a DSC szintetikus tesztet hajt végre. A szintetikus teszt összehasonlítja egy példány kívánt állapotának minden tulajdonságát a tényleges állapottal. A szintetikus vizsgálat szigorú, kis- és nagybetűkre érzékeny egyenértékűséget használ. Ha egy tulajdonság kívánt állapota és a tényleges állapot nem egyezik meg, a DSC a tulajdonságot a kívánt állapoton kívülre jelöli.

Ez a parancs csak két feltétel mellett ellenőrzi a példánytulajdonságokat:

1. Ha a tulajdonság explicit módon szerepel a kívánt állapotbemenetben.
2. Ha a tulajdonság alapértelmezett értékkel rendelkezik, és nem szerepel explicit módon a kívánt állapotbemenetben.

Példák

1. példa – Erőforrás tesztelése az stdin tulajdonságaival

A parancs ellenőrzi, hogy a Example kulcs megtalálható-e az aktuális felhasználói hive-ben. Az erőforráspéldány tulajdonságait JSON-ként adja meg, és az stdinből továbbítja őket.

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

2. példa – Erőforrás tesztelése a bemeneti beállítással

A parancs ellenőrzi, hogy a Example kulcs megtalálható-e az aktuális felhasználói hive-ben. JSON-ként adja meg az erőforráspéldány tulajdonságait, és átadja azokat a bemeneti beállítással.

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

3. példa – Erőforrás tesztelése YAML-fájlból származó tulajdonságokkal

A parancs ellenőrzi, hogy a Example kulcs megtalálható-e az aktuális felhasználói hive-ben. Megadja egy YAML-fájl elérési útját, amely meghatározza az erőforráspéldány tulajdonságait az elérési út beállítással.

keyPath: HKCU\\Example
_exist:  true

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

Beállítások

-r, --resource

Megadja a használni kívánt DSC-erőforrás teljes típusnevét, például Microsoft.Windows/Registry: .

A teljes típusnévszintaxis a következő: <owner>[.<group>][.<area>]/<name>, ahol:

• A owner az erőforrás karbantartó szerzője vagy szervezete.
• A group és area nem kötelező névösszetevők, amelyek lehetővé teszik az erőforrások névkészítését.
• A name azonosítja az erőforrás által kezelt összetevőt.

Type:      String
Mandatory: true

-i, --input

Egy JSON- vagy YAML-objektumot határoz meg a DSC-erőforráspéldány kívánt állapotát meghatározó tulajdonságokkal. A DSC ellenőrzi az objektumot az erőforrás példánysémája alapján. Ha az ellenőrzés sikertelen, a DSC hibát jelez.

Ez a beállítás nem használható az stdin vagy a --path beállítás feletti példánytulajdonságokkal. Adja meg, hogy a példánytulajdonságokat át szeretné-e adni az stdin parancsnak, egy beállítással rendelkező --path fájlból vagy a --input beállítással.

Type:      String
Mandatory: false

-p, --path

A parancs bemeneteként beolvasandó szövegfájl elérési útját határozza meg ahelyett, hogy a bemenetet az stdinből íratja, vagy sztringként adja át a --input beállítással. A megadott fájlnak olyan JSON-t vagy YAML-t kell tartalmaznia, amely az erőforrás érvényes tulajdonságait jelöli. A DSC ellenőrzi az objektumot az erőforrás példánysémája alapján. Ha az ellenőrzés sikertelen, vagy ha a megadott fájl nem létezik, a DSC hibát jelez.

Ez a lehetőség kölcsönösen kizárja a --input lehetőséget. Ha ezt a beállítást használja, a DSC figyelmen kívül hagyja az stdin összes bemenetét.

Type:      String
Mandatory: false

-f, --format

A --format beállítás szabályozza a parancs konzolkimeneti formátumát. Ha a parancs kimenetét átirányítja vagy változóként rögzíti, a kimenet mindig JSON lesz.

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

-h, --help

Megjeleníti az aktuális parancs vagy alparancs súgóját. Ha ezt a beállítást adja meg, az alkalmazás figyelmen kívül hagyja az összes beállítást és argumentumot ezt követően.

Type:      Boolean
Mandatory: false

Kimenet

Ez a parancs olyan JSON-kimenetet ad vissza, amely tartalmazza a példány kívánt állapotát, a tényleges állapotot, a kívánt állapoton kívüli tulajdonságok listáját, valamint egy logikai értéket, amely azt jelzi, hogy a példány a kívánt állapotban van-e. További információ: dsc erőforrásteszt eredménysémája.