Dela via

Resultatschemareferens för dsc-resursuppsättning

  • Artikel

Synopsis

Resultatet utdata från dsc resource set kommandot .

Metadata

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

Description

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

DSC returnerar ett enkelt svar när instansen inte är en gruppresurs, nätverkskortsresurs 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 uppsättningsresultat, som även innehåller resurstyp och instansnamn.

Svar från enkel uppsättning

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

Nödvändiga egenskaper

Utdata innehåller alltid följande egenskaper:

Egenskaper

beforeState

Representerar tillståndet för den instans som returnerades före den angivna åtgärden. DSC validerar den här egenskapens värde mot resursens instansschema.

Type:     object
Required: true

afterState

Representerar tillståndet för den instans som returnerades efter den angivna åtgärden. DSC validerar den här egenskapens värde mot resursens instansschema.

Type:     object
Required: true

changedProperties

Definierar namnen på de egenskaper som set-åtgärden framtvingade. Om det här värdet är en tom matris har resursen inte gjort några ändringar under den angivna åtgärden.

Type:      array
Required:  true
ItemsType: string

Resultat för fullständig uppsättning

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

  • För varje instans i ett konfigurationsdokument när du använder dsc config set kommandot .
  • För kapslade instanser av en grupp- eller nätverkskortresurs när du använder dsc resource set 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 det framtvingade tillståndet för resursen. Det här värdet är antingen:

  • Det enkla set-svaret för instansen
  • En matris med resultatobjekt med fullständig uppsättning för varje kapslad instans, om resursen är en grupp- eller kortresurs.
Type: [object, array]
Required: true