schemareferens för dsc-konfigurationstestresultat
Sammanfattning
Resultatet utdata från kommandot dsc config test
.
Metadata
SchemaDialect: https://json-schema.org/draft/2020-12/schema
SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/outputs/config/test.json
Type: object
Beskrivning
Utdata från kommandot dsc config test
innehåller tillståndet för varje resursinstans i konfigurationen före och efter teståtgärden och listan över egenskaper som åtgärden ändrade för varje instans.
Nödvändiga egenskaper
Utdata innehåller alltid följande egenskaper:
Egenskaper
metadata
Definierar metadata som DSC returnerar för en konfigurationsåtgärd. Egenskaperna under egenskapen Microsoft.DSC
beskriver åtgärdens kontext.
Type: object
Required: true
Microsoft.DSC
Metadata under den här egenskapen beskriver kontexten för den övergripande åtgärden:
- version definierar den version av DSC som körde kommandot. Det här värdet är alltid den semantiska versionen av DSC-kommandot, till exempel
3.0.0-preview.7
. - åtgärd definierar den åtgärd som DSC tillämpade på konfigurationsdokumentet:
Get
,Set
,Test
ellerExport
. - executionType definierar om DSC faktiskt tillämpade en åtgärd på konfigurationen eller kördes i
WhatIf
läge. Den här egenskapen är alltidActual
förGet
,Test
ochExport
åtgärder. FörSet
åtgärder är det här värdetWhatIf
när DSC anropas med argumentet--what-if
. - startDatetime definierar startdatum och tid för DSC-åtgärden som en tidsstämpel efter det format som definierats i RFC3339, avsnitt 5.6 (se
date-time
), som2024-04-14T08:49:51.395686600-07:00
. - endDatetime definierar slutdatum och tid för DSC-åtgärden som en tidsstämpel efter det format som definierats i RFC3339, avsnitt 5.6 (se
date-time
), som2024-04-14T08:49:51.395686600-07:00
. - varaktighet definierar varaktigheten för en DSC-åtgärd mot ett konfigurationsdokument eller en resursinstans som en sträng som följer det format som definierats i ISO8601 ABNF för
duration
. Till exempel representerarPT0.611216S
en varaktighet på cirka0.61
sekunder. - securityContext definierar säkerhetskontexten som DSC kördes under. Om värdet för den här metadataegenskapen är
Elevated
kördes DSC somroot
(icke-Windows) eller en förhöjd session med administratörsbehörighet (i Windows). Om värdet ärRestricted
kördes DSC som en normal användare eller ett normalt konto i en icke-upphöjd session.
resultat
Definierar listan med resultat för den test
åtgärd som anropas mot varje instans i konfigurationsdokumentet. Varje post i listan innehåller resursens typnamn, instansnamn och resultatdata för en instans.
Type: array
Required: true
ItemsType: object
typ
Ett objekts type
-egenskap identifierar instansens DSC-resurs med dess fullständigt kvalificerade typnamn.
Mer information om typnamn finns i DSC-resursens fullständigt kvalificerade typnamnsschemareferens.
Type: string
Required: true
Pattern: ^\w+(\.\w+){0,2}\/\w+$
Namn
Ett objekts name
-egenskap identifierar instansen med dess korta, unika, läsbara namn.
Type: string
Required: true
resultat
Ett objekts result
-egenskap innehåller valideringstillståndet för resursinstansen. Värdet för den här egenskapen följer samma schema som utdata för kommandot dsc resource test
. Mer information finns i dsc-resurstestresultatschemareferens.
Meddelanden
Definierar listan över strukturerade meddelanden som genereras av resurser under teståtgärden. Mer information finns i Schemareferens för strukturerade meddelanden.
Type: array
Required: true
hadErrors
Anger om åtgärden påträffade några fel. Det här värdet är true
om konfigurationsdokumentet misslyckades med verifieringen eller om någon resurs avslutades med en annan slutkod än 0
.
Type: boolean
Required: true