variablen

Zusammenfassung

Gibt den Wert einer Konfigurationsvariablen zurück.

Syntax

variables('<name>')

BESCHREIBUNG

Die variables() Funktion gibt den Wert einer bestimmten Variablen zurück. Sie müssen den Namen einer gültigen Variablen übergeben. Wenn Sie diese Funktion für eine Ressourceninstanz verwenden, überprüft DSC die Instanzeigenschaften nach dem Ausführen dieser Funktion und vor dem Aufrufen der Ressource für den aktuellen Vorgang. Wenn der Wert der Variablen, auf die verwiesen wird, für die Eigenschaft ungültig ist, löst DSC einen Validierungsfehler aus.

Weitere Informationen zum Definieren von Variablen in einem Konfigurationsdokument finden Sie unter Schemareferenz für DSC-Konfigurationsdokumente.

Beispiele

Beispiel 1: Verwenden einer Variablen als Eigenschaftswert für eine Ressourceninstanz

Beispiel-Synopse

# variables.example.1.dsc.config.yaml
$schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
variables:
  message: Hello, world!
resources:
  - name: Echo message variable
    type: Microsoft.DSC.Debug/Echo
    properties:
      output: "[variables('message')]"

dsc config get --file variables.example.1.dsc.config.yaml

results:
- metadata:
    Microsoft.DSC:
      duration: PT0.0883345S
  name: Echo message variable
  type: Microsoft.DSC.Debug/Echo
  result:
    actualState:
      output: Hello, world!

Die Parameter

Name

Die variables() Funktion erwartet eine einzelne Zeichenkette als Eingabe, die den Namen der zurückzugebenden Variablen darstellt. Wenn im Konfigurationsdokument keine Variable mit dem angegebenen Namen definiert ist, löst DSC während der Überprüfung einen Fehler aus.

Type:         string
Required:     true
MinimumCount: 1
MaximumCount: 1

Ausgabe

Die variables() Funktion gibt den Wert des angegebenen Parameters zurück.

Type: [string, int, bool, object, array]