Sdílet prostřednictvím


Referenční dokumentace schématu výsledků testu konfigurace dsc

Přehled

Výstup výsledku z příkazu dsc config test.

Metadata

SchemaDialect: https://json-schema.org/draft/2020-12/schema
SchemaID:      https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/outputs/config/test.json
Type:          object

Popis

Výstup příkazu dsc config test zahrnuje stav každé instance prostředku v konfiguraci před a po testovací operaci a seznam vlastností, které se operace změnila pro každou instanci.

Požadované vlastnosti

Výstup vždy obsahuje tyto vlastnosti:

Vlastnosti

metadata

Definuje vrácení DSC metadat pro operaci konfigurace. Vlastnosti pod vlastností Microsoft.DSC popisují kontext operace.

Type:     object
Required: true

Microsoft.DSC

Metadata pod touto vlastností popisují kontext celkové operace:

  • verze definuje verzi DSC, která příkaz spustila. Tato hodnota je vždy sémantická verze příkazu DSC, jako je 3.0.0-preview.7.
  • operace definuje operaci, kterou DSC použil v konfiguračním dokumentu: Get, Set, Testnebo Export.
  • executionType definuje, jestli DSC skutečně použila operaci na konfiguraci nebo byla spuštěna v režimu WhatIf. Tato vlastnost je vždy Actual pro operace Get, Testa Export. U operací Set je tato hodnota WhatIf při vyvolání DSC s argumentem --what-if.
  • startDatetime definuje počáteční datum a čas operace DSC jako časové razítko podle formátu definovaného v RFC3339 oddílu 5.6 (viz date-time), například 2024-04-14T08:49:51.395686600-07:00.
  • endDatetime definuje koncové datum a čas operace DSC jako časové razítko podle formátu definovaného v RFC3339 oddílu 5.6 (viz date-time), například 2024-04-14T08:49:51.395686600-07:00.
  • doba trvání definuje dobu trvání operace DSC pro konfigurační dokument nebo instanci prostředku jako řetězec za formátem definovaným v ISO8601 ABNF pro duration. Například PT0.611216S představuje dobu trvání přibližně 0.61 sekund.
  • securityContext definuje kontext zabezpečení, pod kterým bylo spuštěno DSC. Pokud je hodnota této vlastnosti metadat Elevated, DSC se spustila jako root (mimo Windows) nebo zvýšená relace s oprávněními správce (ve Windows). Pokud je hodnota Restricted, DSC byl spuštěn jako normální uživatel nebo účet v relaci bez zvýšených oprávnění.

výsledky

Definuje seznam výsledků pro operaci test vyvolanou pro každou instanci v dokumentu konfigurace. Každá položka v seznamu obsahuje název typu prostředku, název instance a výsledná data instance.

Type:      array
Required:  true
ItemsType: object

typ

Vlastnost type položky identifikuje prostředek DSC instance plně kvalifikovaným názvem typu. Další informace o názvech typů naleznete v tématu DSC Resource plně kvalifikovaný odkaz na schéma názvů typů.

Type:     string
Required: true
Pattern:  ^\w+(\.\w+){0,2}\/\w+$

Jméno

Vlastnost name položky identifikuje instanci krátkým, jedinečným názvem čitelným pro člověka.

Type:     string
Required: true

výsledek

Vlastnost result položky zahrnuje stav ověření instance prostředku. Hodnota této vlastnosti dodržuje stejné schéma jako výstup příkazu dsc resource test. Další informace najdete v tématu referenční informace o schématu výsledků testu prostředku dsc.

zprávy

Definuje seznam strukturovaných zpráv vygenerovaných prostředky během testovací operace. Další informace naleznete v tématu referenční informace ke schématu strukturovaných zpráv.

Type:     array
Required: true

hadErrors

Určuje, jestli operace zjistila nějaké chyby. Tato hodnota je true, pokud dokument konfigurace selhal ověřením nebo jakýkoli prostředek ukončil s jiným ukončovacím kódem než 0.

Type:     boolean
Required: true