dsc-konfigurationstest

Sammanfattning

Verifierar om resursinstanserna i ett konfigurationsdokument är i önskat tillstånd.

Syntax

Konfigurationsdokument från fil

dsc config test [Options] --file <FILE>

Konfigurationsdokument från alternativsträng

dsc config test [Options] --input <INPUT>

Konfigurationsdokument från stdin

cat <FILE> | dsc config test [Options] --file -

Konfigurationsdokument från fil med parametrar från stdin

cat <PARAMETERS_FILE> | dsc config --parameters-file - test [Options] --file <FILE>

Konfigurationsdokument från alternativsträng med parametrar från stdin

cat <PARAMETERS_FILE> | dsc config --parameters-file - test [Options] --input <INPUT>

Beskrivning

Underkommandot test verifierar om resursinstanserna i ett konfigurationsdokument är i önskat tillstånd. När det här kommandot körs verifierar DSC konfigurationsdokumentet innan teståtgärden anropas för varje resursinstans som definierats i dokumentet.

Konfigurationsdokumentet måste skickas till det här kommandot som JSON eller YAML med --input alternativet or --file .

Exempel

Exempel 1 – Testa om en konfigurations resursinstanser är i önskat tillstånd

Kommandot returnerar status, önskat tillstånd, faktiskt tillstånd och olika egenskaper för de resursinstanser som definierats i konfigurationsdokumentet som sparats som example.dsc.config.yaml. Den skickar konfigurationsdokumentet till kommandot från stdin med hjälp av --file alternativet .

# example.dsc.config.yaml
$schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
resources:
- name: Windows only
  type: Microsoft.DSC/Assertion
  properties:
    $schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
    resources:
    - name: os
      type: Microsoft/OSInfo
      properties:
        family: Windows
- name: Current user registry example
  type: Microsoft.Windows/Registry
  properties:
    keyPath: HKCU\example
    _exist: true
  dependsOn:
    - "[resourceId('Microsoft.DSC/Assertion', 'Windows only')"

cat ./example.dsc.config.yaml | dsc config test --file -

Exempel 2 – Skicka en fil som ska läsas som konfigurationsdokument

Kommandot använder alternativet --file för att verifiera konfigurationen som definierats i example.dsc.config.yaml filen.

dsc config test --file ./example.dsc.config.yaml

Exempel 3 – Skicka ett konfigurationsdokument som en variabel

Kommandot använder alternativet --input för att verifiera konfigurationen som lagras i variabeln $desired .

dsc config test --input $desired

Alternativ

-i, --input

Anger det konfigurationsdokument som valideringstillståndet ska verifieras för.

Dokumentet måste vara en sträng som innehåller ett JSON- eller YAML-objekt. DSC validerar dokumentet mot schemat för konfigurationsdokumentet. Om verifieringen misslyckas genererar DSC ett fel.

Det här alternativet är ömsesidigt uteslutande med alternativet --file .

Type        : string
Mandatory   : false
LongSyntax  : --input <INPUT>
ShortSyntax : -i <INPUT>

-f, --fil

Definierar sökvägen till ett konfigurationsdokument som valideringstillståndet ska verifieras för.

Den angivna filen måste innehålla ett konfigurationsdokument som ett JSON- eller YAML-objekt. DSC validerar dokumentet mot schemat för konfigurationsdokumentet. Om verifieringen misslyckas, eller om den angivna filen inte finns, genererar DSC ett fel.

Du kan också använda det här alternativet för att skicka ett konfigurationsdokument från stdin, som du ser i exempel 1.

Det här alternativet är ömsesidigt uteslutande med alternativet --input .

Type        : string
Mandatory   : false
LongSyntax  : --file <FILE>
ShortSyntax : -f <FILE>

-o, --utdata-format

Alternativet --output-format styr vilket format DSC använder för de data som kommandot returnerar. De tillgängliga formaten är:

• json för att generera data som en JSON-linje.
• pretty-json för att generera data som JSON med nya rader, indrag och mellanslag för läsbarhet.
• yaml för att generera data som YAML.

Standardutdataformatet beror på om DSC upptäcker att utdata omdirigeras eller avbildas som en variabel:

• Om kommandot inte omdirigeras eller avbildas visar DSC utdata som formatet yaml i konsolen.
• Om kommandoutdata omdirigeras eller avbildas genererar DSC data som formatet json till stdout.

När du använder det här alternativet använder DSC det angivna formatet oavsett om kommandot omdirigeras eller avbildas.

När kommandot inte omdirigeras eller avbildas formateras utdata i konsolen för bättre läsbarhet. När kommandot inte omdirigeras eller avbildas innehåller utdata terminalsekvenser för formatering.

Type        : string
Mandatory   : false
ValidValues : [json, pretty-json, yaml]
LongSyntax  : --output-format <OUTPUT_FORMAT>
ShortSyntax : -o <OUTPUT_FORMAT>

-h, --hjälp

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

Type        : boolean
Mandatory   : false
LongSyntax  : --help
ShortSyntax : -h

Utgång

Det här kommandot returnerar formaterade data som innehåller om åtgärden eller några resurser utlöste några fel, samlingen av meddelanden som genereras under åtgärden och teståtgärdsresultaten för varje instans. Mer information finns i schemat för dsc-konfigurationstest.

Mer information om formateringen av utdata finns i flaggan --output-format.