parameters

Sinopse

Retorna o valor de um parâmetro de configuração.

Sintaxe

parameters('<name>')

Descrição

A parameters() função retorna o valor de um parâmetro específico. Você deve passar o nome de um parâmetro válido. Ao usar essa função para uma instância de recurso, o DSC valida as propriedades da instância após a execução dessa função e antes de chamar o recurso para a operação atual. Se o valor do parâmetro referenciado for inválido para a propriedade , o DSC gerará um erro de validação.

Para obter mais informações sobre como definir parâmetros em um documento de configuração, consulte Esquema de parâmetro de documento de configuração de DSC.

Exemplos

Exemplo 1 – Usar um parâmetro como um valor de propriedade de instância de recurso

A configuração usa a parameters() função para ecoar o valor do message parâmetro .

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

Primeiro, obtenha o estado atual da configuração sem substituir os parâmetros com os parâmetros ou--parameters_file opções --. A saída mostra o valor padrão para o message parâmetro .

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

Em seguida, substitua o message parâmetro pela opção --parameters .

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

Parâmetros

name

A parameters() função espera uma única cadeia de caracteres como entrada, representando o nome do parâmetro a ser retornado. Se nenhum parâmetro com o nome especificado for definido no documento de configuração, o DSC gerará um erro durante a validação.

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

Saída

A parameters() função retorna o valor do parâmetro especificado.

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