Sdílet prostřednictvím

Referenční informace ke schématu manifestu rozšíření DSC založeného na příkazech

Přehled

Datový soubor, který definuje příponu DSC založenou na příkazech.

Metadatové informace

SchemaDialect: https://json-schema.org/draft/2020-12/schema
SchemaID:      https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/extension/manifest.json
Type:          object

Popis

Každý prostředek DSC založený na příkazech musí mít manifest. Soubor manifestu musí:

  1. Být zjistitelný v proměnné PATH prostředí.
  2. Formátovat jako JSON nebo YAML.
  3. Dodržujte konvenci <name>.dsc.resource.<extension>pojmenování . Mezi platné přípony patří json, yml, a yaml.
  4. Pro schéma popsané v tomto dokumentu je platné.

Zbytek tohoto dokumentu popisuje schéma manifestu.

Požadované vlastnosti

Manifest musí obsahovat tyto vlastnosti:

Vlastnosti

$schema

Vlastnost $schema označuje kanonický identifikátor URI tohoto schématu, proti kterému se manifest ověřuje. Tato vlastnost je povinná. DSC tuto hodnotu používá k ověření manifestu ve správném schématu JSON.

Schémata JSON pro DSC jsou publikována v několika verzích a formách. Tato dokumentace je určena pro nejnovější verzi schématu. Pro usnadnění práce můžete zadat buď úplný identifikátor URI pro schéma hostované na GitHubu, nebo použít kratší aka.ms identifikátor URI. Můžete zadat schéma pro konkrétní sémantickou verzi, nejnovější schéma pro podverzi nebo nejnovější schéma pro hlavní verzi DSC. Další informace o identifikátorech URI schématu a správě verzí najdete v tématu Identifikátory URI schématu DSC JSON.

Pro každou verzi schématu existují tři platné adresy URL:

  • .../extension/manifest.json

    Adresa URL kanonického nebaleného schématu. Když se používá k ověření, klient ověřování potřebuje načíst toto schéma a každé schéma, na které odkazuje.

  • .../bundled/extension/manifest.json

    Adresa URL kanonicky sbaleného schématu. Pokud se používá k ověření, ověřování klienta potřebuje pouze načíst toto schéma.

    Toto schéma používá model sdružování zavedený pro schéma JSON 2020–12. I když DSC může dokument ověřit i při použití tohoto schématu, jiné nástroje mohou chybovat nebo se chovat neočekávaným způsobem, pokud plně nepodporují specifikaci 2020-12.

  • .../bundled/extension/manifest.vscode.json

    Adresa URL rozšířeného schématu vytváření Toto schéma je mnohem větší než ostatní schémata, protože obsahuje další definice, které poskytují kontextovou nápovědu a fragmenty kódu, které ostatní nezahrnují.

    Toto schéma používá klíčová slova, která jsou rozpoznána pouze nástrojem VS Code. I když DSC může dokument ověřit, když používá toto schéma, jiné nástroje mohou chybovat nebo se chovat neočekávaným způsobem.

Type:        string
Required:    true
Format:      URI
ValidValues: [
               https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/extension/manifest.json
               https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/bundled/extension/manifest.json
               https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/bundled/extension/manifest.vscode.json
               https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1/extension/manifest.json
               https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1/bundled/extension/manifest.json
               https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1/bundled/extension/manifest.vscode.json
               https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/extension/manifest.json
               https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/bundled/extension/manifest.json
               https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/bundled/extension/manifest.vscode.json
               https://aka.ms/dsc/schemas/v3/extension/manifest.json
               https://aka.ms/dsc/schemas/v3/bundled/extension/manifest.json
               https://aka.ms/dsc/schemas/v3/bundled/extension/manifest.vscode.json
               https://aka.ms/dsc/schemas/v3.1/extension/manifest.json
               https://aka.ms/dsc/schemas/v3.1/bundled/extension/manifest.json
               https://aka.ms/dsc/schemas/v3.1/bundled/extension/manifest.vscode.json
               https://aka.ms/dsc/schemas/v3.1.0/extension/manifest.json
               https://aka.ms/dsc/schemas/v3.1.0/bundled/extension/manifest.json
               https://aka.ms/dsc/schemas/v3.1.0/bundled/extension/manifest.vscode.json
             ]

typ

Vlastnost type představuje plně kvalifikovaný název typu rozšíření. Další informace o názvech typů rozšíření najdete v referenčních informacích k plně kvalifikovaným názvům typů prostředků DSC.

Type:     string
Required: true
Pattern:  ^\w+(\.\w+){0,3}\/\w+$

verze

Vlastnost version musí být aktuální verzí rozšíření jako platný řetězec sémantické verze (semver).

Type:     string
Required: true
Pattern:  ^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$

popis

Tato description vlastnost definuje synopsi pro účel rozšíření. Hodnota této vlastnosti musí být krátký řetězec.

Type:     string
Required: false

štítky

Tato tags vlastnost definuje seznam prohledávatelných výrazů pro rozšíření. Hodnota této vlastnosti musí být pole řetězců. Každá značka musí obsahovat pouze alfanumerické znaky a podtržítka. Nejsou povoleny žádné další znaky. Každá značka musí být jedinečná.

Type:              array
Required:          false
ItemsMustBeUnique: true
ItemsType:         string
ItemsPattern:      ^\w+$

zjistit

Tato discover vlastnost definuje, jak volat rozšíření pro zjišťování prostředků DSC, které nejsou k dispozici v PATH proměnných prostředí nebo DSC_RESOURCE_PATH . Když je tato vlastnost definována, DSC vyvolá discover operaci pro rozšíření během fáze zjišťování prostředků libovolného dsc config příkazu nebo dsc resource .

Hodnota této vlastnosti musí být objekt. Vlastnost objektu executable , definující název příkazu, který se má volat, je povinná. Vlastnost args je nepovinná. Další informace naleznete v tématu Referenční informace ke schématu vlastností manifestu rozšíření DSC.

Type:     object
Required: true

exitCodes

Tato exitCodes vlastnost definuje sadu platných ukončovacích kódů pro rozšíření a jejich význam. Definujte tuto vlastnost jako sadu párů klíč-hodnota, kde:

  • Klíč je řetězec obsahující celé číslo se znaménkem, který se mapuje na známý ukončovací kód pro rozšíření. Ukončovací kód musí být celé číslo podepsané literálem. Pro ukončovací kód nemůžete použít alternativní formáty. Například místo šestnáctkové hodnoty 0x80070005 pro "Přístup odepřen" zadejte ukončovací kód jako -2147024891.
  • Hodnota je řetězec popisující sémantický význam tohoto ukončovacího kódu pro člověka.

DSC interpretuje ukončovací kód 0 jako úspěšnou operaci a jakýkoli jiný ukončovací kód jako chybu.

Návod

Pokud vytváříte manifest rozšíření v YAML, nezapomeňte ukončovací kód zabalit do jednoduchých uvozovek, abyste zajistili správnou analýzu souboru YAML. Například:

exitCodes:
  '0': Success
  '1': Invalid parameter
  '2': Invalid input
  '3': Registry error
  '4': JSON serialization failed

Type:                object
Required:            false
PropertyNamePattern: ^-?[0-9]+#
PropertyValueType:   string
  • Last updated on