Funkce souboru Parameters pro Bicep

Bicep poskytuje funkci, readEnvironmentVariable() která umožňuje načíst hodnoty z proměnných prostředí. Nabízí také flexibilitu nastavit výchozí hodnotu, pokud proměnná prostředí neexistuje. Tuto funkci lze použít pouze v souborech .bicepparam . Další informace naleznete v souboru parametrů Bicep.

getSecret

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

Vrátí tajný klíč ze služby Azure Key Vault. Tato funkce slouží k předání tajného klíče do zabezpečeného řetězcového parametru souboru Bicep.

Poznámka:

Můžete také použít funkci keyVaultName.getSecret(secretName) z souboru .bicep .

using './main.bicep'

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

Pokud používáte tuto funkci s interpolací řetězců, zobrazí se chyba.

Kvalifikátor oboru názvů (az) je možné použít, ale je volitelný, protože tato funkce je k dispozici ve výchozím oboru názvů Azure.

Parametry

Parametr	Požaduje se	Type	Popis
subscriptionId	Ano	string	ID předplatného, které má prostředek trezoru klíčů.
resourceGroupName	Ano	string	Název skupiny prostředků, která má prostředek trezoru klíčů.
keyVaultName	Ano	string	Název trezoru klíčů.
secretName	Ano	string	Název tajného kódu uloženého v trezoru klíčů.
secretVersion	No	string	Verze tajného kódu uloženého v trezoru klíčů.

Vrácená hodnota

Hodnota tajného kódu.

Příklad

Následující soubor obsahuje securePassword parametr, který má nejnovější hodnotu tajného <klíče secretName>..bicepparam

using './main.bicep'

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

Následující soubor obsahuje parametr, který má hodnotu tajného< klíče secretName>, ale je připnutý ke konkrétnímu< secretValue.>securePassword .bicepparam

using './main.bicep'

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

readEnvironmentVariable

readEnvironmentVariable(variableName, [defaultValue])

Vrátí hodnotu proměnné prostředí nebo nastaví výchozí hodnotu, pokud proměnná prostředí neexistuje. Při kompilaci dochází k načítání proměnných, ne za běhu.

Obor názvů: sys.

Parametry

Parametr	Požaduje se	Type	Popis
variableName	Ano	string	Název proměnné.
defaultValue	No	string	Výchozí řetězcová hodnota, která se má použít, pokud proměnná prostředí neexistuje.

Vrácená hodnota

Řetězcová hodnota proměnné prostředí nebo výchozí hodnoty.

Poznámky

Následující příkaz nastaví proměnnou prostředí pouze pro proces PowerShellu, ve kterém se provádí. BCP338 získáte z editoru Visual Studio Code.

$env:testEnvironmentVariable = "Hello World!"

Pokud chcete nastavit proměnnou prostředí na úrovni uživatele, použijte následující příkaz:

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

Pokud chcete nastavit proměnnou prostředí na úrovni počítače, použijte následující příkaz:

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

Další informace naleznete v tématu Environment.SetEnvironmentVariable – metoda.

Příklady

Následující příklady ukazují, jak načíst hodnoty proměnných prostředí.

use './main.bicep'

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

Další kroky

Další informace o souboru parametrů Bicep naleznete v části Soubor parametrů.