Freigeben über

dsc config set result schema reference

  • Artikel

Zusammenfassung

Die Ergebnisausgabe des Befehls dsc config set.

Metadaten

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

Beschreibung

Die Ausgabe des Befehls dsc config set enthält den Status jeder Ressourceninstanz in der Konfiguration vor und nach dem Setvorgang sowie die Liste der Eigenschaften, die der Vorgang für jede Instanz geändert hat.

Erforderliche Eigenschaften

Die Ausgabe enthält immer die folgenden Eigenschaften:

Eigenschaften

Metadaten

Definiert metadaten-DSC-Rückgaben für einen Konfigurationsvorgang. Die Eigenschaften unter der Microsoft.DSC-Eigenschaft beschreiben den Kontext des Vorgangs.

Type:     object
Required: true

Microsoft.DSC

Die Metadaten unter dieser Eigenschaft beschreiben den Kontext des Gesamtvorgangs:

  • Version definiert die Version von DSC, die den Befehl ausgeführt hat. Dieser Wert ist immer die semantische Version des DSC-Befehls, z. B. 3.0.0-preview.7.
  • Vorgang definiert den Vorgang, den DSC auf das Konfigurationsdokument angewendet hat: Get, Set, Testoder Export.
  • executionType definiert, ob DSC tatsächlich einen Vorgang auf die Konfiguration angewendet oder im WhatIf Modus ausgeführt wurde. Diese Eigenschaft wird für Get-, Test- und Export Vorgänge immer Actual. Bei Set Vorgängen wird dieser Wert WhatIf, wenn DSC mit dem argument --what-if aufgerufen wird.
  • startDatetime- definiert das Startdatum und die Startzeit für den DSC-Vorgang als Zeitstempel nach dem in RFC3339 definierten Format, Abschnitt 5.6 (siehe date-time), z. B. 2024-04-14T08:49:51.395686600-07:00.
  • endDatetime- definiert das Enddatum und die Endzeit für den DSC-Vorgang als Zeitstempel nach dem in RFC3339 definierten Format, Abschnitt 5.6 (siehe date-time), z. B. 2024-04-14T08:49:51.395686600-07:00.
  • Dauer definiert die Dauer eines DSC-Vorgangs für ein Konfigurationsdokument oder eine Ressourceninstanz als Zeichenfolge nach dem in ISO8601 ABNF für durationdefinierten Format. Beispielsweise stellt PT0.611216S eine Dauer von etwa 0.61 Sekunden dar.
  • securityContext- definiert den Sicherheitskontext, unter dem DSC ausgeführt wurde. Wenn der Wert für diese Metadateneigenschaft Elevatedist, wurde DSC als root (ohne Windows) oder eine Sitzung mit erhöhten Rechten (unter Windows) ausgeführt. Wenn der Wert Restrictedist, wurde DSC als normaler Benutzer oder Konto in einer Sitzung mit erhöhten Rechten ausgeführt.

Befund

Definiert die Liste der Ergebnisse für den set Vorgang, der für jede Instanz im Konfigurationsdokument aufgerufen wird. Jeder Eintrag in der Liste enthält den Typnamen, den Instanznamen und die Ergebnisdaten für eine Instanz.

Type:      array
Required:  true
ItemsType: object

Art

Die type Eigenschaft eines Elements identifiziert die DSC-Ressource der Instanz anhand des vollqualifizierten Typnamens. Weitere Informationen zu Typnamen finden Sie unter DSC Resource fully qualified type name schema reference.

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

Name

Die name-Eigenschaft eines Elements identifiziert die Instanz anhand des kurzen, eindeutigen, menschlichen Namens.

Type:     string
Required: true

Ergebnis

Die result Eigenschaft eines Elements enthält den erzwungenen Zustand für die Ressourceninstanz. Der Wert für diese Eigenschaft entspricht demselben Schema wie die Ausgabe für den Befehl dsc resource set. Weitere Informationen finden Sie unter dsc resource set result schema reference.

Meldungen

Definiert die Liste der strukturierten Nachrichten, die während des festgelegten Vorgangs von Ressourcen ausgegeben werden. Weitere Informationen finden Sie unter Strukturierte Nachrichtenschemareferenz.

Type:     array
Required: true

hadErrors

Gibt an, ob bei dem Vorgang Fehler aufgetreten sind. Dieser Wert wird true, wenn die Überprüfung des Konfigurationsdokuments fehlgeschlagen ist oder eine Ressource mit einem anderen Ausgangscode als 0beendet wurde.

Type:     boolean
Required: true