Sdílet prostřednictvím


Referenční informace ke schématu výsledků sady prostředků dsc

Synopse

Výstup výsledku dsc resource set z příkazu .

Metadata

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

Description

Popisuje návratová data pro instanci prostředku DSC z dsc resource set příkazu . Vrácená data jsou buď jeden objekt, který popisuje vynucený stav vnořené instance, nebo pole objektů, které popisují vynucený stav vnořených instancí pro prostředek skupiny nebo adaptéru.

Pokud instance není prostředkem skupiny, prostředkem adaptéru nebo vnořeným do skupiny nebo prostředku adaptéru, vrátí DSC odpověď na jednoduchou sadu .

Pokud je načtená instance určená pro prostředek skupiny, prostředek adaptéru nebo vnořená do prostředku skupiny nebo adaptéru, vrátí DSC výsledek úplné sady, která obsahuje také typ prostředku a název instance.

Odpověď na jednoduchou sadu

Popisuje návratová data pro instanci prostředku DSC z dsc resource set příkazu . Vrácená data jsou buď jeden objekt, který popisuje vynucený stav vnořené instance, nebo pole objektů, které popisují vynucený stav vnořených instancí pro prostředek skupiny nebo adaptéru.

Požadované vlastnosti

Výstup vždy obsahuje tyto vlastnosti:

Vlastnosti

beforeState

Představuje stav instance vrácené před operací set. DSC ověří hodnotu této vlastnosti ve schématu instance prostředku.

Type:     object
Required: true

afterState

Představuje stav instance vrácené po operaci nastavení. DSC ověří hodnotu této vlastnosti ve schématu instance prostředku.

Type:     object
Required: true

změněné vlastnosti

Definuje názvy vlastností vynucených operací nastavení. Pokud je tato hodnota prázdné pole, prostředek během operace nastavení neprodělá žádné změny.

Type:      array
Required:  true
ItemsType: string

Výsledek celé sady

Popisuje vrácená data pro úplný výsledek set operace pro instanci prostředku. Vrátí se tato data:

  • Pro každou instanci v konfiguračním dokumentu při použití dsc config set příkazu .
  • Pro vnořené instance prostředku skupiny nebo adaptéru dsc resource set při použití příkazu .

Požadované vlastnosti

Vlastnosti

zprostředkovatele identity

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

  • duration definuje dobu trvání operace DSC pro konfigurační dokument nebo instanci prostředku jako řetězec následující ve formátu definovaném v ISO8601 ABNF pro duration. PT0.611216S Například představuje dobu trvání přibližně 0.61 v sekundách.
Type:     object
Required: true

typ

Vlastnost type identifikuje prostředek DSC instance podle plně kvalifikovaného názvu typu. Další informace o názvech typů najdete v tématu Odkaz na schéma plně kvalifikovaného názvu typu prostředku DSC.

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

name

Vlastnost name identifikuje instanci jejím krátkým, jedinečným názvem, který je čitelný pro člověka.

Type:     string
Required: true

result

Vlastnost result zahrnuje vynucený stav prostředku. Tato hodnota je:

  • Odpověď na jednoduchou sadu pro instanci
  • Pole objektů výsledků úplné sady pro každou vnořenou instanci, pokud je prostředek skupiny nebo adaptéru.
Type: [object, array]
Required: true