Test konfiguracji DSC

Streszczenie

Sprawdza, czy wystąpienia zasobów w dokumencie konfiguracji są w żądanym stanie.

Składnia

Dokument konfiguracyjny z pliku

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

Dokument konfiguracyjny z ciągu opcji

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

Dokument konfiguracyjny ze standardowego standardu

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

Dokument konfiguracyjny z pliku z parametrami ze standardowego wejścia

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

Dokument konfiguracyjny z ciągu opcji z parametrami ze standardowego wejścia

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

Opis

Podpolecenie test sprawdza, czy wystąpienia zasobów w dokumencie konfiguracji są w żądanym stanie. Po uruchomieniu tego polecenia DSC weryfikuje dokument konfiguracji przed wywołaniem operacji testowej dla każdego wystąpienia zasobu zdefiniowanego w dokumencie.

Dokument konfiguracji musi zostać przekazany do tego polecenia jako JSON lub YAML z --input opcją or --file .

Przykłady

Przykład 1 — Sprawdzanie, czy wystąpienia zasobów konfiguracji są w żądanym stanie

Polecenie zwraca status, żądany stan, stan rzeczywisty i różne właściwości dla instancji zasobów zdefiniowanych w dokumencie konfiguracyjnym zapisanym jako example.dsc.config.yaml. Przekazuje dokument konfiguracyjny do polecenia ze standardowego wejścia za pomocą --file opcji.

# 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 -

Przykład 2 — przekazywanie pliku do odczytu jako dokumentu konfiguracyjnego

Polecenie używa --file opcji do sprawdzania poprawności konfiguracji zdefiniowanej example.dsc.config.yaml w pliku.

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

Przykład 3 — przekazywanie dokumentu konfiguracyjnego jako zmiennej

Polecenie używa --input opcji do sprawdzania poprawności konfiguracji przechowywanej w $desired zmiennej.

dsc config test --input $desired

Opcje

-i, --input

Określa dokument konfiguracyjny, dla którego ma zostać zweryfikowany stan.

Dokument musi być ciągiem zawierającym obiekt JSON lub YAML. Konfiguracja DSC weryfikuje dokument względem schematu dokumentu konfiguracji. Jeśli walidacja zakończy się niepowodzeniem, DSC zgłasza błąd.

Ta opcja wzajemnie się wyklucza z --file opcją.

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

-f, --file

Definiuje ścieżkę do dokumentu konfiguracyjnego, dla którego ma zostać zweryfikowany stan.

Określony plik musi zawierać dokument konfiguracyjny jako obiekt JSON lub YAML. Konfiguracja DSC weryfikuje dokument względem schematu dokumentu konfiguracji. Jeśli walidacja zakończy się niepowodzeniem lub jeśli określony plik nie istnieje, DSC zgłasza błąd.

Możesz również użyć tej opcji, aby przekazać dokument konfiguracji ze standardowego wejścia, jak pokazano w przykładzie 1.

Ta opcja wzajemnie się wyklucza z --input opcją.

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

-o, --format-wyjściowy

Opcja --output-format określa, który format DSC jest używany dla danych zwracanych przez polecenie. Dostępne formaty to:

• json , aby wyemitować dane jako wiersz JSON.
• pretty-json , aby wyemitować dane w formacie JSON ze znakami nowej linii, wcięciami i spacjami w celu zapewnienia czytelności.
• yaml , aby wyemitować dane jako YAML.

Domyślny format danych wyjściowych zależy od tego, czy DSC wykryje, że dane wyjściowe są przekierowywane, czy przechwytywane jako zmienna:

• Jeśli polecenie nie jest przekierowywane ani przechwytywane, DSC wyświetla dane wyjściowe jako yaml format w konsoli programu.
• Jeśli dane wyjściowe polecenia są przekierowywane lub przechwytywane, DSC emituje dane jako json format do stdout.

W przypadku korzystania z tej opcji DSC używa określonego formatu niezależnie od tego, czy polecenie jest przekierowywane, czy przechwytywane.

Gdy polecenie nie jest przekierowywane ani przechwytywane, dane wyjściowe w konsoli są formatowane w celu zwiększenia czytelności. Gdy polecenie nie jest przekierowywane ani przechwytywane, dane wyjściowe zawierają sekwencje terminali do formatowania.

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

-h, --help (pomoc)

Wyświetla pomoc dla bieżącego polecenia lub podpolecenia. Po określeniu tej opcji aplikacja ignoruje wszystkie inne opcje i argumenty.

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

Wynik

To polecenie zwraca sformatowane dane, które obejmują informacje o tym, czy operacja lub zasoby zgłosiły błędy, kolekcję komunikatów emitowanych podczas operacji oraz wyniki operacji testowej dla każdego wystąpienia. Aby uzyskać więcej informacji, zobacz schemat wyników testu konfiguracji dsc .

Aby uzyskać więcej informacji na temat formatowania danych wyjściowych, zobacz opcję --output-format .