Bicep のパラメーター ファイル関数

Bicep には、 readEnvironmentVariable() という関数が用意されています。この関数を使用すると、環境変数から値を取得できます。 また、環境変数が存在しない場合は、既定値を柔軟に設定することもできます。 この関数は、.bicepparam ファイルでのみを使用できます。 詳細については、「Bicep パラメーター ファイル」を参照してください。

getSecret

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

Azure Key Vault からシークレットを返します。 この関数を使用して、Bicep ファイルのセキュリティで保護された文字列パラメーターにシークレットを渡します。

Note

.bicep ファイル内から keyVaultName.getSecret(secretName) 関数を使用することもできます。

using './main.bicep'

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

文字列補間を含むこの関数を使用すると、エラーが発生します。

名前空間修飾子 (az) は使用できますが、関数は既定の Azure 名前空間から使用できるため、省略可能です。

パラメーター

パラメーター	必須	タイプ	説明
subscriptionId	はい	string	キー コンテナー リソースを含むサブスクリプションの ID。
resourceGroupName	はい	string	キー コンテナー リソースを含むリソース グループの名前。
KeyVaultName	はい	string	キー コンテナーの名前。
secretName	はい	string	キー コンテナーに格納されているシークレットの名前。
secretVersion	いいえ	string	キー コンテナーに格納されているシークレットのバージョン。

戻り値

シークレットの値。

例

次の .bicepparam ファイルには、<secretName> シークレットの最新の値を持つ securePassword パラメータがあります。

using './main.bicep'

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

次の .bicepparam ファイルには、<secretName> シークレットの値を持つ securePassword パラメータがありますが、これは特定の <secretValue> にピン留めされています。

using './main.bicep'

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

readEnvironmentVariable

readEnvironmentVariable(variableName, [defaultValue])

環境変数が存在しない場合は、環境変数の値を返すか、既定値を設定します。 変数の読み込みは、実行時ではなくコンパイル中に発生します。

名前空間: sys。

パラメーター

パラメーター	必須	タイプ	説明
variableName	はい	string	変数の名前。
defaultValue	いいえ	string	環境変数が存在しない場合に使用される既定の文字列値。

戻り値

環境変数の文字列値、または既定値。

解説

次のコマンドは、実行される PowerShell プロセスに対してのみ環境変数を設定します。 Visual Studio Code から BCP338 を取得します。

$env:testEnvironmentVariable = "Hello World!"

ユーザー レベルで環境変数を設定するには、次のコマンドを使用します。

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

マシン レベルで環境変数を設定するには、次のコマンドを使用します。

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

詳細については、「 Environment.SetEnvironmentVariable メソッドを参照してください。

例

次の例では、環境変数の値を取得する方法を示します。

use './main.bicep'

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

次のステップ

Bicep パラメーターの詳細については、「パラメーター ファイル」を参照してください。