Parameterfilfunktion för Bicep

Bicep tillhandahåller en funktion med namnet readEnvironmentVariable() som gör att du kan hämta värden från miljövariabler. Det ger också flexibiliteten att ange ett standardvärde om miljövariabeln inte finns. Den här funktionen kan bara användas i .bicepparam filerna. Mer information finns i filen med Bicep-parametrar.

getSecret

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

Returnerar en hemlighet från ett Azure Key Vault. Använd den här funktionen för att skicka en hemlighet till en säker strängparameter för en Bicep-fil.

Kommentar

Du kan också använda funktionen keyVaultName.getSecret(secretName) inifrån en .bicep fil.

using './main.bicep'

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

Du får ett fel om du använder den här funktionen med stränginterpolation.

En namnområdeskvalificerare (az) kan användas, men det är valfritt, eftersom funktionen är tillgänglig från azure-standardnamnområdet .

Parametrar

Parameter	Obligatoriskt	Type	Beskrivning
subscriptionId	Ja	sträng	ID:t för prenumerationen som har nyckelvalvsresursen.
resourceGroupName	Ja	sträng	Namnet på resursgruppen som har nyckelvalvsresursen.
keyVaultName	Ja	sträng	Namnet på nyckelvalvet.
secretName	Ja	sträng	Namnet på hemligheten som lagras i nyckelvalvet.
secretVersion	Nej	sträng	Den version av hemligheten som lagras i nyckelvalvet.

Returvärde

Värdet för hemligheten.

Exempel

Följande .bicepparam fil har en securePassword parameter som har det senaste värdet för hemligheten <secretName> .

using './main.bicep'

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

Följande .bicepparam fil har en securePassword parameter som har värdet för hemligheten< secretName>, men den är fäst på en specifik< secretValue.>

using './main.bicep'

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

readEnvironmentVariable

readEnvironmentVariable(variableName, [defaultValue])

Returnerar värdet för miljövariabeln eller anger ett standardvärde om miljövariabeln inte finns. Variabelinläsning sker under kompilering, inte vid körning.

Namnområde: sys.

Parametrar

Parameter	Obligatoriskt	Type	Beskrivning
variableName	Ja	sträng	Namnet på variabeln.
Standardvärde	Nej	sträng	Ett standardsträngvärde som ska användas om miljövariabeln inte finns.

Returvärde

Strängvärdet för miljövariabeln eller ett standardvärde.

Exempel

I följande exempel visas hur du hämtar värdena för miljövariabler.

use './main.bicep'

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

Nästa steg

Mer information om filen med Bicep-parametrar finns i Parameterfil.