Variabler

Sammanfattning

Returnerar värdet för en konfigurationsvariabel.

Syntax

variables('<name>')

Beskrivning

Funktionen variables() returnerar värdet för en specifik variabel. Du måste skicka namnet på en giltig variabel. När du använder den här funktionen för en resursinstans verifierar DSC instansegenskaperna när den här funktionen har körts och innan resursen anropas för den aktuella åtgärden. Om det refererade variabelvärdet är ogiltigt för egenskapen genererar DSC ett valideringsfel.

Mer information om hur du definierar variabler i ett konfigurationsdokument finns i Schemareferens för DSC-konfigurationsdokument.

Exempel

Exempel 1 – Använd en variabel som ett egenskapsvärde för en resursinstans

Exempel på synopsis

# 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!

Parameterar

namn

Funktionen variables() förväntar sig en enda sträng som indata, som representerar namnet på variabeln som ska returneras. Om ingen variabel med det angivna namnet definieras i konfigurationsdokumentet genererar DSC ett fel under valideringen.

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

Utgång

Funktionen variables() returnerar värdet för den angivna parametern.

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