Fonctions Bicep pour les fichiers de paramètres Bicep

Bicep fournit une fonction appelée readEnvironmentVariable() qui vous permet de récupérer des valeurs à partir de variables d’environnement. Il offre également la possibilité de définir une valeur par défaut si la variable d’environnement n’existe pas. Cette fonction ne peut être utilisée que dans les .bicepparam fichiers.

getSecret

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

Cette fonction retourne un secret à partir d’un coffre de clés Azure. Utilisez cette fonction pour passer un secret au paramètre de chaîne sécurisée d’un fichier Bicep.

Remarque

Vous pouvez également utiliser la fonction keyVaultName.getSecret(secretName) à partir d’un fichier .bicep.

using './main.bicep'

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

Vous recevez une erreur si vous utilisez cette fonction avec l’interpolation de chaîne.

Un qualificateur d’espace de noms (az) peut être utilisé, mais il est facultatif, car la fonction est disponible à partir de l’espace de noms Azure par défaut.

Paramètres

Paramètre	Obligatoire	Type	Description
subscriptionId	Oui	string	ID de l’abonnement qui a la ressource key vault
resourceGroupName	Oui	string	Nom du groupe de ressources qui a la ressource du coffre de clés
keyVaultName	Oui	string	Nom du coffre de clés
secretName	Oui	string	Nom du secret stocké dans le coffre de clés
secretVersion	Non	string	Version du secret stocké dans le coffre de clés

Valeur retournée

Valeur du secret.

Exemple

Le fichier suivant a un securePassword paramètre qui a la dernière valeur du< secret secretName> :.bicepparam

using './main.bicep'

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

Le fichier suivant .bicepparam a un securePassword paramètre qui a la valeur du <secret secretName>, mais il est épinglé à un secretValue> spécifique <:

using './main.bicep'

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

readEnvironmentVariable

readEnvironmentVariable(variableName, [defaultValue])

Cette fonction retourne la valeur de la variable d’environnement ou définit une valeur par défaut si la variable d’environnement n’existe pas. Le chargement des variables se produit pendant la compilation et non au moment de l’exécution.

Espace de noms : sys.

Paramètres

Paramètre	Obligatoire	Type	Description
variableName	Oui	string	Nom de la variable.
defaultValue	Non	string	Valeur de chaîne par défaut à utiliser si la variable d’environnement n’existe pas.

Valeur retournée

La valeur de retour est la valeur de chaîne de la variable d’environnement ou une valeur par défaut.

Notes

La commande suivante définit la variable d’environnement uniquement pour le processus PowerShell dans lequel elle est exécutée. Vous obtenez BCP338 à partir de Visual Studio Code :

$env:testEnvironmentVariable = "Hello World!"

Pour définir la variable d’environnement au niveau de l’utilisateur, exécutez la commande suivante :

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

Pour définir la variable d’environnement au niveau de l’ordinateur, exécutez la commande suivante :

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

Pour plus d’informations, consultez La méthode Environment.SetEnvironmentVariable.

Exemples

Les exemples suivants montrent comment récupérer les valeurs des variables d’environnement :

use './main.bicep'

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

Étapes suivantes

Pour plus d’informations sur les fichiers de paramètres Bicep, consultez Créer des fichiers de paramètres pour le déploiement Bicep.