Schéma prostředků dsc

Synopse

Vrátí schéma JSON pro instance prostředku.

Syntax

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

Description

Podpříkaz schema vrátí schéma JSON pro instance konkrétního prostředku DSC. DSC používá tato schémata k ověření vstupu pro getpodpříkazy , seta test při ověřování instancí v dokumentu konfigurace DSC.

Integrace nástrojů může tato schémata použít k ověření nebo vylepšení prostředí pro vytváření konfigurace. Schéma instance prostředku definuje platnou strukturu instance, včetně toho, které vlastnosti jsou povinné a jaké by měly být jejich hodnoty. Schémata instancí mohou také obsahovat zjednodušenou dokumentaci pro vlastnosti s klíčovými title slovy a description .

Příklady

Příklad 1 – Získání schématu pro prostředek

Tento příklad vrátí schéma pro prostředek DSC založený na OSInfo příkazech.

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

Možnosti

-r, --resource

Určuje plně kvalifikovaný název typu prostředku DSC, ze které se má načíst schéma instance, například Microsoft.Windows/Registry.

Plně kvalifikovaná syntaxe názvu typu je: <owner>[.<group>][.<area>]/<name>, kde:

• Jedná se owner o autora nebo organizaci, který spravuje prostředek.
• area A group jsou volitelné komponenty názvů, které umožňují vytváření názvů pro prostředek.
• Identifikuje name komponentu, která prostředek spravuje.

Type:      String
Mandatory: true

-f, --format

Možnost --format řídí formát výstupu konzoly pro příkaz. Pokud je výstup příkazu přesměrovaný nebo zachycený jako proměnná, je výstup vždy JSON.

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

-h, --help

Zobrazí nápovědu k aktuálnímu příkazu nebo dílčímu příkazu. Když zadáte tuto možnost, aplikace ignoruje všechny možnosti a argumenty za touto možností.

Type:      Boolean
Mandatory: false

Výstup

Tento příkaz vrátí objekt JSON představující schéma JSON pro instanci zadaného prostředku DSC.