Funzione file parameters per 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. Per ulteriori informazioni, vedere File di parametri Bicep.

getSecret

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

Restituisce un segreto da un insieme di credenziali delle chiavi di Azure. Usare questa funzione per passare un segreto a un parametro stringa sicura di un file Bicep.

Nota

È anche possibile usare la funzione keyVaultName.getSecret(secretName) dall'interno di un .bicep file.

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 archiviata nell'insieme di credenziali delle chiavi.

Valore restituito

Valore per il segreto.

Esempio

Nel file seguente .bicepparam è presente un securePassword parametro con il valore più recente del <segreto secretName> .

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 viene aggiunto a un secretValue> specifico<.

using './main.bicep'

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

readEnvironmentVariable

readEnvironmentVariable(variableName, [defaultValue])

Restituisce il valore della variabile di ambiente oppure imposta un valore predefinito se la variabile di ambiente non esiste. Il caricamento delle variabili si verifica durante la compilazione, 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

Valore stringa della variabile di ambiente o valore predefinito.

Esempi

Negli esempi seguenti viene illustrato 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 sul file di parametri Bicep, vedere File di parametri.