Freigeben über

Referenz zum Ergebnisschema des dsc-Ressourcensatzes

  • Artikel

Zusammenfassung

Die Ergebnisausgabe des dsc resource set Befehls.

Metadaten

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

Beschreibung

Beschreibt die Rückgabedaten für eine DSC-Ressource instance aus dem dsc resource set Befehl. Die Rückgabedaten sind entweder ein einzelnes Objekt, das den erzwungenen Zustand eines nicht geschachtelten instance beschreibt, oder ein Array von Objekten, die den erzwungenen Zustand der geschachtelten Instanzen für eine Gruppe oder Adapterressource beschreiben.

DSC gibt eine einfache Setantwort zurück, wenn der instance keine Gruppenressource, Keine Adapterressource oder geschachtelt in einer Gruppe oder Adapterressource ist.

Wenn die abgerufene instance für eine Gruppenressource, adapterressource oder in einer Gruppe oder Adapterressource geschachtelt ist, gibt DSC ein vollständiges Setergebnis zurück, das auch den Ressourcentyp und instance Namen enthält.

Einfaches Festlegen der Antwort

Beschreibt die Rückgabedaten für eine DSC-Ressource instance aus dem dsc resource set Befehl. Die Rückgabedaten sind entweder ein einzelnes Objekt, das den erzwungenen Zustand eines nicht geschachtelten instance beschreibt, oder ein Array von Objekten, die den erzwungenen Zustand der geschachtelten Instanzen für eine Gruppe oder Adapterressource beschreiben.

Erforderliche Eigenschaften

Die Ausgabe enthält immer die folgenden Eigenschaften:

Eigenschaften

beforeState

Stellt den Zustand des instance dar, der vor dem Setvorgang zurückgegeben wurde. DSC überprüft den Wert dieser Eigenschaft anhand des instance Schemas der Ressource.

Type:     object
Required: true

afterState

Stellt den Zustand des nach dem Setvorgang zurückgegebenen instance dar. DSC überprüft den Wert dieser Eigenschaft anhand des instance Schemas der Ressource.

Type:     object
Required: true

changedProperties

Definiert die Namen der Eigenschaften, die der Setvorgang erzwungen hat. Wenn es sich bei diesem Wert um ein leeres Array handelt, hat die Ressource während des Setvorgangs keine Änderungen vorgenommen.

Type:      array
Required:  true
ItemsType: string

Ergebnis des vollständigen Sets

Beschreibt die Rückgabedaten für das vollständige Ergebnis des set Vorgangs für eine Ressource instance. Diese Daten werden zurückgegeben:

  • Für jede instance in einem Konfigurationsdokument, wenn Sie den dsc config set Befehl verwenden.
  • Für geschachtelte Instanzen einer Gruppe oder Adapterressource, wenn Sie den dsc resource set Befehl verwenden.

Erforderliche Eigenschaften

Eigenschaften

metadata

Definiert Metadaten, die DSC für einen Konfigurationsvorgang zurückgibt. Die Eigenschaften unter der Microsoft.DSC -Eigenschaft beschreiben den Kontext des Vorgangs.

  • duration definiert die Dauer eines DSC-Vorgangs für ein Konfigurationsdokument oder eine Ressource instance als Zeichenfolge, die dem in ISO8601 ABNF für durationdefinierten Format folgt. Stellt beispielsweise PT0.611216S eine Dauer von etwa 0.61 Sekunden dar.
Type:     object
Required: true

Typ

Die type -Eigenschaft identifiziert die DSC-Ressource des instance anhand des vollqualifizierten Typnamens. Weitere Informationen zu Typnamen finden Sie unter Vollständig qualifizierte DSC-Ressourcentypnamensschemareferenz.

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

name

Die name Eigenschaft identifiziert die instance anhand ihres kurzen, eindeutigen, lesbaren Namens.

Type:     string
Required: true

result

Die result -Eigenschaft enthält den erzwungenen Zustand für die Ressource. Dieser Wert ist entweder:

  • Die einfache Setantwort für die instance
  • Ein Array von vollständigen Ergebnisobjekten für jede geschachtelte instance, wenn es sich bei der Ressource um eine Gruppen- oder Adapterressource handelt.
Type: [object, array]
Required: true