Aracılığıyla paylaş


Bicep için parametre dosyası işlevi

Bicep, ortam değişkenlerinden değer almanıza olanak tanıyan adlı readEnvironmentVariable() bir işlev sağlar. Ortam değişkeni yoksa varsayılan değer ayarlama esnekliği de sunar. Bu işlev yalnızca dosyalarda .bicepparam kullanılabilir. Daha fazla bilgi için bkz . Bicep parametre dosyası.

getSecret

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

Azure Key Vault'tan bir gizli dizi döndürür. Bicep dosyasının güvenli dize parametresine gizli dizi geçirmek için bu işlevi kullanın.

Not

Bir dosyanın içinden .bicep keyVaultName.getSecret(secretName) işlevini de kullanabilirsiniz.

using './main.bicep'

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

Bu işlevi dize ilişkilendirmesi ile kullanırsanız bir hata alırsınız.

Ad alanı niteleyicisi (az) kullanılabilir, ancak işlev varsayılan Azure Ad Alanı'ndan kullanılabildiğinden isteğe bağlıdır.

Parametreler

Parametre Zorunlu Türü Açıklama
subscriptionId Yes Dize Anahtar kasası kaynağına sahip aboneliğin kimliği.
resourceGroupName Yes Dize Anahtar kasası kaynağını içeren kaynak grubunun adı.
keyVaultName Yes Dize Anahtar kasasının adı.
secretName Yes Dize Anahtar kasasında depolanan gizli dizinin adı.
secretVersion Hayır Dize Anahtar kasasında depolanan gizli dizi sürümü.

Dönüş değeri

Gizli dizi değeri.

Örnek

Aşağıdaki .bicepparam dosya, secretName> gizli dizisinin en son değerine sahip bir securePassword parametreye <sahiptir.

using './main.bicep'

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

Aşağıdaki .bicepparam dosya secretName> gizli dizisinin değerine <sahip bir securePassword parametreye sahiptir, ancak belirli< bir secretValue> değerine sabitlenmiştir.

using './main.bicep'

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

readEnvironmentVariable

readEnvironmentVariable(variableName, [defaultValue])

Ortam değişkeninin değerini döndürür veya ortam değişkeni yoksa varsayılan bir değer ayarlayın. Değişken yükleme çalışma zamanında değil derleme sırasında gerçekleşir.

Ad alanı: sys.

Parametreler

Parametre Zorunlu Türü Açıklama
variableName Yes Dize Değişkenin adı.
defaultValue Hayır Dize Ortam değişkeni yoksa kullanılacak varsayılan dize değeri.

Dönüş değeri

Ortam değişkeninin dize değeri veya varsayılan değer.

Açıklamalar

Aşağıdaki komut ortam değişkenini yalnızca yürütülmekte olduğu PowerShell işlemi için ayarlar. Visual Studio Code'dan BCP338 alırsınız.

$env:testEnvironmentVariable = "Hello World!"

Ortam değişkenini kullanıcı düzeyinde ayarlamak için aşağıdaki komutu kullanın:

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

Ortam değişkenini makine düzeyinde ayarlamak için aşağıdaki komutu kullanın:

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

Daha fazla bilgi için bkz . Environment.SetEnvironmentVariable Yöntemi.

Örnekler

Aşağıdaki örneklerde ortam değişkenlerinin değerlerinin nasıl alınıyor olduğu gösterilmektedir.

use './main.bicep'

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

Sonraki adımlar

Bicep parametre dosyası hakkında daha fazla bilgi için bkz . Parametreler dosyası.