Funzioni Bicep per i file di parametri Bicep
Bicep fornisce una funzione denominata readEnvironmentVariable()
che consente di recuperare i valori dalle variabili di ambiente. Offre inoltre la flessibilità necessaria per impostare un valore predefinito se la variabile di ambiente non esiste. Questa funzione può essere usata solo nei .bicepparam
file.
getSecret
getSecret(subscriptionId, resourceGroupName, keyVaultName, secretName, secretVersion)
Questa funzione restituisce un segreto da un insieme di credenziali delle chiavi di Azure. Usare questa funzione per passare un segreto al parametro di stringa sicura di un file Bicep.
Nota
Inoltre, è possibile usare la funzione keyVaultName.getSecret(secretName) dall'interno di un file .bicep
.
using './main.bicep'
param secureUserName = getSecret('exampleSubscription', 'exampleResourceGroup', 'exampleKeyVault', 'exampleSecretUserName')
param securePassword = getSecret('exampleSubscription', 'exampleResourceGroup', 'exampleKeyVault', 'exampleSecretPassword')
Se si usa questa funzione con l'interpolazione di stringhe, viene visualizzato un errore.
È possibile usare un qualificatore dello spazio dei nomi (az
), ma è facoltativo perché la funzione è disponibile nello spazio dei nomi di Azure predefinito.
Parametri
Parametro | Richiesto | Type | Descrizione |
---|---|---|---|
subscriptionId | Sì | string | ID della sottoscrizione con la risorsa dell'insieme di credenziali delle chiavi |
resourceGroupName | Sì | string | Nome del gruppo di risorse con la risorsa dell'insieme di credenziali delle chiavi |
keyVaultName | Sì | string | Nome dell'insieme di credenziali delle chiavi |
secretName | Sì | string | Nome del segreto archiviato nell'insieme di credenziali delle chiavi |
secretVersion | No | string | Versione del segreto archiviato nell'insieme di credenziali delle chiavi |
Valore restituito
Valore per il segreto.
Esempio
Il file seguente ha un securePassword
parametro con il valore più recente del< segreto secretName>:.bicepparam
using './main.bicep'
param securePassword = getSecret('exampleSubscription', 'exampleResourceGroup', 'exampleKeyVault', 'exampleSecretPassword')
Il file seguente .bicepparam
ha un securePassword
parametro con il valore del <segreto secretName>, ma aggiunto a un secretValue> specifico<:
using './main.bicep'
param securePassword = getSecret('exampleSubscription', 'exampleResourceGroup', 'exampleKeyVault', 'exampleSecretPassword', 'exampleSecretVersion')
readEnvironmentVariable
readEnvironmentVariable(variableName, [defaultValue])
Questa funzione restituisce il valore della variabile di ambiente o imposta un valore predefinito se la variabile di ambiente non esiste. Il caricamento delle variabili si verifica durante la compilazione e non in fase di esecuzione.
Spazio dei nomi: sys.
Parametri
Parametro | Richiesto | Type | Descrizione |
---|---|---|---|
variableName | Sì | string | Nome della variabile. |
defaultValue | No | string | Valore stringa predefinito da usare se la variabile di ambiente non esiste. |
Valore restituito
Il valore restituito è il valore stringa della variabile di ambiente o un valore predefinito.
Osservazioni:
Il comando seguente imposta la variabile di ambiente solo per il processo di PowerShell in cui viene eseguito. Si ottiene BCP338 da Visual Studio Code:
$env:testEnvironmentVariable = "Hello World!"
Per impostare la variabile di ambiente a livello di utente, eseguire il comando seguente:
[System.Environment]::SetEnvironmentVariable('testEnvironmentVariable','Hello World!', 'User')
Per impostare la variabile di ambiente a livello di computer, eseguire il comando seguente:
[System.Environment]::SetEnvironmentVariable('testEnvironmentVariable','Hello World!', 'Machine')
Per altre informazioni, vedere Metodo Environment.SetEnvironmentVariable.
Esempi
Gli esempi seguenti illustrano come recuperare i valori delle variabili di ambiente:
use './main.bicep'
param adminPassword = readEnvironmentVariable('admin_password')
param boolfromEnvironmentVariables = bool(readEnvironmentVariable('boolVariableName','false'))
Passaggi successivi
Per altre informazioni sui file di parametri Bicep, vedere Creare file di parametri per la distribuzione Bicep.