Esquema de recursos dsc

Sinopsis

Devuelve el esquema JSON para las instancias de un recurso.

Sintaxis

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

Descripción

El schema subcomando devuelve el esquema JSON de una instancia de un recurso de DSC específico. DSC usa estos esquemas para validar la entrada de los getsubcomandos , sety y test al validar las instancias en un documento de configuración de DSC.

Las herramientas de integración pueden usar estos esquemas para la validación o para mejorar la experiencia de creación de la configuración. El esquema de instancia de un recurso define la estructura válida para una instancia, incluidas las propiedades que son obligatorias y cuáles deben ser sus valores. Los esquemas de instancia también pueden incluir documentación ligera para las propiedades con las title palabras clave y description .

Ejemplos

Ejemplo 1: Obtención del esquema de un recurso

En este ejemplo se devuelve el esquema del OSInfo recurso de DSC basado en 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://learn.microsoft.com/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://learn.microsoft.com/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://learn.microsoft.com/powershell/dsc/reference/microsoft/osinfo/resource#id
    markdownDescription: |
      Returns the unique ID for the OSInfo instance data type.

      [Online documentation][01]

      [01]: https://learn.microsoft.com/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://learn.microsoft.com/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://learn.microsoft.com/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://learn.microsoft.com/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://learn.microsoft.com/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://learn.microsoft.com/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://learn.microsoft.com/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://learn.microsoft.com/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://learn.microsoft.com/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://learn.microsoft.com/powershell/dsc/reference/microsoft/osinfo/resource#family
    markdownDescription: |
      Defines whether the operating system is Linux, macOS, or Windows.

      [Online documentation][01]

      [01]: https://learn.microsoft.com/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://learn.microsoft.com/powershell/dsc/reference/microsoft/osinfo/resource#version
    markdownDescription: |
      Defines the version of the operating system as a string.

      [Online documentation][01]

      [01]: https://learn.microsoft.com/powershell/dsc/reference/microsoft/osinfo/resource#version

Opciones

-r, --resource

Especifica el nombre de tipo completo del recurso de DSC del que se va a recuperar el esquema de instancia, como Microsoft.Windows/Registry.

La sintaxis de nombre de tipo completo es: <owner>[.<group>][.<area>]/<name>, donde:

• owner es el autor u organización del mantenimiento del recurso.
• y grouparea son componentes de nombre opcionales que habilitan el espaciado de nombres para un recurso.
• name identifica el componente que administra el recurso.

Type:      String
Mandatory: true

-f, --format

La --format opción controla el formato de salida de la consola para el comando . Si la salida del comando se redirige o captura como una variable, la salida siempre es JSON.

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

-h, --help

Muestra la ayuda del comando o subcomando actual. Al especificar esta opción, la aplicación omite todas las opciones y argumentos después de esta.

Type:      Boolean
Mandatory: false

Resultados

Este comando devuelve un objeto JSON que representa el esquema JSON para una instancia del recurso de DSC especificado.