parametrar

Artikel
05/11/2024

Synopsis

Returnerar värdet för en konfigurationsparameter.

Syntax

parameters('<name>')

Description

Funktionen parameters() returnerar värdet för en specifik parameter. Du måste ange namnet på en giltig parameter. När du använder den här funktionen för en resursinstans validerar 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 DSC-konfigurationsdokumentparameterschema.

Exempel

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

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

# parameters.example.1.dsc.config.yaml
$schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/config/document.json
parameters:
  message:
    type:         string
    defaultValue: Hello, world!
resources:
  - name: Echo message parameter
    type: Test/Echo
    properties:
      text: "[parameters('message')]"

Hämta först konfigurationens aktuella tillstånd utan att åsidosätta parametrarna med --parameters eller --parameters_file --options. 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: Test/Echo
  result:
    actualState:
      text: Hello, world!
messages: []
hadErrors: false

Åsidosätt sedan parametern message--parameters med alternativet .

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

results:
- name: Echo message parameter
  type: Test/Echo
  result:
    actualState:
      text: Hi, override.
messages: []
hadErrors: false

Parametrar

name

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

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

Utdata

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

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

Dela via