Freigeben über

Referenz zum DSC-Ressourcenmanifest zum Exportieren von Eigenschaftenschemas

  • Artikel

Zusammenfassung

Definiert, wie der aktuelle Status jedes instance für eine DSC-Ressource abgerufen wird.

Metadaten

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

Beschreibung

Eine befehlsbasierte DSC-Ressource, die jede instance von sich selbst mit einem einzelnen Befehl auflisten kann, sollte die -Eigenschaft in ihrem export Manifest definieren. Diese Eigenschaft definiert, wie DSC den aktuellen Zustand für jede Ressource instance abrufen kann. Wenn diese Eigenschaft definiert ist, können Benutzer:

  • Geben Sie einen instance der Ressource in der Eingabekonfiguration für den Befehl dsc config export an, um ein verwendbares Konfigurationsdokument zu generieren.
  • Geben Sie die Ressource mit dem Befehl dsc resource export an, um ein Konfigurationsdokument zu generieren, das jede instance der Ressource definiert.
  • Geben Sie die Ressource mit dem Befehl dsc resource get und der Option --all an, um den aktuellen Zustand für jede instance der Ressource zurückzugeben.

Wenn der DSC den von dieser Eigenschaft definierten Befehl aufruft, muss die Ressource den aktuellen Zustand jedes instance als JSON-Zeilen zurückgeben. Jede JSON-Zeile sollte ein Objekt sein, das die instance und anhand des definierten Ressourcen-instance-Schemas überprüft.

DSC sendet Daten auf drei Arten an diesen Befehl:

  1. Wenn input ist stdin, sendet DSC die Daten als Zeichenfolge, die die Daten als komprimiertes JSON-Objekt ohne Leerzeichen oder Zeilenlinien zwischen den Objekteigenschaften darstellt.
  2. Wenn input ist env, sendet DSC die Daten als Umgebungsvariablen. Es erstellt eine Umgebungsvariable für jede Eigenschaft im Eingabedatenobjekt, wobei der Name und der Wert der Eigenschaft verwendet werden.
  3. Wenn das args Array eine JSON-Eingabeargumentdefinition enthält, sendet DSC die Daten als Zeichenfolge, die die Daten als komprimiertes JSON-Objekt an das angegebene Argument darstellt.

Wenn Sie die input Eigenschaft nicht definieren und kein JSON-Eingabeargument definieren, kann DSC den Eingabe-JSON-Code nicht an die Ressource übergeben. Sie können nur ein JSON-Eingabeargument für einen Befehl definieren.

Sie müssen die input Eigenschaft, ein JSON-Eingabeargument im args Eigenschaftenarray oder beides definieren.

Erforderliche Eigenschaften

Die export Definition muss die folgenden Eigenschaften enthalten:

Eigenschaften

executable

Die executable -Eigenschaft definiert den Namen des auszuführenden Befehls. Der Wert muss der Name eines Befehls sein, der in der Umgebungsvariablen des PATH Systems ermittelt werden kann, oder der vollständige Pfad zum Befehl. Eine Dateierweiterung ist nur erforderlich, wenn der Befehl vom Betriebssystem nicht als ausführbare Datei erkennbar ist.

Type:     string
Required: true

args

Die args -Eigenschaft definiert die Liste der Argumente, die an den Befehl übergeben werden sollen. Die Argumente können eine beliebige Anzahl von Zeichenfolgen sein. Wenn Sie das JSON-Objekt, das den Eigenschaftenbehälter für die Ressource darstellt, an ein Argument übergeben möchten, können Sie ein einzelnes Element im Array als [JSON-Objekt] definieren und dabei den Namen des Arguments mit der jsonInputArg Zeichenfolgeneigenschaft angeben und angeben, ob das Argument für den Befehl mit der mandatory booleschen Eigenschaft obligatorisch ist.

Type:     array
Required: false
Default:  []
Type:     [string, object(JSON Input Argument)]

Zeichenfolgenargumente

