Funzione file di parametri per Bicep

  • Articolo

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. Tale funzione può essere usata solo nei file .bicepparam. Per ulteriori informazioni, vedere File di parametri Bicep.

getSecret

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

Restituisce un segreto da un Azure Key Vault. Usare questa funzione per passare un segreto a un 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 L’ID della sottoscrizione con la risorsa key vault.
resourceGroupName Sì string Nome del gruppo di risorse con la risorsa key vault.
keyVaultName Sì string Nome dell'istanza key vault.
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.

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, usare il comando seguente:

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

Per impostare la variabile di ambiente a livello di computer, usare il comando seguente:

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

Per altre informazioni, vedere Metodo Environment.SetEnvironmentVariable.

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.