Dokumentparameterschema för DSC-konfiguration
Sammanfattning
Definierar körningsalternativ för en konfiguration.
Metadata
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
Beskrivning
DSC-konfigurationsdokument kan innehålla parametrar som användarna kan åsidosätta vid körning. Med parametrar kan du separera hemligheter från konfigurationsdefinitioner och göra det möjligt för användare att skriva konfigurationer som kan tillämpas på flera kontexter.
Parametrar definieras som nyckel/värde-par i egenskapen parameters för ett konfigurationsdokument.
Nyckeln är parameterns namn, som används för att referera till parametern i resurser egenskapen för konfigurationsdokumentet. Värdet är ett objekt som definierar parametern.
Varje parameter definierar dess datatyp. Parametrar kan också definiera ett standardvärde, valideringskontroller, en beskrivning av deras syfte och godtyckliga metadata.
Om du vill referera till parametrar i resursinstanser använder du konfigurationsfunktionen parameters().
Nödvändiga egenskaper
Egenskaper
beskrivning
Parametrar kan definiera en kort förklaring av deras syfte och användning med egenskapen description. Om du vill definiera en längre förklaring i YAML använder du den vikta blocksyntaxen eller literalblockssyntaxen.
Type: string
Required: false
metadata
Egenskapen metadata definierar en uppsättning nyckel/värde-par som anteckningar för parametern. DSC validerar inte metadata. En parameter kan innehålla godtycklig information i den här egenskapen.
Type: object
Required: false
typ
Varje parameter måste definiera den datatyp som den förväntar sig som egenskapen type. DSC verifierar datatypen för varje godkänd parameter innan en konfigurationsåtgärd körs.
De secure* datatyperna anger att DSC och integreringsverktyg inte ska logga eller registrera värdena. Om en säker datatypparameter används för en resursinstansegenskap som inte förväntar sig ett säkert värde kan resursen fortfarande logga eller registrera värdet. Om resursen har oberoende loggning eller inspelning som inte hanteras av DSC kan värdet lagras osäkert.
Använd säkra strängar för lösenord och hemligheter.
Mer information om datatyper finns i schemareferens för DSC-konfigurationsparameterdatatyp.
Type: string
Required: true
ValidValues: [string, securestring, int, bool, object, secureobject, array]
defaultValue
Parametrar kan definiera ett standardvärde med egenskapen defaultValue. Om parametern inte skickas vid körning använder DSC standardvärdet för parametern. Om parametern inte skickas vid körning och inget standardvärde har definierats genererar DSC ett fel. Värdet måste vara giltigt för parameterns type.
Required: false
ValidJSONTypes: [string, integer, object, array, boolean]
allowedValues
Parametrar kan begränsa uppsättningen med giltiga värden för parametern genom att definiera egenskapen allowedValues. DSC validerar parametrar som skickas vid körning och definieras som defaultValue mot den här listan med värden. Om något av värdena är ogiltigt genererar DSC ett fel.
Den här egenskapen är alltid en matris. Om den här egenskapen har definierats måste den innehålla minst ett objekt i listan med värden.
Type: array
Required: false
ValidItemJSONTypes: [string, integer, object, array, boolean]
minLength
Egenskapen minLength definierar ett valideringsalternativ för matris- och strängparametrar. Längden på en sträng är dess teckenantal. Längden på en matris är dess antal objekt.
Om standardvärdet eller körningsvärdet för parametern är kortare än den här egenskapen genererar DSC ett fel. Om den här egenskapen har definierats för parametrar vars type inte är array, stringeller securestring, genererar DSC ett fel.
Om den här egenskapen definieras med egenskapen maxLength måste den här egenskapen vara mindre än maxLength. Om det inte är det genererar DSC ett fel.
Type: int
Required: false
MinimumValue: 0
maxLength
Egenskapen maxLength definierar ett valideringsalternativ för matris- och strängparametrar. Längden på en sträng är dess teckenantal. Längden på en matris är dess antal objekt.
Om standardvärdet eller körningsvärdet för parametern är längre än den här egenskapen genererar DSC ett fel. Om den här egenskapen har definierats för parametrar vars type inte är array, stringeller securestring, genererar DSC ett fel.
Om den här egenskapen definieras med egenskapen minLength måste den här egenskapen vara större än minLength. Om det inte är det genererar DSC ett fel.
Type: int
Required: false
MinimumValue: 0
minValue
Egenskapen minValue definierar ett valideringsalternativ för heltalsparametrar. Om standardvärdet eller körningsvärdet för parametern är mindre än den här egenskapen genererar DSC ett fel. Om den här egenskapen har definierats för parametrar vars type inte är intgenererar DSC ett fel.
Om den här egenskapen definieras med egenskapen maxValue måste den här egenskapen vara mindre än maxValue. Om det inte är det genererar DSC ett fel.
Type: int
Required: false
maxValue
Egenskapen maxValue definierar ett valideringsalternativ för heltalsparametrar. Om standardvärdet eller körningsvärdet för parametern är större än den här egenskapen genererar DSC ett fel. Om den här egenskapen har definierats för parametrar vars type inte är intgenererar DSC ett fel.
Om den här egenskapen definieras med egenskapen minValue måste den här egenskapen vara större än minValue. Om det inte är det genererar DSC ett fel.
Type: int
Required: false
