Referenz zu DSC-Ressourcenmanifestadaptereigenschaften

Artikel
05/11/2024

Zusammenfassung

Definiert eine DSC-Ressource als DSC-Ressourcenadapter.

Metadaten

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

Beschreibung

DSC-Ressourcenadapter müssen die adapter Eigenschaft in ihrem Manifest definieren. Diese Eigenschaft identifiziert die Ressource als Adapter und definiert, wie DSC den Adapter aufrufen kann, um die vom Adapter unterstützten Ressourcen abzurufen und Ressourceninstanzen an den Adapter zu übergeben.

Beispiele

Beispiel 1: Microsoft.DSC/PowerShell

Dieses Beispiel stammt aus dem Microsoft.DSC/PowerShell DSC-Ressourcenadapter.

"adapter": {
  "list": {
    "executable": "pwsh",
    "args": [
      "-NoLogo",
      "-NonInteractive",
      "-NoProfile",
      "-Command",
      "./powershell.resource.ps1 List"
    ]
    },
  "config": "full"
},

Das Manifest legt auf fullfestconfig, was angibt, dass der Adapter ein JSON-Blob erwartet, das die vollständige und nicht verarbeitete Konfiguration von stdindarstellt.

Sie definiert list.executable als pwsh. Die in definierten list.args Argumente stellen sicher, dass DSC PowerShell ausführt:

Ohne Logobanner
Im nicht interaktiven Modus
Ohne Das Laden von Profilskripts
So rufen Sie das powershell.resource.ps1 Skript im selben Ordner wie der dsc Befehl auf, und übergeben Sie das List Argument.

Mit dieser Definition ruft DSC die list -Methode für diesen Adapter auf, indem folgendes ausgeführt wird:

pwsh -NoLogo -NonInteractive -NoProfile -Command "./powershellgroup.resource.ps1 List"

Erforderliche Eigenschaften

Die adapter Definition muss die folgenden Eigenschaften enthalten:

config
list

Eigenschaften

config

Die config -Eigenschaft definiert, wie der Adapter Ressourcenkonfigurationen empfängt. Der Wert muss eine der folgenden Optionen sein:

full – Gibt an, dass der Adapter ein JSON-Blob erwartet, das die vollständige und unverarbeitete Konfiguration als einzelnes JSON-Blob über stdinenthält.
sequence – Gibt an, dass der Adapter die Konfiguration jeder Ressource als JSON-Zeile über stdinerwartet.

Type:        string
ValidValues: [full, sequence]

list

Die list -Eigenschaft definiert, wie der Adapter aufgerufen wird, um die unterstützten Ressourcen aufzulisten. Der Wert dieser Eigenschaft muss ein -Objekt sein und die executable Untereigenschaft definieren.

Type:               object
Required:           true
RequiredProperties: [executable]

executable

Die executable Untereigenschaft 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 Untereigenschaft definiert ein Array von Zeichenfolgen, die als Argumente an den Befehl übergeben werden sollen. DSC übergibt die Argumente in der angegebenen Reihenfolge an den Befehl.

Type:     array
Required: false
Default:  []

Freigeben über