Dela via

dsc-resurs hämta resultatschemareferens

  • Artikel

Synopsis

Resultatet utdata från dsc resource get kommandot.

Metadata

SchemaDialect: https://json-schema.org/draft/2020-12/schema
SchemaID:      https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/outputs/resource/get.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 faktiska tillståndet för en icke-kapslad instans eller en matris med objekt som beskriver det faktiska tillståndet för de kapslade instanserna för en grupp- eller kortresurs.

DSC returnerar ett enkelt get-svar 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 get-resultat, som även innehåller resurstypen och instansnamnet.

Enkelt att hämta svar

Beskriver returdata för en enda DSC-resursinstans från dsc resource get kommandot . Dessa data returneras för instanser som inte är gruppresurser, kortresurser eller kapslade i en grupp- eller kortresurs.

Nödvändiga egenskaper

Utdata innehåller alltid följande egenskaper:

Egenskaper

actualState

Egenskapen actualState innehåller alltid tillståndet för den instans som returneras när DSC anropar resursens get-åtgärd. DSC validerar den här egenskapens värde mot resursens instansschema.

Type:     object
Required: true

Fullständigt hämta resultat

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

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

  • Det enkla get-svaret 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