Bicep-Funktionen für Bicep-Parameterdateien
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 .bicepparam Dateien verwendet werden.
getSecret
getSecret(subscriptionId, resourceGroupName, keyVaultName, secretName, secretVersion)
Diese Funktion gibt einen Geheimschlüssel aus einem Azure Key Vault zurück. Verwenden Sie diese Funktion, um einen geheimen Schlüssel an den 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, ist aber optional, da die Funktion aus dem Standardmäßigen Azure-Namespace verfügbar ist.
Parameter
| Parameter | Erforderlich | Type | BESCHREIBUNG |
|---|---|---|---|
| subscriptionId | Ja | Zeichenfolge | Die ID des Abonnements mit der Schlüsseltresorressource |
| resourceGroupName | Ja | Zeichenfolge | Der Name der Ressourcengruppe mit der Schlüsseltresorressource |
| keyVaultName | Ja | Zeichenfolge | Der Name des Schlüsseltresors |
| secretName | Ja | Zeichenfolge | Der Name des geheimen Schlüssels, der im Schlüsseltresor gespeichert ist |
| secretVersion | Nein | Zeichenfolge | Die Version des geheimen Schlüssels, der im Schlüsseltresor gespeichert ist |
Rückgabewert
Der Wert für das Geheimnis.
Beispiel
Die folgende .bicepparam Datei weist einen securePassword Parameter auf, der den neuesten Wert des <geheimen Schlüssels "secretName> " aufweist:
using './main.bicep'
param securePassword = getSecret('exampleSubscription', 'exampleResourceGroup', 'exampleKeyVault', 'exampleSecretPassword')
Die folgende .bicepparam Datei weist einen securePassword Parameter auf, der den Wert des <geheimen Schlüssels "secretName> " aufweist, aber an einen bestimmten <"secretValue>" angeheftet ist:
using './main.bicep'
param securePassword = getSecret('exampleSubscription', 'exampleResourceGroup', 'exampleKeyVault', 'exampleSecretPassword', 'exampleSecretVersion')
readEnvironmentVariable
readEnvironmentVariable(variableName, [defaultValue])
Diese Funktion 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 und 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 Rückgabewert ist der Zeichenfolgenwert der Umgebungsvariable oder eines Standardwerts.
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!"
Führen Sie den folgenden Befehl aus, um die Umgebungsvariable auf Benutzerebene festzulegen:
[System.Environment]::SetEnvironmentVariable('testEnvironmentVariable','Hello World!', 'User')
Führen Sie den folgenden Befehl aus, 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 die Werte von Umgebungsvariablen abgerufen werden:
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 Erstellen von Parameterdateien für die Bicep-Bereitstellung.