Referencia del esquema de propiedades del adaptador de manifiesto de recursos de DSC

Sinopsis

Define un recurso de DSC como adaptador de recursos de DSC.

Metadatos

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

Descripción

Los adaptadores de recursos de DSC deben definir la adapter propiedad en su manifiesto. Esta propiedad identifica el recurso como un adaptador y define cómo DSC puede llamar al adaptador para obtener los recursos que admite el adaptador y cómo pasar instancias de recursos al adaptador.

Ejemplos

Ejemplo 1: Microsoft.DSC/PowerShell

Este ejemplo procede del Microsoft.DSC/PowerShell adaptador de recursos de DSC.

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

El manifiesto establece config en full, que indica que el adaptador espera un blob JSON que representa la configuración completa y sin procesar de stdin.

list.executable Define como pwsh. Los argumentos definidos en list.args asegúrese de que DSC ejecuta PowerShell:

• Sin el banner del logotipo
• En modo no interactivo
• Sin cargar ningún script de perfil
• Para invocar el powershell.resource.ps1 script en la misma carpeta que el dsc comando y pasar el List argumento .

Con esta definición, DSC llama al list método para este adaptador mediante la ejecución de:

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

Propiedades obligatorias

La adapter definición debe incluir estas propiedades:

• config
• list

Propiedades

config

La config propiedad define cómo el adaptador espera recibir configuraciones de recursos. El valor debe ser una de las siguientes opciones:

• full : indica que el adaptador espera un blob JSON que contiene la configuración completa y sin procesar como un único blob JSON sobre stdin.
• sequence : indica que el adaptador espera la configuración de cada recurso como una línea JSON a través stdinde .

Type:        string
ValidValues: [full, sequence]

list

La list propiedad define cómo llamar al adaptador para enumerar los recursos que admite. El valor de esta propiedad debe ser un objeto y definir la executable subproperción.

Type:               object
Required:           true
RequiredProperties: [executable]

ejecutable

La executable subpropeta define el nombre del comando que se va a ejecutar. El valor debe ser el nombre de un comando detectable en la variable de entorno del PATH sistema o la ruta de acceso completa al comando. Una extensión de archivo solo es necesaria cuando el sistema operativo no reconoce el comando como ejecutable.

Type:     string
Required: true

args

La args subpropeta define una matriz de cadenas que se van a pasar como argumentos al comando. DSC pasa los argumentos al comando en el orden en que se especifican.

Type:     array
Required: false
Default:  []