Sdílet prostřednictvím

Referenční dokumentace schématu výsledků seznamu prostředků dsc

Přehled

Výsledný výstup z příkazu dsc resource list .

Metadatové informace

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

Popis

Výstup příkazu dsc resource list obsahuje reprezentaci zjištěných prostředků DSC jako řadu řádků JSON. Toto schéma popisuje objekt JSON vrácený pro každý prostředek.

Požadované vlastnosti

Každý prostředek ve výstupu vždy obsahuje tyto vlastnosti:

Vlastnosti

typ

Identifikuje plně kvalifikovaný název typu prostředku. Používá se k určení zdroje v konfiguračních dokumentech a jako hodnota příznaku --resource při použití dsc resource * příkazů. Další informace o názvech typů prostředků najdete v referenčních informacích ke schématu plně kvalifikovaných názvů typů prostředků DSC.

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

laskavý

Určuje, zda je prostředek prostředkem adaptéru, prostředkem skupiny nebo ani jedním z nich. Tato hodnota je buď definována v manifestu prostředku , nebo odvozena pomocí DSC. Další informace o druzích prostředků najdete v referenčních informacích ke schématu druhu prostředku DSC.

Type:          string
Required:      true
ValidValues:  [Resource, Adapter, Group]

verze

Představuje aktuální verzi prostředku jako platný sémantický řetězec (semver). Verze se vztahuje na prostředek, nikoli na software, který spravuje.

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-]+)*))?$

schopnosti

Prostředky DSC mají vždy alespoň jednu funkci. Možnosti zdroje definují operace, které lze u prostředku vyvolat, a způsob, jakým se prostředek chová při vyvolání.

Prostředky DSC mohou mít následující možnosti:

  • get - Zdroj může načíst aktuální stav instance.
  • set - Prostředek může vynutit požadovaný stav instance.
  • setHandlesExist - Prostředek zpracovává odstranění instance během operace Set .
  • whatIf - Zdroj může hlásit, jak by změnil stav instance během operace sady .
  • test - Prostředek implementuje testovací operaci a nespoléhá se na syntetické testování.
  • delete - Prostředek může instanci odebrat.
  • export - Zdroj může vytvořit výčet všech instancí.
  • resolve - Prostředek může přeložit vnořené instance z externího zdroje.

Další informace o možnostech prostředků najdete v tématu Možnosti prostředků DSC. Další informace o operacích, které můžete vyvolat pro prostředek, najdete v tématu Operace prostředků DSC.

Type:              array
Required:          true
ItemsMustBeUnique: true
ItemsType:         string
ItemsValidValues: [
                    get,
                    set,
                    setHandlesExist,
                    whatIf,
                    test,
                    delete,
                    export,
                    resolve
                  ]

popis

Definuje synopzi pro účely prostředku jako krátký řetězec. Pokud prostředek nemá popis, je nulltato vlastnost .

Type:     [string, 'null']
Required: true

cesta

Představuje cestu k manifestu prostředku na počítači. U přizpůsobených prostředků tato vlastnost identifikuje cestu k souboru, který místo toho definuje prostředek.

Type:     string
Required: true

adresář

Představuje cestu ke složce obsahující manifest prostředku na počítači. U přizpůsobených prostředků tato vlastnost identifikuje cestu ke složce obsahující soubor, který místo toho definuje prostředek.

Type:     string
Required: true

implementované jako

Určuje způsob implementace prostředku DSC. U prostředků založených na příkazech je tato hodnota vždy Command.

autor

Označuje jméno osoby nebo organizace, která vytvořila a udržuje prostředek DSC. Pokud je nulltato vlastnost , autor není znám.

Type:     [string, 'null']
Required: true

vlastnosti

Definuje názvy vlastností pro přizpůsobené prostředky. U nepřizpůsobených prostředků je tato vlastnost prázdným polem.

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

requireAdapter

Definuje plně kvalifikovaný název typu adaptéru prostředku DSC, prostřednictvím kterého je tento prostředek zpřístupněn. Tato hodnota je definována pouze pro přizpůsobené prostředky. U nepřizpůsobených zdrojů je tato hodnota vždy null.

Type:     [string, 'null']
Required: true

manifest

Představuje hodnoty definované v manifestu prostředku. Tato hodnota je null určena pro prostředky, které nejsou založeny na příkazech. Další informace o hodnotě této vlastnosti naleznete v referenčních informacích ke schématu manifestu prostředku DSC založeného na příkazech.

Type:     [object, 'null']
Required: true
  • Last updated on