Variabili

Riepilogo

Restituisce il valore di una variabile di configurazione.

Sintassi

variables('<name>')

Descrizione

La variables() funzione restituisce il valore di una variabile specifica. È necessario passare il nome di una variabile valida. Quando si usa questa funzione per un'istanza di risorsa, DSC convalida le proprietà dell'istanza dopo l'esecuzione di questa funzione e prima di chiamare la risorsa per l'operazione corrente. Se il valore della variabile a cui si fa riferimento non è valido per la proprietà, DSC genera un errore di convalida.

Per altre informazioni sulla definizione delle variabili in un documento di configurazione, vedere Informazioni di riferimento sullo schema del documento di configurazione DSC.

Esempi

Esempio 1 - Usare una variabile come valore della proprietà dell'istanza di risorsa

Esempio di sinossi

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

Parametri

nome

La variables() funzione prevede una singola stringa come input, che rappresenta il nome della variabile da restituire. Se nel documento di configurazione non viene definita alcuna variabile con il nome specificato, DSC genera un errore durante la convalida.

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

Risultato

La variables() funzione restituisce il valore del parametro specificato.

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