Jedes Element im Argumentarray kann eine Zeichenfolge sein, die ein statisches Argument darstellt, das an den Befehl übergeben werden soll, z config . B. oder --format.

Type: string

JSON-Eingabeargument

Definiert ein Argument für den Befehl, der das JSON-Eingabeobjekt als Zeichenfolge akzeptiert. DSC übergibt die JSON-Eingabe an das benannte Argument, sofern verfügbar. Ein JSON-Eingabeargument wird als JSON-Objekt mit den folgenden Eigenschaften definiert:

  • jsonInputArg (erforderlich): Das Argument, an das die JSON-Daten für den Befehl übergeben werden sollen, z. B --input. .
  • mandatory (optional): Gibt an, ob DSC das Argument immer an den Befehl übergeben soll, auch wenn keine JSON-Eingabe für den Befehl vorhanden ist. In diesem Fall übergibt DSC eine leere Zeichenfolge an das JSON-Eingabeargument.

Sie können nur ein JSON-Eingabeargument pro Argumentarray definieren.

Wenn Sie ein JSON-Eingabeargument und eine input Art für einen Befehl definieren, sendet DSC die JSON-Daten auf beide Arten:

  • Wenn Sie als env und ein JSON-Eingabeargument definiereninput, legt DSC eine Umgebungsvariable für jede Eigenschaft in der JSON-Eingabe fest und übergibt das JSON-Eingabeobjekt als Zeichenfolge an das definierte Argument.
  • Wenn Sie als stdin und ein JSON-Eingabeargument definiereninput, übergibt DSC die JSON-Eingabe über stdin und als Zeichenfolge an das definierte Argument.
  • Wenn Sie ein JSON-Eingabeargument definieren, ohne die input -Eigenschaft zu definieren, übergibt DSC die JSON-Eingabe nur als Zeichenfolge an das definierte Argument.

Wenn Sie die input Eigenschaft nicht definieren und kein JSON-Eingabeargument definieren, kann DSC den Eingabe-JSON-Code nicht an die Ressource übergeben. Dadurch wird das Manifest ungültig. Sie müssen die input -Eigenschaft, ein JSON-Eingabeargument im args Eigenschaftenarray oder beides definieren.

Type:                object
RequiredProperties: [jsonInputArg]

input

Die input -Eigenschaft definiert, wie Eingaben an die Ressource übergeben werden. Wenn diese Eigenschaft nicht definiert ist und die Definition kein JSON-Eingabeargument definiert, sendet DSC beim Aufrufen des Vorgangs keine Eingabe an die export Ressource.

Der Wert dieser Eigenschaft muss eine der folgenden Zeichenfolgen sein:

  • env– Gibt an, dass die Ressource erwartet, dass die Eigenschaften eines instance als Umgebungsvariablen mit denselben Namen und der gleichen Groß-/Kleinschreibung angegeben werden.

    Diese Option unterstützt nur die folgenden Datentypen für instance Eigenschaften:

    • boolean
    • integer
    • number
    • string
    • array von integer Werten
    • array von number Werten
    • array von string Werten

    Für Nicht-Arraywerte legt DSC die Umgebungsvariable auf den angegebenen Wert fest. Wenn der Datentyp ein Array von Werten ist, legt DSC die Umgebungsvariable als durch Trennzeichen getrennte Zeichenfolge fest. Beispielsweise wird die Eigenschaft foo mit dem Wert von [1, 2, 3] in der foo Umgebungsvariablen als "1,2,3"gespeichert.

    Wenn die Ressource komplexe Eigenschaften mit einem object Wert oder Arrays mit mehreren Typen unterstützen muss, legen Sie stattdessen auf stdin fest.

  • stdin– Gibt an, dass die Ressource ein JSON-Blob erwartet, das eine instance von stdindarstellt. Der JSON-Code muss dem instance Schema für die Ressource entsprechen.

Type:        string
Required:    false
ValidValues: [env, stdin]