DSC-konfigurációs dokumentum sémareferenciája

Cikk
05/11/2024

Áttekintés

A DSC-konfigurációt definiáló YAML- vagy JSON-fájl.

Metaadatok

SchemaDialect: https://json-schema.org/draft/2020-12/schema
SchemaID:      https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/config/document.json
Type:          object

Description

A DSC-konfigurációk lehetővé teszik, hogy a felhasználók különböző DSC-erőforrások kombinálásával definiálják az állapotot. A konfigurációs dokumentumok paramétereket és változókat használnak a kívánt állapotot definiáló egy vagy több erőforráskészletnek való továbbításhoz.

A konfigurációs dokumentum YAML vagy JSON formátumban is definiálható. A könnyű létrehozás érdekében a Microsoft a konfigurációs dokumentumok YAML-ben történő megszövegezését javasolja.

Ahhoz, hogy a DSC szerzői eszközei felismerjenek egy fájlt DSC-konfigurációs dokumentumként, a fájlnévnek a következővel .dsc.config.jsonkell végződnie: , .dsc.config.ymlvagy .dsc.config.yaml.

A konfigurációs dokumentumfüggvényekkel dinamikusan határozhatja meg a dokumentumban lévő értékeket futásidőben. További információ: DSC Konfigurációs dokumentumfüggvények referenciája

A dokumentum többi része azt a sémát ismerteti, amelyet a DSC a konfigurációs dokumentumok érvényesítéséhez használ.

Példák

Kötelező tulajdonságok

Minden konfigurációs dokumentumnak tartalmaznia kell a következő tulajdonságokat:

[$schema]
[erőforrások]

Tulajdonságok

$schema

A $schema tulajdonság a séma azon verziójának canonical URL-címét jelzi, amelyhez a dokumentum ragaszkodik. A DSC ezt a tulajdonságot használja a konfigurációs dokumentum ellenőrzésekor a konfigurációs műveletek előtt.

A séma jelenleg 3 közzétett verziója van, amelyek kompatibilisek a DSC különböző verzióival:

2024/04 A séma legújabb verziója, amely kompatibilis a DSC 3.0.0-preview.7-es és újabb verziójával.
2023/10 a séma előző verziója, amely kompatibilis a DSC-verziókkal 3.0.0-alpha.4 és 3.0.0-alpha.5a .
2023/08 A séma első verziója, amely kompatibilis a DSC-verziókkal 3.0.0-alpha.1 a használatával 3.0.0-alpha.3.

Ez a dokumentáció a séma legújabb verziójához készült. Frissítenie kell a konfigurációs dokumentumokat és az erőforrásjegyzékeket a séma legújabb verziójára. A korábbi verziók nem működnek a DSC új kiadásaival. A sémák továbbra is közzé vannak téve, de nem kapnak frissítéseket.

A séma minden verziójához három érvényes URL-cím érhető el:

.../config/document.json

A canonical non-bundled séma URL-címe. Ha érvényesítéshez használják, az érvényesítő ügyfélnek le kell kérnie ezt a sémát és minden olyan sémát, amelyet hivatkozik.
.../bundled/config/document.json

A csomagolt séma URL-címe. Ha érvényesítésre használják, az érvényesítő ügyfélnek csak ezt a sémát kell lekérnie.

Ez a séma a JSON Schema 2020-12-hez bevezetett csomagküldő modellt használja. Bár a DSC továbbra is érvényesítheti a dokumentumot, amikor ezt a sémát használja, más eszközök nem várt módon hibásak vagy viselkedhetnek.
.../bundled/config/document.vscode.json

A bővített szerzői séma URL-címe. Ez a séma sokkal nagyobb, mint a többi séma, mivel olyan további definíciókat tartalmaz, amelyek környezeti segítséget és kódrészleteket biztosítanak, amelyeket a többi nem tartalmaz.

Ez a séma olyan kulcsszavakat használ, amelyeket csak a VS Code ismer fel. Bár a DSC továbbra is érvényesítheti a dokumentumot, amikor ezt a sémát használja, más eszközök nem várt módon hibásak vagy viselkedhetnek.

Type:        string
Required:    true
Format:      URI
ValidValues: [
               https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/config/document.json
               https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/bundled/config/document.json
               https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/bundled/config/document.vscode.json
               https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2023/10/config/document.json
               https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2023/10/bundled/config/document.json
               https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2023/10/bundled/config/document.vscode.json
               https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2023/08/config/document.json
               https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2023/08/bundled/config/document.json
               https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2023/08/bundled/config/document.vscode.json
             ]

metaadatok

A metadata tulajdonság kulcs-érték párok készletét határozza meg a konfiguráció széljegyzeteiként. A DSC nem ellenőrzi a metaadatokat. A konfiguráció tetszőleges információkat tartalmazhat ebben a tulajdonságban.

Type:     object
Required: false

parameters

A parameters tulajdonság futásidejű beállítások készletét határozza meg a konfigurációhoz. Minden paraméter kulcs-érték párként van definiálva. Az egyes párok kulcsa határozza meg a paraméter nevét. Az egyes párok értékének egy olyan objektumnak kell lennie, amely meghatározza a type kulcsszót annak jelzésére, hogy a DSC hogyan dolgozza fel a paramétert.

A paraméterek futásidőben felülírhatók, így ugyanazon konfigurációs dokumentum újra felhasználható a különböző környezetekben.

További információ a paraméterek konfigurációban való definiálásáról: DSC Konfigurációs dokumentum paraméterséma.

Type:                object
Required:            false
ValidPropertySchema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/config/document.parameter.json

Változók

A variables tulajdonság kulcs-érték párként definiálja a dokumentum erőforrásainak újrafelhasználható értékeit. Az egyes párok kulcsa határozza meg a változó nevét. A változót név szerint hivatkozó erőforrások hozzáférhetnek a változó értékéhez.

Ez segíthet csökkenteni a konfigurációban lévő erőforrások másolt értékeinek és beállításainak mennyiségét, ami megkönnyíti a dokumentum olvasását és karbantartását. A paraméterektől eltérően a változók csak a konfigurációban határozhatók meg, és futásidőben nem bírálhatók felül.

Type:     object
Required: false

resources

A resources tulajdonság meghatározza a konfiguráció által kezelt DSC-erőforráspéldányok listáját. A listában szereplő összes példánynak egyedinek kell lennie, de a példányok azonos DSC-erőforrástípussal rendelkezhetnek.

Az érvényes erőforráspéldány konfigurációban való definiálásáról további információt a DSC konfigurációs dokumentum erőforrássémájában talál.

Type:             array
Required:         true
MinimumItemCount: 1
ValidItemSchema:  https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/config/document.resource.json

Megosztás a következőn keresztül: