Parameterdateifunktion für Bicep
Bicep bietet eine Funktion namens „readEnvironmentVariable()“, mit der Sie Werte aus Umgebungsvariablen abrufen können. Es bietet auch die Flexibilität, einen Standardwert festzulegen, wenn die Umgebungsvariable nicht vorhanden ist. Diese Funktion kann nur in den .bicepparam-Dateien verwendet werden. Weitere Informationen finden Sie unter Bicep-Parameterdatei.
getSecret
getSecret(subscriptionId, resourceGroupName, keyVaultName, secretName, secretVersion)
Gibt ein Geheimnis aus einer Azure Key Vault-Instanz zurück. Verwenden Sie diese Funktion, um ein Geheimnis an einen sicheren Zeichenfolgenparameter einer Bicep-Datei zu übergeben.
Hinweis
Sie können auch die Funktion keyVaultName.getSecret(secretName) aus einer .bicep-Datei verwenden.
using './main.bicep'
param secureUserName = getSecret('exampleSubscription', 'exampleResourceGroup', 'exampleKeyVault', 'exampleSecretUserName')
param securePassword = getSecret('exampleSubscription', 'exampleResourceGroup', 'exampleKeyVault', 'exampleSecretPassword')
Sie erhalten einen Fehler, wenn Sie diese Funktion mit Zeichenfolgeninterpolation verwenden.
Ein Namespacequalifizierer (az) kann verwendet werden – dies ist aber optional, da die Funktion im Azure-Standardnamespace verfügbar ist.
Parameter
| Parameter | Erforderlich | Type | BESCHREIBUNG |
|---|---|---|---|
| subscriptionId | Ja | Zeichenfolge | Die ID des Abonnements, in dem die Schlüsseltresorressource enthalten ist. |
| resourceGroupName | Ja | Zeichenfolge | Der Name der Ressourcengruppe, in der die Schlüsseltresorressource enthalten ist. |
| keyVaultName | Ja | Zeichenfolge | Der Name des Schlüsseltresors. |
| secretName | Ja | Zeichenfolge | Der Name des Geheimnisses, das im Schlüsseltresor gespeichert ist. |
| secretVersion | Nein | Zeichenfolge | Die Version des Geheimnisses, das im Schlüsseltresor gespeichert ist. |
Rückgabewert
Der Wert für das Geheimnis.
Beispiel
Die folgende .bicepparam-Datei enthält einen securePassword-Parameter, der den neuesten Wert des Geheimnisses <secretName> aufweist.
using './main.bicep'
param securePassword = getSecret('exampleSubscription', 'exampleResourceGroup', 'exampleKeyVault', 'exampleSecretPassword')
Die folgende .bicepparam-Datei enthält einen securePassword-Parameter, der den Wert des Geheimnisses <secretName> aufweist, aber an einen bestimmten <secretValue> angeheftet ist.
using './main.bicep'
param securePassword = getSecret('exampleSubscription', 'exampleResourceGroup', 'exampleKeyVault', 'exampleSecretPassword', 'exampleSecretVersion')
readEnvironmentVariable
readEnvironmentVariable(variableName, [defaultValue])
Gibt den Wert der Umgebungsvariable zurück, oder legt einen Standardwert fest, wenn die Umgebungsvariable nicht vorhanden ist. Das Laden von Variablen erfolgt während der Kompilierung, nicht zur Laufzeit.
Namespace: sys.
Parameter
| Parameter | Erforderlich | Type | Beschreibung |
|---|---|---|---|
| variableName | Ja | Zeichenfolge | Der Name der Variablen. |
| defaultValue | Nein | Zeichenfolge | Ein Standardzeichenfolgenwert, der verwendet werden soll, wenn die Umgebungsvariable nicht vorhanden ist. |
Rückgabewert
Der Zeichenfolgenwert der Umgebungsvariable oder ein Standardwert.
Hinweise
Mit dem folgenden Befehl wird die Umgebungsvariable nur für den PowerShell-Prozess festgelegt, in dem sie ausgeführt wird. Sie erhalten BCP338 aus Visual Studio Code.
$env:testEnvironmentVariable = "Hello World!"
Verwenden Sie den folgenden Befehl, um die Umgebungsvariable auf Benutzerebene festzulegen:
[System.Environment]::SetEnvironmentVariable('testEnvironmentVariable','Hello World!', 'User')
Verwenden Sie den folgenden Befehl, um die Umgebungsvariable auf Computerebene festzulegen:
[System.Environment]::SetEnvironmentVariable('testEnvironmentVariable','Hello World!', 'Machine')
Weitere Informationen finden Sie unter Environment.SetEnvironmentVariable-Methode.
Beispiele
Die folgenden Beispiele zeigen, wie Sie die Werte von Umgebungsvariablen abrufen.
use './main.bicep'
param adminPassword = readEnvironmentVariable('admin_password')
param boolfromEnvironmentVariables = bool(readEnvironmentVariable('boolVariableName','false'))
Nächste Schritte
Weitere Informationen zu Bicep-Parameterdateien finden Sie unter Parameterdatei.