Referência de esquema de propriedade do adaptador de manifesto do recurso DSC

Artigo
05/11/2024

Sinopse

Define um recurso DSC como um adaptador de recurso DSC.

Metadados

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

Descrição

Os Adaptadores de Recursos DSC devem definir a adapter propriedade em seu manifesto. Essa propriedade identifica o recurso como um adaptador e define como o DSC pode chamar o adaptador para obter os recursos aos quais o adaptador dá suporte e como passar instâncias de recurso para o adaptador.

Exemplos

Exemplo 1 – Microsoft.DSC/PowerShell

Este exemplo é do Microsoft.DSC/PowerShell Adaptador de Recurso DSC.

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

O manifesto define config como full, indicando que o adaptador espera um blob JSON que representa a configuração completa e não processada de stdin.

Ele define list.executable como pwsh. Os argumentos definidos em list.args garantem que o DSC execute o PowerShell:

Sem a faixa do logotipo
No modo não interativo
Sem carregar nenhum script de perfil
Para invocar o powershell.resource.ps1 script na mesma pasta que o dsc comando e passar o List argumento .

Com essa definição, a DSC chama o list método para esse adaptador executando:

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

Propriedades obrigatórias

A adapter definição deve incluir estas propriedades:

config
list

Propriedades

config

A config propriedade define como o adaptador espera receber configurações de recursos. O valor deve ser uma das seguintes opções:

full – Indica que o adaptador espera um blob JSON que contém a configuração completa e não processada como um único blob JSON sobre stdin.
sequence – Indica que o adaptador espera a configuração de cada recurso como uma linha JSON sobre stdin.

Type:        string
ValidValues: [full, sequence]

list

A list propriedade define como chamar o adaptador para listar os recursos aos quais ele dá suporte. O valor dessa propriedade deve ser um objeto e definir a executable subpropósima.

Type:               object
Required:           true
RequiredProperties: [executable]

executável

A executable subpropósia define o nome do comando a ser executado. O valor deve ser o nome de um comando detectável na variável de ambiente do PATH sistema ou o caminho completo para o comando. Uma extensão de arquivo só é necessária quando o comando não é reconhecível pelo sistema operacional como um executável.

Type:     string
Required: true

args

A args subpropósia define uma matriz de cadeias de caracteres a serem passadas como argumentos para o comando . A DSC passa os argumentos para o comando na ordem em que são especificados.

Type:     array
Required: false
Default:  []

Compartilhar via