Parametri

Riepilogo

Restituisce il valore di un parametro di configurazione.

Sintassi

parameters('<name>')

Descrizione

La parameters() funzione restituisce il valore di un parametro specifico. È necessario passare il nome di un parametro valido. 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 del parametro a cui si fa riferimento non è valido per la proprietà, DSC genera un errore di convalida.

Per altre informazioni sulla definizione dei parametri in un documento di configurazione, vedere Schema dei parametri del documento di configurazione DSC.

Esempi

Esempio 1 - Usare un parametro come valore della proprietà dell'istanza di risorsa

La configurazione utilizza la parameters() funzione per eseguire l'eco del valore del message parametro.

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

Innanzitutto, ottieni lo stato corrente della configurazione senza sovrascrivere i parametri con - -parameters o --parameters_file opzioni. L'output mostra il valore predefinito per il message parametro.

config_file=parameters.example.1.dsc.config.yaml
cat $config_file | dsc config get

results:
- name: Echo message parameter
  type: Microsoft.DSC.Debug/Echo
  result:
    actualState:
      output: Hello, world!
messages: []
hadErrors: false

Quindi, sovrascrivi il message parametro con l'opzione --parameters .

params='{"parameters": {"message": "Hi, override."}}'
cat $config_file | dsc config --parameters $params get

results:
- name: Echo message parameter
  type: Microsoft.DSC.Debug/Echo
  result:
    actualState:
      output: Hi, override.
messages: []
hadErrors: false

Parametri

nome

La parameters() funzione prevede una singola stringa come input, che rappresenta il nome del parametro da restituire. Se nel documento di configurazione non viene definito alcun parametro con il nome specificato, DSC genera un errore durante la convalida.

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

Risultato

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

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