Delen via

dsc-resourceschema

Synopsis

Retourneert het JSON-schema voor exemplaren van een resource.

Syntax

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

Description

De schema subopdracht retourneert het JSON-schema voor een exemplaar van een specifieke DSC-resource. DSC gebruikt deze schema's om de invoer voor de getsubopdrachten , seten test te valideren en bij het valideren van de exemplaren in een DSC-configuratiedocument.

Integratiehulpprogramma's kunnen deze schema's gebruiken voor validatie of om de ontwerpervaring voor configuraties te verbeteren. Het exemplaarschema van een resource definieert de geldige structuur voor een exemplaar, inclusief welke eigenschappen verplicht zijn en wat de waarden moeten zijn. De instantieschema's kunnen ook lichtgewicht documentatie bevatten voor de eigenschappen met de title trefwoorden en description .

Voorbeelden

Voorbeeld 1: Het schema voor een resource ophalen

In dit voorbeeld wordt het schema voor de OSInfo op opdrachten gebaseerde DSC-resource geretourneerd.

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

Opties

-r, --resource

Hiermee geeft u de volledig gekwalificeerde typenaam van de DSC-resource op waaruit het exemplaarschema moet worden opgehaald, zoals Microsoft.Windows/Registry.

De volledig gekwalificeerde naamsyntaxis van het type is: <owner>[.<group>][.<area>]/<name>, waarbij:

  • De owner is de onderhoudende auteur of organisatie voor de resource.
  • De group en area zijn optionele naamonderdelen waarmee namespacing voor een resource mogelijk is.
  • De name identificeert het onderdeel dat door de resource wordt beheerd.
Type:      String
Mandatory: true

-f, --format

Met de --format optie bepaalt u de indeling van de console-uitvoer voor de opdracht. Als de uitvoer van de opdracht wordt omgeleid of vastgelegd als een variabele, is de uitvoer altijd JSON.

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

-h, --help

Geeft de Help weer voor de huidige opdracht of subopdracht. Wanneer u deze optie opgeeft, worden alle opties en argumenten na deze optie genegeerd.

Type:      Boolean
Mandatory: false

Uitvoer

Met deze opdracht wordt een JSON-object geretourneerd dat het JSON-schema vertegenwoordigt voor een exemplaar van de opgegeven DSC-resource.

  • Last updated on