Bicep 的參數檔案函式

Bicep 提供稱為 readEnvironmentVariable() 的函式，可讓您從環境變數擷取值。 如果環境變數不存在，它也提供設定預設值的彈性。 此函式只能在檔案中使用 .bicepparam 。 如需詳細資訊，請參閱 Bicep 參數檔案。

getSecret

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

從 Azure 金鑰保存庫 傳回秘密。 使用此函式將秘密傳遞至 Bicep 檔案的安全字串參數。

注意

您也可以從檔案內.bicep使用 keyVaultName.getSecret（secretName） 函式。

using './main.bicep'

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

如果您使用此函式搭配字串插補，您會收到錯誤。

命名空間限定符 （az） 可以使用，但這是選擇性的，因為函式可從預設的 Azure 命名空間取得。

參數

參數	必要	類型​	描述
subscriptionId	Yes	string	具有金鑰保存庫資源的訂用帳戶標識碼。
resourceGroupName	Yes	string	具有金鑰保存庫資源的資源群組名稱。
keyVaultName	Yes	string	金鑰保存庫的名稱。
secretName	Yes	string	儲存在金鑰保存庫中的秘密名稱。
secretVersion	No	string	儲存在金鑰保存庫中的秘密版本。

傳回值

秘密的值。

範例

下列檔案具有securePassword具有 secretName> 秘密最新值的參數<。.bicepparam

using './main.bicep'

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

下列檔案具有具有 secretName 秘密值<的參數，但已釘選到特定的< secretValue。.bicepparamsecurePassword>>

using './main.bicep'

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

readEnvironmentVariable

readEnvironmentVariable(variableName, [defaultValue])

傳回環境變數的值，如果環境變數不存在，則設定預設值。 變數載入會在編譯期間發生，而不是在運行時間進行。

命名空間：sys (部分機器翻譯)。

參數

參數	必要	類型​	描述
variableName	Yes	string	變數的名稱。
defaultValue	No	string	如果環境變數不存在，要使用的預設字串值。

傳回值

環境變數或預設值的字串值。

範例

下列範例示範如何擷取環境變數的值。

use './main.bicep'

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

下一步

如需 Bicep 參數檔案的詳細資訊，請參閱 Parameters 檔案。