parametrar

2025-07-10

Sammanfattning

Returnerar värdet för en konfigurationsparameter.

Syntax

parameters('<name>')

Beskrivning

Funktionen parameters() returnerar värdet för en specifik parameter. Du måste skicka namnet på en giltig parameter. 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 parametervärdet är ogiltigt för egenskapen genererar DSC ett valideringsfel.

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

Exempel

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

Konfigurationen använder parameters() funktionen för att upprepa parameterns värde message .

# 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')]"

Hämta först det aktuella tillståndet för konfigurationen utan att åsidosätta parametrarna med --parameters eller --parameters_file alternativen. Utdata visar standardvärdet för parametern message .

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

Åsidosätt message sedan parametern med alternativet --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

Parameterar

namn

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

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

Utgång

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

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