Dela via

Schemareferens för dsc-resurstestresultat

  • Artikel

Synopsis

Resultatet utdata från dsc resource test kommandot .

Metadata

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

Description

Beskriver returdata för en DSC-resursinstans från dsc resource get kommandot . Returdata är antingen ett enskilt objekt som beskriver det testade tillståndet för en icke-kapslad instans eller en matris med objekt som beskriver det testade tillståndet för de kapslade instanserna för en grupp- eller kortresurs.

DSC returnerar ett enkelt testsvar när instansen inte är en gruppresurs, adapterresurs eller kapslad i en grupp- eller kortresurs.

När den hämtade instansen är för gruppresurs, nätverkskortsresurs eller kapslad i en grupp- eller kortresurs returnerar DSC ett fullständigt testresultat, som även innehåller resurstyp och instansnamn.

Enkelt testsvar

Nödvändiga egenskaper

Utdata innehåller alltid följande egenskaper:

Egenskaper

desiredState

Representerar det önskade tillståndet för resursinstansen. DSC validerar den här egenskapens värde mot resursens instansschema.

Type:     object
Required: true

actualState

Representerar det faktiska tillståndet för resursinstansen. DSC validerar den här egenskapens värde mot resursens instansschema.

Type:     object
Required: true

inDesiredState

Anger om resursinstansens egenskaper är i önskat tillstånd. Det här värdet är true om varje egenskap har önskat tillstånd och annars false.

Type:     boolean
Required: true

differentingProperties

Definierar namnen på de egenskaper som inte är i önskat tillstånd. Om det här värdet är en tom matris är instansens egenskaper i önskat tillstånd.

Type:      array
Required:  true
ItemsType: string

Fullständigt testresultat

Beskriver returdata för det fullständiga resultatet av test åtgärden för en resursinstans. Dessa data returneras:

  • För varje instans i ett konfigurationsdokument när du använder dsc config test kommandot .
  • För kapslade instanser av en grupp- eller nätverkskortresurs när du använder dsc resource test kommandot .

Nödvändiga egenskaper

Egenskaper

metadata

Definierar metadata som DSC returnerar för en konfigurationsåtgärd. Egenskaperna under Microsoft.DSC egenskapen beskriver åtgärdens kontext.

  • duration definierar varaktigheten för en DSC-åtgärd mot ett konfigurationsdokument eller en resursinstans som en sträng som följer formatet som definieras i ISO8601 ABNF för duration. Representerar till exempel PT0.611216S en varaktighet på cirka 0.61 sekunder.
Type:     object
Required: true

typ

Egenskapen type identifierar instansens DSC-resurs med dess fullständigt kvalificerade typnamn. Mer information om typnamn finns i schemareferensen för DSC-resursens fullständigt kvalificerade typnamn.

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

name

Egenskapen name identifierar instansen med dess korta, unika, läsbara namn.

Type:     string
Required: true

resultat

Egenskapen result innehåller valideringstillståndet för resursen. Det här värdet är antingen:

  • Det enkla testsvaret för instansen
  • En matris med fullständiga hämta resultatobjekt för varje kapslad instans, om resursen är en grupp- eller kortresurs.
Type: [object, array]
Required: true