Função de arquivo de parâmetros para Bicep

O Bicep fornece uma função chamada readEnvironmentVariable() que permite recuperar valores de variáveis de ambiente. Ele 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 nos .bicepparam ficheiros. Para obter mais informações, consulte Arquivo de parâmetros do Bicep.

getSecret

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

Retorna um segredo de um Cofre de Chaves do Azure. Use esta função para passar um segredo para um parâmetro de cadeia de caracteres segura de um arquivo Bicep.

Nota

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

using './main.bicep'

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

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

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

Parâmetros

Parâmetro	Necessário	Type	Description
subscriptionId	Sim	string	A ID da assinatura que tem o recurso de 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 da chave.
secretVersion	Não	string	A versão do segredo armazenada no cofre de chaves.

Valor devolvido

O valor para o 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 parâmetro que tem o valor do segredo secretName><, mas está fixado a um secretValue> específico.<securePassword .bicepparam

using './main.bicep'

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

readEnvironmentVariable

readEnvironmentVariable(variableName, [defaultValue])

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, não em tempo de execução.

Espaço de nome: sys.

Parâmetros

Parâmetro	Necessário	Type	Description
nomevariável	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 devolvido

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

Observações

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, use o seguinte comando:

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

Para definir a variável de ambiente no nível da máquina, use 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 de variáveis de ambiente.

use './main.bicep'

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

Próximos passos

Para obter mais informações sobre o arquivo de parâmetros do Bicep, consulte Arquivo de parâmetros.