envvar
Sinopse
Retorna o valor de uma variável de ambiente.
Sintaxe
envvar(<variableName>)
Descrição
A envvar()
função retorna o valor de uma variável de ambiente como uma cadeia de caracteres. Se a variável de ambiente não existir, o DSC gerará um erro.
Exemplos
Exemplo 1 – Referenciar DSC_CONFIG_ROOT em uma configuração
Quando você usa a opção --path
para especificar um documento de configuração para qualquer um dos comandos, o dsc config *
DSC cria automaticamente a DSC_CONFIG_ROOT
variável de ambiente e define o valor como a pasta pai do documento de configuração especificado. Para obter mais informações, consulte referência de comando dsc config.
Essa configuração ecoa essa pasta com o Test/Echo
recurso .
# ./examples/envvar.example.1.dsc.config.yaml
$schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/config/document.json
resources:
- name: Echo 'DSC_CONFIG_ROOT' in envvar
type: Test/Echo
properties:
output: "[envvar('DSC_CONFIG_ROOT')]"
dsc config get --path ~/dsc/examples/envvar.example.1.dsc.config.yaml
results:
- name: Echo DSC_CONFIG_ROOT
type: Test/Echo
result:
actualState:
output: ~/dsc/examples
messages: []
hadErrors: false
Parâmetros
variableName
A envvar()
função espera uma única cadeia de caracteres que representa o nome da variável de ambiente a ser usada. Se o valor não for uma cadeia de caracteres, o DSC gerará um erro ao validar o documento de configuração. Se a variável de ambiente nomeada pela entrada não existir, o DSC gerará um erro.
Type: string
Required: true
MinimumCount: 1
MaximumCount: 1
Saída
A envvar()
função retorna o valor da variável de ambiente especificada com o parâmetro variableName .
Type: string