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

  • Artigo

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. Essa função só pode ser usada nos arquivos .bicepparam. Para obter mais informações, confira Arquivo de parâmetros do Bicep.

getSecret

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

Retorna um segredo do Azure Key Vault. Use esta função para passar um segredo para um parâmetro de cadeia de caracteres seguro 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.

É possível usar um qualificador de namespace (az), mas é opcional, pois a função está disponível no Namespace do Azure padrão.

Parâmetros

Parâmetro Obrigatório Type Descrição
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 de 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 armazenado no cofre de chaves.

Retornar valor

O valor do segredo.

Exemplo

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

using './main.bicep'

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

O arquivo .bicepparam a seguir possui um parâmetro securePassword que possui o valor do segredo <secretName>, mas está fixado em um determinado <secretValue>.

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ável ocorre durante a compilação, não em runtime.

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 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, 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 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 sobreo arquivo de parâmetros do Bicep, confira Arquivo de parâmetros.