DSC-Konfigurationsdokumentparameterschema
Zusammenfassung
Definiert Laufzeitoptionen für eine Konfiguration.
Metadaten
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
Beschreibung
DSC-Konfigurationsdokumente können Parameter enthalten, die Benutzer zur Laufzeit überschreiben können. Parameter ermöglichen das Trennen von geheimen Schlüsseln aus Konfigurationsdefinitionen und ermöglichen Benutzern das Schreiben von Konfigurationen, die auf mehrere Kontexte angewendet werden können.
Parameter werden als Schlüsselwertpaare in der parameters Eigenschaft eines Konfigurationsdokuments definiert.
Der Schlüssel ist der Name des Parameters, der verwendet wird, um auf den Parameter in den Ressourcen Eigenschaft des Konfigurationsdokuments zu verweisen. Der Wert ist ein Objekt, das den Parameter definiert.
Jeder Parameter definiert seinen Datentyp. Parameter können auch einen Standardwert, Überprüfungsprüfungen, eine Beschreibung ihres Zwecks und beliebige Metadaten definieren.
Verwenden Sie zum Verweisen auf Parameter in Ressourceninstanzen die konfigurationsfunktion parameters().
Erforderliche Eigenschaften
Eigenschaften
Beschreibung
Parameter können eine kurze Erläuterung ihres Zwecks und ihrer Verwendung mit der description-Eigenschaft definieren. Verwenden Sie zum Definieren einer längeren Erklärung in YAML die Syntax des gefalteten Blocks oder die Literalblocksyntax.
Type: string
Required: false
Metadaten
Die metadata-Eigenschaft definiert eine Reihe von Schlüsselwertpaaren als Anmerkungen für den Parameter. DSC überprüft die Metadaten nicht. Ein Parameter kann beliebige Informationen in dieser Eigenschaft enthalten.
Type: object
Required: false
Art
Jeder Parameter muss den Datentyp definieren, den er als type-Eigenschaft erwartet. DSC überprüft den Datentyp für jeden übergebenen Parameter, bevor ein Konfigurationsvorgang ausgeführt wird.
Die secure* Datentypen deuten darauf hin, dass DSC und Integrationstools die Werte nicht protokollieren oder aufzeichnen sollten. Wenn ein sicherer Datentypparameter für eine Ressourceninstanzeigenschaft verwendet wird, die keinen sicheren Wert erwartet, protokolliert oder zeichnet die Ressource den Wert möglicherweise noch auf. Wenn die Ressource über eine unabhängige Protokollierung oder Aufzeichnung verfügt, die nicht von DSC behandelt wird, kann der Wert unsicher gespeichert werden.
Verwenden Sie sichere Zeichenfolgen für Kennwörter und geheime Schlüssel.
Weitere Informationen zu Datentypen finden Sie unter DSC-Konfigurationsparameterschemareferenz.
Type: string
Required: true
ValidValues: [string, securestring, int, bool, object, secureobject, array]
defaultValue
Parameter können einen Standardwert mit der eigenschaft defaultValue definieren. Wenn der Parameter zur Laufzeit nicht übergeben wird, verwendet DSC den Standardwert für den Parameter. Wenn der Parameter zur Laufzeit nicht übergeben wird und kein Standardwert definiert ist, löst DSC einen Fehler aus. Der Wert muss für die typedes Parameters gültig sein.
Required: false
ValidJSONTypes: [string, integer, object, array, boolean]
allowedValues
Parameter können den Satz gültiger Werte für den Parameter einschränken, indem die allowedValues-Eigenschaft definiert wird. DSC überprüft Parameter, die zur Laufzeit übergeben und als defaultValue für diese Werteliste definiert sind. Wenn einer der Werte ungültig ist, löst DSC einen Fehler aus.
Diese Eigenschaft ist immer ein Array. Wenn diese Eigenschaft definiert ist, muss sie mindestens ein Element in der Liste der Werte enthalten.
Type: array
Required: false
ValidItemJSONTypes: [string, integer, object, array, boolean]
minLength
Die minLength-Eigenschaft definiert eine Überprüfungsoption für Array- und Zeichenfolgenparameter. Die Länge einer Zeichenfolge ist die Anzahl der Zeichen. Die Länge eines Arrays ist die Elementanzahl.
Wenn der Standardwert oder Laufzeitwert für den Parameter kürzer als diese Eigenschaft ist, löst DSC einen Fehler aus. Wenn diese Eigenschaft für Parameter definiert ist, deren type nicht array, stringoder securestringist, löst DSC einen Fehler aus.
Wenn diese Eigenschaft mit der maxLength-Eigenschaft definiert ist, muss diese Eigenschaft kleiner als maxLengthsein. Andernfalls löst DSC einen Fehler aus.
Type: int
Required: false
MinimumValue: 0
maxLength
Die maxLength-Eigenschaft definiert eine Überprüfungsoption für Array- und Zeichenfolgenparameter. Die Länge einer Zeichenfolge ist die Anzahl der Zeichen. Die Länge eines Arrays ist die Elementanzahl.
Wenn der Standardwert oder Laufzeitwert für den Parameter länger als diese Eigenschaft ist, löst DSC einen Fehler aus. Wenn diese Eigenschaft für Parameter definiert ist, deren type nicht array, stringoder securestringist, löst DSC einen Fehler aus.
Wenn diese Eigenschaft mit der minLength-Eigenschaft definiert ist, muss diese Eigenschaft größer als minLengthsein. Andernfalls löst DSC einen Fehler aus.
Type: int
Required: false
MinimumValue: 0
minValue
Die minValue-Eigenschaft definiert eine Überprüfungsoption für ganzzahlige Parameter. Wenn der Standardwert oder Laufzeitwert für den Parameter kleiner als diese Eigenschaft ist, löst DSC einen Fehler aus. Wenn diese Eigenschaft für Parameter definiert ist, deren type nicht intist, löst DSC einen Fehler aus.
Wenn diese Eigenschaft mit der maxValue-Eigenschaft definiert ist, muss diese Eigenschaft kleiner als maxValuesein. Andernfalls löst DSC einen Fehler aus.
Type: int
Required: false
maxValue
Die maxValue-Eigenschaft definiert eine Überprüfungsoption für ganzzahlige Parameter. Wenn der Standardwert oder Laufzeitwert für den Parameter größer als diese Eigenschaft ist, löst DSC einen Fehler aus. Wenn diese Eigenschaft für Parameter definiert ist, deren type nicht intist, löst DSC einen Fehler aus.
Wenn diese Eigenschaft mit der minValue-Eigenschaft definiert ist, muss diese Eigenschaft größer als minValuesein. Andernfalls löst DSC einen Fehler aus.
Type: int
Required: false
