envvar

Artikel
05/11/2024

Zusammenfassung

Gibt den Wert einer Umgebungsvariable zurück.

Syntax

envvar(<variableName>)

BESCHREIBUNG

Die envvar() Funktion gibt den Wert einer Umgebungsvariablen als Zeichenfolge zurück. Wenn die Umgebungsvariable nicht vorhanden ist, löst DSC einen Fehler aus.

Beispiele

Beispiel 1: Referenz DSC_CONFIG_ROOT in einer Konfiguration

Wenn Sie die --path Option zum Angeben eines Konfigurationsdokuments für einen der dsc config * Befehle verwenden, erstellt DSC automatisch die DSC_CONFIG_ROOT Umgebungsvariable und legt den Wert auf den übergeordneten Ordner des angegebenen Konfigurationsdokuments fest. Weitere Informationen finden Sie in der Referenz zu dsc-Konfigurationsbefehlen.

Diese Konfiguration gibt diesen Ordner mit der Ressource an Test/Echo .

# ./examples/envvar.example.1.dsc.config.yaml
$schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/config/document.json
resources:
  - name: Echo 'DSC_CONFIG_ROOT' in envvar
    type: Test/Echo
    properties:
      output: "[envvar('DSC_CONFIG_ROOT')]"

dsc config get --path ~/dsc/examples/envvar.example.1.dsc.config.yaml

results:
- name: Echo DSC_CONFIG_ROOT
  type: Test/Echo
  result:
    actualState:
      output: ~/dsc/examples
messages: []
hadErrors: false

Parameter

variableName

Die envvar() Funktion erwartet eine einzelne Zeichenfolge, die den Namen der Umgebungsvariablen darstellt. Wenn der Wert keine Zeichenfolge ist, löst DSC beim Überprüfen des Konfigurationsdokuments einen Fehler aus. Wenn die von der Eingabe benannte Umgebungsvariable nicht vorhanden ist, löst DSC einen Fehler aus.

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

Ausgabe

Die envvar() Funktion gibt den Wert der Umgebungsvariablen zurück, die mit dem parameter variableName angegeben wurde.

Type: string

Freigeben über