DSC-konfigurációs dokumentumparaméter sémája
Áttekintés
A konfiguráció futásidejű beállításait határozza meg.
Metaadatok
SchemaDialect: https://json-schema.org/draft/2020-12/schema
SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/config/document.parameter.json
Type: object
Leírás
A DSC konfigurációs dokumentumai tartalmazhatnak paramétereket, amelyeket a felhasználók futásidőben felülbírálhatnak. A paraméterek lehetővé teszik a titkos kódok elkülönítését a konfigurációdefinícióktól, és lehetővé teszik a felhasználók számára, hogy olyan konfigurációkat írjanak, amelyek több környezetre is alkalmazhatók.
A paraméterek kulcs-érték párokként vannak definiálva egy konfigurációs dokumentum parameters tulajdonságában.
A kulcs a paraméter neve, amely a konfigurációs dokumentum erőforrások tulajdonságában található paraméterre hivatkozik. Az érték egy olyan objektum, amely meghatározza a paramétert.
Minden paraméter meghatározza az adattípusát. A paraméterek meghatározhatnak alapértelmezett értéket, érvényesítési ellenőrzéseket, rendeltetésük leírását és tetszőleges metaadatokat is.
Az erőforráspéldányok paramétereinek hivatkozásához használja a paraméter() konfigurációs függvényt.
Kötelező tulajdonságok
Kellékek
leírás
A paraméterek a description tulajdonsággal rövid magyarázatot adhatnak rendeltetésükről és használatukról. Ha hosszabb magyarázatot szeretne definiálni a YAML-ben, használja az összecsukott blokk szintaxisát vagy a literális blokk szintaxisát.
Type: string
Required: false
metaadatok
A metadata tulajdonság kulcs-érték párokat határoz meg a paraméter széljegyzeteiként. A DSC nem ellenőrzi a metaadatokat. A paraméterek tetszőleges információkat tartalmazhatnak ebben a tulajdonságban.
Type: object
Required: false
típus
Minden paraméternek meg kell határoznia a várt adattípust type tulajdonságként. A DSC minden átadott paraméter adattípusát ellenőrzi a konfigurációs művelet végrehajtása előtt.
A secure* adattípusok azt jelzik, hogy a DSC-nek és az integráló eszközöknek nem szabad naplózniuk vagy rögzíteni az értékeket. Ha olyan erőforráspéldány-tulajdonsághoz használ biztonságos adattípus-paramétert, amely nem számít biztonságos értékre, előfordulhat, hogy az erőforrás továbbra is naplózza vagy rögzíti az értéket. Ha az erőforrás független naplózással vagy rögzítéssel rendelkezik, amelyet nem a DSC kezel, az érték nem biztonságosan tárolható.
Használjon biztonságos sztringeket jelszavakhoz és titkos kódokhoz.
További információ az adattípusokról: DSC konfigurációs paraméter adattípus sémahivatkozása.
Type: string
Required: true
ValidValues: [string, securestring, int, bool, object, secureobject, array]
defaultValue
A paraméterek meghatározhatnak egy alapértelmezett értéket a defaultValue tulajdonsággal. Ha a paramétert nem továbbítja futásidőben, a DSC a paraméter alapértelmezett értékét használja. Ha a paraméter nem ad át futásidőben, és nincs megadva alapértelmezett érték, a DSC hibát jelez. Az értéknek érvényesnek kell lennie a paraméter type.
Required: false
ValidJSONTypes: [string, integer, object, array, boolean]
allowedValues
A paraméterek korlátozhatják a paraméter érvényes értékeinek készletét a allowedValues tulajdonság meghatározásával. A DSC ellenőrzi a futtatókörnyezetben átadott és defaultValue ként definiált paramétereket ezen értékek listájában. Ha bármelyik érték érvénytelen, a DSC hibát jelez.
Ez a tulajdonság mindig tömb. Ha ez a tulajdonság definiálva van, legalább egy elemet tartalmaznia kell az értékek listájában.
Type: array
Required: false
ValidItemJSONTypes: [string, integer, object, array, boolean]
minLength
A minLength tulajdonság a tömb- és sztringparaméterek érvényesítési lehetőségét határozza meg. A karakterlánc hossza a karakterszám. A tömb hossza az elemszám.
Ha a paraméter alapértelmezett értéke vagy futásideje ennél a tulajdonságnál rövidebb, a DSC hibát jelez. Ha ez a tulajdonság olyan paraméterekhez van definiálva, amelyek type nem array, stringvagy securestring, a DSC hibát jelez.
Ha ez a tulajdonság a maxLength tulajdonsággal van definiálva, ennek a tulajdonságnak kisebbnek kell lennie, mint maxLength. Ha nem, a DSC hibát jelez.
Type: int
Required: false
MinimumValue: 0
maxLength
A maxLength tulajdonság a tömb- és sztringparaméterek érvényesítési lehetőségét határozza meg. A karakterlánc hossza a karakterszám. A tömb hossza az elemszám.
Ha a paraméter alapértelmezett értéke vagy futásideje hosszabb ennél a tulajdonságnál, a DSC hibát jelez. Ha ez a tulajdonság olyan paraméterekhez van definiálva, amelyek type nem array, stringvagy securestring, a DSC hibát jelez.
Ha ez a tulajdonság a minLength tulajdonsággal van definiálva, ennek a tulajdonságnak nagyobbnak kell lennie, mint minLength. Ha nem, a DSC hibát jelez.
Type: int
Required: false
MinimumValue: 0
minValue
A minValue tulajdonság az egész szám paramétereinek érvényesítési beállítását határozza meg. Ha a paraméter alapértelmezett értéke vagy futásideje kisebb ennél a tulajdonságnál, a DSC hibát jelez. Ha ez a tulajdonság olyan paraméterekhez van definiálva, amelyek type nem int, a DSC hibát jelez.
Ha ez a tulajdonság a maxValue tulajdonsággal van definiálva, ennek a tulajdonságnak kisebbnek kell lennie, mint maxValue. Ha nem, a DSC hibát jelez.
Type: int
Required: false
maxValue
A maxValue tulajdonság az egész szám paramétereinek érvényesítési beállítását határozza meg. Ha a paraméter alapértelmezett értéke vagy futásideje nagyobb ennél a tulajdonságnál, a DSC hibát jelez. Ha ez a tulajdonság olyan paraméterekhez van definiálva, amelyek type nem int, a DSC hibát jelez.
Ha ez a tulajdonság a minValue tulajdonsággal van definiálva, ennek a tulajdonságnak nagyobbnak kell lennie, mint minValue. Ha nem, a DSC hibát jelez.
Type: int
Required: false
