Partilhar via

esquema de recursos dsc

Sinopse

Devolve o Esquema JSON para instâncias de um recurso.

Syntax

dsc resource schema [Options] --resource <RESOURCE>

Descrição

O schema subcomando devolve o esquema JSON de uma instância de um Recurso DSC específico. O DSC utiliza estes esquemas para validar a entrada para os getsubcomandos , sete test e ao validar as instâncias num documento de Configuração do DSC.

As ferramentas de integração podem utilizar estes esquemas para validação ou para melhorar a experiência de criação de configuração. O esquema de instância de um recurso define a estrutura válida para uma instância, incluindo as propriedades que são obrigatórias e quais devem ser os respetivos valores. Os esquemas de instância também podem incluir documentação simples para as propriedades com as title palavras-chave e description .

Exemplos

Exemplo 1 - Obter o esquema de um recurso

Este exemplo devolve o esquema do OSInfo Recurso DSC baseado em comandos.

dsc resource schema --resource Microsoft/OSInfo

$schema: http://json-schema.org/draft-07/schema#
$id: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/resources/Microsoft/OSInfo/v0.1.0/schema.json
title: OsInfo
description: |
  Returns information about the operating system.

  https://v4.hkg1.meaqua.org/powershell/dsc/reference/microsoft/osinfo/resource
markdownDescription: |
  The `Microsoft/OSInfo` resource enables you to assert whether a machine meets criteria related to
  the operating system. The resource is only capable of assertions. It doesn't implement the set
  operation and can't configure the operating system.

  [Online documentation][01]

  [01]: https://v4.hkg1.meaqua.org/powershell/dsc/reference/microsoft/osinfo/resource
type: object
required: []
additionalProperties: false
properties:
  $id:
    type: string
    readOnly: true
    title: Data Type ID
    description: |
      Returns the unique ID for the OSInfo instance data type.

      https://v4.hkg1.meaqua.org/powershell/dsc/reference/microsoft/osinfo/resource#id
    markdownDescription: |
      Returns the unique ID for the OSInfo instance data type.

      [Online documentation][01]

      [01]: https://v4.hkg1.meaqua.org/powershell/dsc/reference/microsoft/osinfo/resource#id
  architecture:
    type: string
    title: Processor architecture
    description: |
      Defines the processor architecture as reported by 'uname -m' on the operating system.

      https://v4.hkg1.meaqua.org/powershell/dsc/reference/microsoft/osinfo/resource#architecture
    markdownDescription: |
      Defines the processor architecture as reported by `uname -m` on the operating system.

      [Online documentation][01]

      [01]: https://v4.hkg1.meaqua.org/powershell/dsc/reference/microsoft/osinfo/resource#architecture
  bitness:
    type: string
    enum:
    - '32'
    - '64'
    - unknown
    title: Operating system bitness
    description: |
      Defines whether the operating system is a 32-bit or 64-bit operating system.

      https://v4.hkg1.meaqua.org/powershell/dsc/reference/microsoft/osinfo/resource#bitness
    markdownDescription: |
      Defines whether the operating system is a 32-bit or 64-bit operating system.

      [Online documentation][01]

      [01]: https://v4.hkg1.meaqua.org/powershell/dsc/reference/microsoft/osinfo/resource#bitness
  codename:
    type: string
    title: Linux codename
    description: |
      Defines the codename for the operating system as returned from 'lsb_release --codename'.

      https://v4.hkg1.meaqua.org/powershell/dsc/reference/microsoft/osinfo/resource#codename
    markdownDescription: |
      Defines the codename for the operating system as returned from `lsb_release --codename`.

      [Online documentation][01]

      [01]: https://v4.hkg1.meaqua.org/powershell/dsc/reference/microsoft/osinfo/resource#codename
  edition:
    type: string
    title: Windows edition
    description: |
      Defines the operating system edition, like 'Windows 11' or 'Windows Server 2016'.

      https://v4.hkg1.meaqua.org/powershell/dsc/reference/microsoft/osinfo/resource#edition
    markdownDescription: |
      Defines the operating system edition, like `Windows 11` or `Windows Server 2016`.

      [Online documentation][01]

      [01]: https://v4.hkg1.meaqua.org/powershell/dsc/reference/microsoft/osinfo/resource#edition
  family:
    type: string
    enum:
    - Linux
    - macOS
    - Windows
    title: Operating system family
    description: |
      Defines whether the operating system is Linux, macOS, or Windows.

      https://v4.hkg1.meaqua.org/powershell/dsc/reference/microsoft/osinfo/resource#family
    markdownDescription: |
      Defines whether the operating system is Linux, macOS, or Windows.

      [Online documentation][01]

      [01]: https://v4.hkg1.meaqua.org/powershell/dsc/reference/microsoft/osinfo/resource#family
  version:
    type: string
    title: Operating system version
    description: |
      Defines the version of the operating system as a string.

      https://v4.hkg1.meaqua.org/powershell/dsc/reference/microsoft/osinfo/resource#version
    markdownDescription: |
      Defines the version of the operating system as a string.

      [Online documentation][01]

      [01]: https://v4.hkg1.meaqua.org/powershell/dsc/reference/microsoft/osinfo/resource#version

Opções

-r, --resource

Especifica o nome de tipo completamente qualificado do Recurso do DSC a partir do qual obter o esquema da instância, como Microsoft.Windows/Registry.

A sintaxe do nome do tipo completamente qualificado é: <owner>[.<group>][.<area>]/<name>, em que:

  • É owner o autor ou organização responsável pela manutenção do recurso.
  • Os group e area são componentes de nomes opcionais que permitem o espaçamento de nomes para um recurso.
  • O name identifica o componente que o recurso gere.
Type:      String
Mandatory: true

-f, --format

A --format opção controla o formato de saída da consola 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

Apresenta a ajuda do comando ou subcomando atual. Quando especifica esta opção, a aplicação ignora todas as opções e argumentos após esta.

Type:      Boolean
Mandatory: false

Saída

Este comando devolve um objeto JSON que representa o esquema JSON de uma instância do Recurso DSC especificado.

  • Last updated on