Referens för egenskapsschema för DSC-resursmanifestkort

Artikel
05/11/2024

Synopsis

Definierar en DSC-resurs som ett DSC-resurskort.

Metadata

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

Description

DSC-resurskort måste definiera adapter egenskapen i sitt manifest. Den här egenskapen identifierar resursen som ett kort och definierar hur DSC kan anropa kortet för att hämta de resurser som kortet stöder och hur du skickar resursinstanser till adaptern.

Exempel

Exempel 1 – Microsoft.DSC/PowerShell

Det här exemplet kommer från Microsoft.DSC/PowerShell DSC-resurskortet.

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

Manifestet anger config till full, vilket indikerar att adaptern förväntar sig en JSON-blob som representerar den fullständiga och obearbetade konfigurationen från stdin.

Den definierar list.executable som pwsh. De argument som definieras i list.args ser till att DSC kör PowerShell:

Utan logotypbanderollen
I icke-interaktivt läge
Utan att läsa in några profilskript
Anropa skriptet powershell.resource.ps1 i samma mapp som dsc kommandot och skicka List argumentet.

Med den här definitionen anropar list DSC metoden för det här kortet genom att köra:

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

Obligatoriska egenskaper

Definitionen adapter måste innehålla följande egenskaper:

config
list

Egenskaper

config

Egenskapen config definierar hur adaptern förväntar sig att ta emot resurskonfigurationer. Värdet måste vara något av följande alternativ:

full – Anger att adaptern förväntar sig en JSON-blob som innehåller den fullständiga och obearbetade konfigurationen som en enda JSON-blob över stdin.
sequence – Anger att adaptern förväntar sig varje resurss konfiguration som en JSON-rad över stdin.

Type:        string
ValidValues: [full, sequence]

list

Egenskapen list definierar hur adaptern anropas för att visa en lista över de resurser som stöds. Värdet för den här egenskapen måste vara ett objekt och definiera underegenskapen executable .

Type:               object
Required:           true
RequiredProperties: [executable]

Körbara

Underegenskapen executable definierar namnet på kommandot som ska köras. Värdet måste vara namnet på ett kommando som kan identifieras i systemets PATH miljövariabel eller den fullständiga sökvägen till kommandot. Ett filnamnstillägg krävs bara när kommandot inte känns igen av operativsystemet som en körbar fil.

Type:     string
Required: true

args

Underegenskapen args definierar en matris med strängar som ska skickas som argument till kommandot. DSC skickar argumenten till kommandot i den ordning de anges.

Type:     array
Required: false
Default:  []

Dela via