esquema dsc

Artigo
03/06/2024

Sinopse

Obtém o esquema JSON para um tipo DSC.

Sintaxe

dsc schema [Options] --type <TYPE>

Descrição

O schema comando retorna o esquema JSON para um tipo DSC específico. Esses esquemas podem ser usados para validar os dados de retorno do aplicativo ou para gerar definições de tipo compatíveis para uma ferramenta de integração.

O aplicativo usa esses esquemas para validar dados internamente quando são recebidos ou representam a saída de um dos comandos do aplicativo.

Exemplos

Exemplo 1 – Recuperar o esquema para o resultado do comando dsc resource get

dsc schema --type get-result

$schema: http://json-schema.org/draft-07/schema#
title: GetResult
type: object
required:
- actualState
properties:
  actualState:
    description: The state of the resource as it was returned by the Get method.
additionalProperties: false

Opções

-t, --type

Essa opção é obrigatória para o schema comando . O valor dessa opção determina qual esquema o aplicativo retorna:

dsc-resource (documentação de referência) – representa um recurso DSC conforme retornado do dsc resource list comando .
resource-manifest (documentação de referência) – valida o manifesto de um recurso DSC baseado em comando. Se o manifesto for inválido, a DSC gerará um erro.
get-result (documentação de referência) – representa a saída do dsc resource get comando .
set-result (documentação de referência) – representa a saída do dsc resource set comando .
test-result (documentação de referência) – representa a saída do dsc resource test comando .
configuration (documentação de referência) – Valida um documento de configuração de DSC. Se o documento for inválido, a DSC gerará um erro.
configuration-get-result (documentação de referência) – representa a saída do dsc config get comando .
configuration-set-result (documentação de referência) – representa a saída do dsc config set comando .
configuration-test-result (documentação de referência) – representa a saída do dsc config test comando .

Type:        String
Mandatory:   true
ValidValues: [
               dsc-resource,
               resource-manifest,
               get-result,
               set-result,
               test-result,
               configuration,
               configuration-get-result,
               configuration-set-result,
               configuration-test-result
             ]

-f, --format

A --format opção controla o formato de saída do console para o comando . Se a saída do comando for redirecionada ou capturada como uma variável, a saída será sempre JSON.

Type:         String
Mandatory:    false
DefaultValue: yaml
ValidValues:  [json, pretty-json, yaml]

-h, --help

Exibe a ajuda para o comando ou subcomando atual. Quando você especifica essa opção, o aplicativo ignora todas as opções e argumentos após essa.

Type:      Boolean
Mandatory: false

Compartilhar via