Freigeben über

Referenz zum dsc-Ressourcentestergebnis

  • Artikel

Zusammenfassung

Die Ergebnisausgabe des dsc resource test Befehls.

Metadaten

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

Beschreibung

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

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

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

Einfache Testantwort

Erforderliche Eigenschaften

Die Ausgabe enthält immer die folgenden Eigenschaften:

Eigenschaften

desiredState

Stellt den gewünschten Zustand der Ressource instance dar. DSC überprüft den Wert dieser Eigenschaft anhand des instance Schemas der Ressource.

Type:     object
Required: true

actualState

Stellt den tatsächlichen Zustand der Ressource dar, die instance. DSC überprüft den Wert dieser Eigenschaft anhand des instance Schemas der Ressource.

Type:     object
Required: true

inDesiredState

Gibt an, ob sich die Eigenschaften der Ressource instance im gewünschten Zustand befinden. Dieser Wert ist true , wenn sich jede Eigenschaft im gewünschten Zustand befindet und andernfalls false.

Type:     boolean
Required: true

differingProperties

Definiert die Namen der Eigenschaften, die sich nicht im gewünschten Zustand befinden. Wenn es sich bei diesem Wert um ein leeres Array handelt, befinden sich die Eigenschaften der instance im gewünschten Zustand.

Type:      array
Required:  true
ItemsType: string

Vollständiges Testergebnis

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

  • Für jede instance in einem Konfigurationsdokument, wenn Sie den dsc config test Befehl verwenden.
  • Für geschachtelte Instanzen einer Gruppe oder Adapterressource, wenn Sie den dsc resource test 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 Validierungszustand für die Ressource. Dieser Wert ist entweder:

  • Die einfache Testantwort 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