envvar

Artikel
05/11/2024

Synopsis

Returnerar värdet för en miljövariabel.

Syntax

envvar(<variableName>)

Description

Funktionen envvar() returnerar värdet för en miljövariabel som en sträng. Om miljövariabeln inte finns genererar DSC ett fel.

Exempel

Exempel 1 – Referens DSC_CONFIG_ROOT i en konfiguration

När du använder --path alternativet för att ange ett konfigurationsdokument för något av dsc config * kommandona skapar DSC_CONFIG_ROOT DSC automatiskt miljövariabeln och anger värdet till den överordnade mappen i det angivna konfigurationsdokumentet. Mer information finns i kommandoreferensen dsc config.

Den här konfigurationen ekar mappen med resursen 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

Parametrar

variableName

Funktionen envvar() förväntar sig att en enskild sträng representerar namnet på miljövariabeln som ska användas. Om värdet inte är en sträng genererar DSC ett fel när konfigurationsdokumentet verifieras. Om miljövariabeln som namnges av indata inte finns, genererar DSC ett fel.

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

Utdata

Funktionen envvar() returnerar värdet för miljövariabeln som anges med parametern variableName .

Type: string

Dela via