dsc-séma

Áttekintés

Lekéri egy DSC-típus JSON-sémáját.

Syntax

dsc schema [Options] --type <TYPE>

Description

A schema parancs egy adott DSC-típus JSON-sémáját adja vissza. Ezek a sémák az alkalmazásból származó visszatérési adatok ellenőrzésére vagy kompatibilis típusdefiníciók létrehozására használhatók egy integráló eszközhöz.

Az alkalmazás ezeket a sémákat arra használja, hogy belsőleg ellenőrizze az adatokat, amikor azokat fogadják, vagy az alkalmazás egyik parancsának kimenetét képviselik.

Példák

1. példa – A dsc-erőforrás sémájának lekérése parancs eredményének lekérése

dsc schema --type get-result

$schema: http://json-schema.org/draft-07/schema#
title: GetResult
anyOf:
- $ref: '#/definitions/ResourceGetResponse'
- type: array
  items:
    $ref: '#/definitions/ResourceGetResult'
definitions:
  ResourceGetResponse:
    type: object
    required:
    - actualState
    properties:
      actualState:
        description: The state of the resource as it was returned by the Get method.
    additionalProperties: false
  ResourceGetResult:
    type: object
    required:
    - name
    - result
    - type
    properties:
      metadata:
        anyOf:
        - $ref: '#/definitions/Metadata'
        - type: 'null'
      name:
        type: string
      type:
        type: string
      result:
        $ref: '#/definitions/GetResult'
    additionalProperties: false
  Metadata:
    type: object
    properties:
      Microsoft.DSC:
        anyOf:
        - $ref: '#/definitions/MicrosoftDscMetadata'
        - type: 'null'
  MicrosoftDscMetadata:
    type: object
    properties:
      version:
        description: Version of DSC
        type:
        - string
        - 'null'
      operation:
        description: The operation being performed
        anyOf:
        - $ref: '#/definitions/Operation'
        - type: 'null'
      executionType:
        description: The type of execution
        anyOf:
        - $ref: '#/definitions/ExecutionKind'
        - type: 'null'
      startDatetime:
        description: The start time of the configuration operation
        type:
        - string
        - 'null'
      endDatetime:
        description: The end time of the configuration operation
        type:
        - string
        - 'null'
      duration:
        description: The duration of the configuration operation
        type:
        - string
        - 'null'
      securityContext:
        description: The security context of the configuration operation, can be specified to be required
        anyOf:
        - $ref: '#/definitions/SecurityContextKind'
        - type: 'null'
      context:
        description: Identifies if the operation is part of a configuration
        anyOf:
        - $ref: '#/definitions/ContextKind'
        - type: 'null'
  Operation:
    type: string
    enum:
    - Get
    - Set
    - Test
    - Export
  ExecutionKind:
    type: string
    enum:
    - Actual
    - WhatIf
  SecurityContextKind:
    type: string
    enum:
    - Current
    - Elevated
    - Restricted
  ContextKind:
    type: string
    enum:
    - Configuration
    - Resource
  GetResult:
    anyOf:
    - $ref: '#/definitions/ResourceGetResponse'
    - type: array
      items:
        $ref: '#/definitions/ResourceGetResult'

Beállítások

-t, --type

Ez a beállítás kötelező a schema parancshoz. A beállítás értéke határozza meg, hogy az alkalmazás melyik sémát adja vissza:

• dsc-resource (referenciadokumentáció) – A parancs által dsc resource list visszaadott DSC-erőforrást jelöli.
• resource-manifest (referenciadokumentáció) – Ellenőrzi a parancsalapú DSC-erőforrás jegyzékfájlját. Ha a jegyzékfájl érvénytelen, a DSC hibát jelez.
• get-result (referenciadokumentáció) – A parancs kimenetét dsc resource get jelöli.
• set-result (referenciadokumentáció) – A parancs kimenetét dsc resource set jelöli.
• test-result (referenciadokumentáció) – A parancs kimenetét dsc resource test jelöli.
• configuration (referenciadokumentáció) – DSC-konfigurációs dokumentum ellenőrzése. Ha a dokumentum érvénytelen, a DSC hibát jelez.
• configuration-get-result (referenciadokumentáció) – A parancs kimenetét dsc config get jelöli.
• configuration-set-result (referenciadokumentáció) – A parancs kimenetét dsc config set jelöli.
• configuration-test-result (referenciadokumentáció) – A parancs kimenetét dsc config test jelöli.

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 beállítás szabályozza a parancs konzolkimeneti formátumát. Ha a parancs kimenetét átirányítja vagy változóként rögzíti, a kimenet mindig JSON lesz.

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

-h, --help

Megjeleníti az aktuális parancs vagy alparancs súgóját. Ha ezt a beállítást adja meg, az alkalmazás figyelmen kívül hagyja az összes beállítást és argumentumot ezt követően.

Type:      Boolean
Mandatory: false