Funções do Bicep para arquivos de parâmetros do Bicep

O Bicep fornece uma função chamada readEnvironmentVariable() que permite recuperar valores de variáveis de ambiente. Também oferece a flexibilidade de definir um valor padrão se a variável de ambiente não existir. Esta função só pode ser usada em .bicepparam arquivos.

getSecret

getSecret(subscriptionId, resourceGroupName, keyVaultName, secretName, secretVersion)

Essa função retorna um segredo de um Azure Key Vault. Use essa função para passar um segredo para o parâmetro de cadeia de caracteres segura de um arquivo Bicep.

Observação

Você também pode usar a função keyVaultName.getSecret(nomeDoSegredo) de dentro de um arquivo .bicep.

using './main.bicep'

param secureUserName = getSecret('exampleSubscription', 'exampleResourceGroup', 'exampleKeyVault', 'exampleSecretUserName')
param securePassword = getSecret('exampleSubscription', 'exampleResourceGroup', 'exampleKeyVault', 'exampleSecretPassword')

Você receberá um erro se usar esta função com interpolação da cadeia de caracteres.

Um qualificador de namespace (az) pode ser usado, mas é opcional, pois a função está disponível no namespace padrão do Azure.

Parâmetros

Parâmetro	Obrigatório	Type	Descrição
subscriptionId	Sim	string	A ID da assinatura que tem o recurso do cofre de chaves
resourceGroupName	Sim	string	O nome do grupo de recursos que tem o recurso do cofre de chaves
keyVaultName	Sim	string	O nome do cofre de chaves
secretName	Sim	string	O nome do segredo armazenado no cofre de chaves
secretVersion	Não	string	A versão do segredo armazenada no cofre de chaves

Valor retornado

O valor do segredo.

Exemplo

O arquivo a seguir tem um securePassword parâmetro que tem o valor mais recente do <segredo secretName>:.bicepparam

using './main.bicep'

param securePassword = getSecret('exampleSubscription', 'exampleResourceGroup', 'exampleKeyVault', 'exampleSecretPassword')

O arquivo a seguir tem um securePassword parâmetro que tem o valor do <segredo secretName>, mas está fixado em um secretValue> específico<:.bicepparam

using './main.bicep'

param securePassword = getSecret('exampleSubscription', 'exampleResourceGroup', 'exampleKeyVault', 'exampleSecretPassword', 'exampleSecretVersion')

readEnvironmentVariable

readEnvironmentVariable(variableName, [defaultValue])

Essa função retorna o valor da variável de ambiente ou define um valor padrão se a variável de ambiente não existir. O carregamento de variáveis ocorre durante a compilação e não em tempo de execução.

Namespace: sys.

Parâmetros

Parâmetro	Obrigatório	Type	Descrição
variableName	Sim	string	O nome da variável.
defaultValue	Não	string	Um valor de cadeia de caracteres padrão a ser usado se a variável de ambiente não existir.

Valor retornado

O valor retornado é o valor da cadeia de caracteres da variável de ambiente ou um valor padrão.

Comentários

O comando a seguir define a variável de ambiente somente para o processo do PowerShell no qual ela é executada. Você obtém BCP338 do Visual Studio Code:

$env:testEnvironmentVariable = "Hello World!"

Para definir a variável de ambiente no nível do usuário, execute o seguinte comando:

[System.Environment]::SetEnvironmentVariable('testEnvironmentVariable','Hello World!', 'User')

Para definir a variável de ambiente no nível da máquina, execute o seguinte comando:

[System.Environment]::SetEnvironmentVariable('testEnvironmentVariable','Hello World!', 'Machine')

Para obter mais informações, consulte Método Environment.SetEnvironmentVariable.

Exemplos

Os exemplos a seguir mostram como recuperar os valores das variáveis de ambiente:

use './main.bicep'

param adminPassword = readEnvironmentVariable('admin_password')
param boolfromEnvironmentVariables = bool(readEnvironmentVariable('boolVariableName','false'))

Próximas etapas

Para obter mais informações sobre arquivos de parâmetros do Bicep, consulte Criar arquivos de parâmetros para implantação do Bicep.