dsc-resurstest

Synopsis

Anropar teståtgärden för en resurs.

Syntax

Instansegenskaper från stdin

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

Instansegenskaper från indataalternativet

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

Instansegenskaper från fil

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

Description

Underkommandot test validerar det faktiska tillståndet för en resursinstans mot önskat tillstånd.

Den här underkommandot testar en instans av en specifik DSC-resurs. Om du vill testa flera resurser använder du en resursgrupp eller kommandot dsc config test .

Det önskade tillståndet för den instans som ska testas måste skickas till det här kommandot som ett JSON- eller YAML-objekt. Objektegenskaperna måste vara giltiga egenskaper för resursen. Instansegenskaperna kan skickas till det här kommandot från stdin, som en sträng med --input alternativet eller från en sparad fil med alternativet --path .

Om det här kommandot anropas för en kommandobaserad DSC-resurs som inte definierar en egen teståtgärd utför DSC ett syntetiskt test. Det syntetiska testet jämför varje egenskap för önskat tillstånd för en instans mot det faktiska tillståndet. Det syntetiska testet använder strikt, skiftlägeskänslig ekvivalens. Om det önskade tillståndet för en egenskap och det faktiska tillståndet inte är detsamma markerar DSC egenskapen som ur önskat tillstånd.

Det här kommandot validerar endast instansegenskaper under två villkor:

1. När egenskapen uttryckligen ingår i önskade tillståndsindata.
2. När egenskapen har ett standardvärde och inte uttryckligen ingår i önskade tillståndsindata.

Exempel

Exempel 1 – Testa en resurs med egenskaper från stdin

Kommandot testar om Example nyckeln finns i den aktuella användardatafilen. Den anger egenskaperna för resursinstansen som JSON och skickar dem från stdin.

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

Exempel 2 – Testa en resurs med indataalternativet

Kommandot testar om Example nyckeln finns i den aktuella användardatafilen. Den anger egenskaperna för resursinstansen som JSON och skickar dem med indataalternativet .

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

Exempel 3 – Testa en resurs med egenskaper från en YAML-fil

Kommandot testar om Example nyckeln finns i den aktuella användardatafilen. Den anger sökvägen till en YAML-fil som definierar resursinstansegenskaperna med sökvägsalternativet .

keyPath: HKCU\\Example
_exist:  true

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

Alternativ

-r, --resource

Anger det fullständigt kvalificerade typnamnet för DSC-resursen som ska användas, till exempel Microsoft.Windows/Registry.

Den fullständigt kvalificerade typnamnsyntaxen är: <owner>[.<group>][.<area>]/<name>, där:

• owner är den underhållna författaren eller organisationen för resursen.
• group Och area är valfria namnkomponenter som aktiverar namnavstånd för en resurs.
• name Identifierar komponenten som resursen hanterar.

Type:      String
Mandatory: true

-i, --input

Anger ett JSON- eller YAML-objekt med egenskaperna som definierar önskat tillstånd för en DSC-resursinstans. DSC validerar objektet mot resursens instansschema. Om verifieringen misslyckas genererar DSC ett fel.

Det här alternativet kan inte användas med instansegenskaper över stdin eller alternativet --path . Välj om instansegenskaperna ska skickas till kommandot över stdin, från en fil med --path alternativet eller med --input alternativet .

Type:      String
Mandatory: false

-p, --path

Definierar sökvägen till en textfil som ska läsas som indata för kommandot i stället för att skicka indata från stdin eller skicka den som en sträng med --input alternativet . Den angivna filen måste innehålla JSON eller YAML som representerar giltiga egenskaper för resursen. DSC validerar objektet mot resursens instansschema. Om verifieringen misslyckas, eller om den angivna filen inte finns, genererar DSC ett fel.

Det här alternativet är ömsesidigt uteslutande med alternativet --input . När du använder det här alternativet ignorerar DSC alla indata från stdin.

Type:      String
Mandatory: false

-f, --format

Alternativet --format styr konsolens utdataformat för kommandot. Om kommandoutdata omdirigeras eller avbildas som en variabel är utdata alltid JSON.

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

-h, --help

Visar hjälpen för det aktuella kommandot eller underkommandot. När du anger det här alternativet ignorerar programmet alla alternativ och argument efter det här alternativet.

Type:      Boolean
Mandatory: false

Utdata

Det här kommandot returnerar JSON-utdata som innehåller önskat tillstånd för instansen, det faktiska tillståndet, listan över egenskaper som inte har önskat tillstånd och ett booleskt värde som anger om instansen är i önskat tillstånd. Mer information finns i DSC-resurstestresultatschemat.