Funciones de Bicep para archivos de parámetros de Bicep

Bicep proporciona una función llamada readEnvironmentVariable() que permite recuperar valores de variables de entorno. También ofrece la flexibilidad de establecer un valor predeterminado si la variable de entorno no existe. Esta función solo se puede usar en .bicepparam archivos.

getSecret

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

Esta función devuelve un secreto de una instancia de Azure Key Vault. Use esta función para pasar un secreto al parámetro de cadena segura de un archivo de Bicep.

Nota:

También puede usar la función keyVaultName.getSecret(secretName) desde dentro de un archivo .bicep.

using './main.bicep'

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

Se produce un error si usa esta función con interpolación de cadenas.

Se puede usar un calificador de espacio de nombres (az), pero es opcional, ya que la función está disponible en el espacio de nombres de Azure predeterminado .

Parámetros

Parámetro	Obligatorio	Type	Descripción
subscriptionId	Sí	string	Identificador de la suscripción que tiene el recurso del almacén de claves
resourceGroupName	Sí	string	Nombre del grupo de recursos que tiene el recurso del almacén de claves.
keyVaultName	Sí	string	Nombre del almacén de claves
secretName	Sí	string	Nombre del secreto almacenado en el almacén de claves
secretVersion	No	string	Versión del secreto almacenado en el almacén de claves

Valor devuelto

Valor del secreto.

Ejemplo

El archivo siguiente .bicepparam tiene un securePassword parámetro que tiene el valor más reciente del <secreto secretName> :

using './main.bicep'

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

El siguiente .bicepparam archivo tiene un securePassword parámetro que tiene el valor del< secreto secretName>, pero está anclado a un secretValue> específico:<

using './main.bicep'

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

readEnvironmentVariable

readEnvironmentVariable(variableName, [defaultValue])

Esta función devuelve el valor de la variable de entorno o establece un valor predeterminado si la variable de entorno no existe. La carga de variables se produce durante la compilación y no en tiempo de ejecución.

Espacio de nombres: sys.

Parámetros

Parámetro	Obligatorio	Type	Descripción
nombre_de_variable	Sí	string	El nombre de la variable.
defaultValue	No	string	Valor de cadena predeterminado que se va a usar si la variable de entorno no existe.

Valor devuelto

El valor devuelto es el valor de cadena de la variable de entorno o un valor predeterminado.

Comentarios

El comando siguiente establece la variable de entorno solo para el proceso de PowerShell en el que se ejecuta. Obtiene BCP338 de Visual Studio Code:

$env:testEnvironmentVariable = "Hello World!"

Para establecer la variable de entorno en el nivel de usuario, ejecute el siguiente comando:

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

Para establecer la variable de entorno en el nivel de máquina, ejecute el siguiente comando:

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

Para obtener más información, vea Environment.SetEnvironmentVariable (método).

Ejemplos

En los ejemplos siguientes se muestra cómo recuperar los valores de las variables de entorno:

use './main.bicep'

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

Pasos siguientes

Para obtener más información sobre los archivos de parámetros de Bicep, consulte Creación de archivos de parámetros para la implementación de Bicep.