A Bicep paraméterfájlfüggvénye

A Bicep egy úgynevezett readEnvironmentVariable() függvényt biztosít, amely lehetővé teszi az értékek lekérését a környezeti változókból. Emellett rugalmasan állíthat be alapértelmezett értéket, ha a környezeti változó nem létezik. Ez a függvény csak a .bicepparam fájlokban használható. További információ: Bicep parameters file.

getSecret

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

Egy Titkos kulcsot ad vissza egy Azure Key Vaultból. Ezzel a függvénnyel titkos kódot adhat át egy Bicep-fájl biztonságos sztringparaméterének.

Feljegyzés

A keyVaultName.getSecret(secretName) függvényt egy fájlból .bicep is használhatja.

using './main.bicep'

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

Hibaüzenet jelenik meg, ha sztringinterpolációval használja ezt a függvényt.

A névtér-minősítő (az) használható, de nem kötelező, mert a függvény az alapértelmezett Azure-Namespace érhető el.

Paraméterek

Paraméter	Kötelező	Típus	Leírás
subscriptionId	Igen	húr	A Key Vault-erőforrást tartalmazó előfizetés azonosítója.
resourceGroupName	Igen	húr	Annak az erőforráscsoportnak a neve, amely rendelkezik a key vault erőforrásával.
keyVaultName	Igen	húr	A kulcstartó neve.
secretName	Igen	húr	A kulcstartóban tárolt titkos kód neve.
secretVersion	Nem	húr	A kulcstartóban tárolt titkos kód verziója.

Visszaadott érték

A titkos kód értéke.

Példa

A következő .bicepparam fájl egy securePassword olyan paraméterrel rendelkezik, amely a <secretName> titkos kód legújabb értékét tartalmazza.

using './main.bicep'

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

A következő .bicepparam fájl egy securePassword olyan paraméterrel rendelkezik, amely a <secretName> titkos kód értékét tartalmazza, de egy adott <secretValue-ra van rögzítve>.

using './main.bicep'

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

readEnvironmentVariable

readEnvironmentVariable(variableName, [defaultValue])

Visszaadja a környezeti változó értékét, vagy beállít egy alapértelmezett értéket, ha a környezeti változó nem létezik. A változó betöltése fordítás közben történik, nem futásidőben.

Namespace: sys.

Paraméterek

Paraméter	Kötelező	Típus	Leírás
variableName	Igen	húr	A változó neve.
defaultValue	Nem	húr	Alapértelmezett sztringérték, amelyet akkor kell használni, ha a környezeti változó nem létezik.

Visszaadott érték

A környezeti változó vagy egy alapértelmezett érték sztringértéke.

Megjegyzések

Az alábbi parancs csak arra a PowerShell-folyamatra állítja be a környezeti változót, amelyben a rendszer végrehajtja. A BCP338 a Visual Studio Code-ból származik.

$env:testEnvironmentVariable = "Hello World!"

Ha felhasználói szinten szeretné beállítani a környezeti változót, használja a következő parancsot:

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

A környezeti változó gépszintű beállításához használja a következő parancsot:

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

További információ: Environment.SetEnvironmentVariable Metódus.

Példák

Az alábbi példák bemutatják, hogyan lehet lekérni a környezeti változók értékeit.

use './main.bicep'

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

Következő lépések

A Bicep-paraméterek fájljáról további információt a Paraméterek fájlban talál.