Schéma de paramètre de document de configuration DSC

Synopsis

Définit les options d’exécution d’une configuration.

Métadonnées

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

Description

Les documents de configuration DSC peuvent inclure des paramètres, que les utilisateurs peuvent remplacer au moment de l’exécution. Les paramètres permettent de séparer les secrets des définitions de configuration et d’autoriser les utilisateurs à écrire des configurations qui peuvent s’appliquer à plusieurs contextes.

Les paramètres sont définis en tant que paires clé-valeur dans la propriété parameters d’un document de configuration. La clé est le nom du paramètre, utilisé pour référencer le paramètre dans les ressources propriété du document de configuration. La valeur est un objet qui définit le paramètre.

Chaque paramètre définit son type de données. Les paramètres peuvent également définir une valeur par défaut, des vérifications de validation, une description de leur objectif et des métadonnées arbitraires.

Pour référencer des paramètres dans les instances de ressources, utilisez la fonction de configuration parameters().

Propriétés requises

• type

Propriétés

description

Les paramètres peuvent définir une brève explication de leur objectif et de leur utilisation avec la propriété description. Pour définir une explication plus longue dans YAML, utilisez la syntaxe de bloc pliée ou la syntaxe de bloc littéral.

Type:     string
Required: false

métadonnées

La propriété metadata définit un ensemble de paires clé-valeur comme annotations pour le paramètre. DSC ne valide pas les métadonnées. Un paramètre peut inclure des informations arbitraires dans cette propriété.

Type:     object
Required: false

type

Chaque paramètre doit définir le type de données attendu comme propriété type. DSC valide le type de données pour chaque paramètre passé avant d’exécuter une opération de configuration.

Les types de données secure* indiquent que DSC et les outils d’intégration ne doivent pas journaliser ni enregistrer les valeurs. Si un paramètre de type de données sécurisé est utilisé pour une propriété d’instance de ressource qui ne s’attend pas à une valeur sécurisée, la ressource peut toujours enregistrer ou enregistrer la valeur. Si la ressource a une journalisation ou un enregistrement indépendant qui n’est pas géré par DSC, la valeur peut être stockée de manière non sécurisée.

Utilisez des chaînes sécurisées pour les mots de passe et les secrets.

Pour plus d’informations sur les types de données, consultez référence de schéma de type de données de paramètre de configuration DSC.

Type:        string
Required:    true
ValidValues: [string, securestring, int, bool, object, secureobject, array]

defaultValue

Les paramètres peuvent définir une valeur par défaut avec la propriété defaultValue. Si le paramètre n’est pas passé au moment de l’exécution, DSC utilise la valeur par défaut pour le paramètre. Si le paramètre n’est pas passé au moment de l’exécution et qu’aucune valeur par défaut n’est définie, DSC génère une erreur. La valeur doit être valide pour la typedu paramètre.

Required:       false
ValidJSONTypes: [string, integer, object, array, boolean]

allowedValues

Les paramètres peuvent limiter l’ensemble de valeurs valides pour le paramètre en définissant la propriété allowedValues. DSC valide les paramètres passés au moment de l’exécution et définis en tant que defaultValue par rapport à cette liste de valeurs. Si l’une des valeurs n’est pas valide, DSC génère une erreur.

Cette propriété est toujours un tableau. Si cette propriété est définie, elle doit inclure au moins un élément dans la liste des valeurs.

Type:               array
Required:           false
ValidItemJSONTypes: [string, integer, object, array, boolean]

minLength

La propriété minLength définit une option de validation pour les paramètres de tableau et de chaîne. La longueur d’une chaîne est son nombre de caractères. La longueur d’un tableau est son nombre d’éléments.

Si la valeur par défaut ou la valeur d’exécution du paramètre est plus courte que cette propriété, DSC génère une erreur. Si cette propriété est définie pour les paramètres dont type n’est pas array, stringou securestring, DSC génère une erreur.

Si cette propriété est définie avec la propriété maxLength, cette propriété doit être inférieure à maxLength. Si ce n’est pas le cas, DSC génère une erreur.

Type:         int
Required:     false
MinimumValue: 0

maxLength

La propriété maxLength définit une option de validation pour les paramètres de tableau et de chaîne. La longueur d’une chaîne est son nombre de caractères. La longueur d’un tableau est son nombre d’éléments.

Si la valeur par défaut ou la valeur d’exécution du paramètre est supérieure à cette propriété, DSC génère une erreur. Si cette propriété est définie pour les paramètres dont type n’est pas array, stringou securestring, DSC génère une erreur.

Si cette propriété est définie avec la propriété minLength, cette propriété doit être supérieure à minLength. Si ce n’est pas le cas, DSC génère une erreur.

Type:         int
Required:     false
MinimumValue: 0

minValue

La propriété minValue définit une option de validation pour les paramètres entiers. Si la valeur par défaut ou la valeur d’exécution du paramètre est inférieure à cette propriété, DSC génère une erreur. Si cette propriété est définie pour les paramètres dont type n’est pas int, DSC génère une erreur.

Si cette propriété est définie avec la propriété maxValue, cette propriété doit être inférieure à maxValue. Si ce n’est pas le cas, DSC génère une erreur.

Type:     int
Required: false

maxValue

La propriété maxValue définit une option de validation pour les paramètres entiers. Si la valeur par défaut ou la valeur d’exécution du paramètre est supérieure à cette propriété, DSC génère une erreur. Si cette propriété est définie pour les paramètres dont type n’est pas int, DSC génère une erreur.

Si cette propriété est définie avec la propriété minValue, cette propriété doit être supérieure à minValue. Si ce n’est pas le cas, DSC génère une erreur.

Type:     int
Required: false