Guida introduttiva: Creare un'app Python con app Azure Configurazione

Articolo
12/18/2024

In questa guida introduttiva si userà il provider Python per app Azure Configurazione per centralizzare l'archiviazione e la gestione delle impostazioni dell'applicazione usando la libreria client del provider Python di configurazione app Azure.

Il provider di Configurazione app Python è una libreria in esecuzione in Azure SDK per Python, consentendo agli sviluppatori Python di usare facilmente il servizio Configurazione app. Consente di usare le impostazioni di configurazione come un dizionario.

Prerequisiti

Un account Azure con una sottoscrizione attiva. Crearne una gratuitamente.
Un Archivio di configurazione app. Creare un archivio.
Python 3.8 o versione successiva: per informazioni sulla configurazione di Python in Windows, vedere la documentazione di Python in Windows

Aggiungere coppie chiave-valore

Aggiungere le coppie chiave-valore seguenti all'archivio di Configurazione app. Per altre informazioni su come aggiungere valori chiave a un archivio usando il portale di Azure o l’interfaccia della riga di comando, andare a Creare un valore chiave.

Chiave	valore	Etichetta	Tipo contenuto
message	Ciao	Lasciare vuoto	Lasciare vuoto
test.message	Test Hello	Lasciare vuoto	Lasciare vuoto
my_json	{"key":"value"}	Lasciare vuoto	application/json

Applicazioni console

In questa sezione si creerà un'applicazione console e si caricheranno i dati dall'archivio Configurazione app.

Connettersi a Configurazione app

Creare una nuova directory per il progetto denominata app-configuration-quickstart.
```
mkdir app-configuration-quickstart
```
Passare alla directory app-configuration-quickstart appena creata.
```
cd app-configuration-quickstart
```
Installare il provider di Configurazione app di Azure usando il comando pip install.
```
pip install azure-appconfiguration-provider
```

Creare un nuovo file denominato app-configuration-quickstart.py nella directory app-configuration-quickstart e aggiungere il codice seguente:

Microsoft Entra ID (scelta consigliata)
Stringa di connessione

Usare per eseguire l'autenticazione DefaultAzureCredential nell'archivio Configurazione app. Seguire le istruzioni per assegnare le credenziali al ruolo lettore dati Configurazione app. Assicurarsi di consentire tempo sufficiente per la propagazione dell'autorizzazione prima di eseguire l'applicazione.

from azure.appconfiguration.provider import (
    load,
    SettingSelector
)
from azure.identity import DefaultAzureCredential
import os

endpoint = os.environ.get("AZURE_APPCONFIG_ENDPOINT")

# Connect to Azure App Configuration using a connection string.
config = load(endpoint=endpoint, credential=credential)
credential = DefaultAzureCredential()

# Find the key "message" and print its value.
print(config["message"])
# Find the key "my_json" and print the value for "key" from the dictionary.
print(config["my_json"]["key"])

# Connect to Azure App Configuration using a connection string and trimmed key prefixes.
trimmed = {"test."}
config = load(endpoint=endpoint, credential=credential, trim_prefixes=trimmed)
# From the keys with trimmed prefixes, find a key with "message" and print its value.
print(config["message"])

# Connect to Azure App Configuration using SettingSelector.
selects = {SettingSelector(key_filter="message*", label_filter="\0")}
config = load(endpoint=endpoint, credential=credential, selects=selects)

# Print True or False to indicate if "message" is found in Azure App Configuration.
print("message found: " + str("message" in config))
print("test.message found: " + str("test.message" in config))

from azure.appconfiguration.provider import (
    load,
    SettingSelector
)
import os

connection_string = os.environ.get("AZURE_APPCONFIG_CONNECTION_STRING")

# Connect to Azure App Configuration using a connection string.
config = load(connection_string=connection_string)

# Find the key "message" and print its value.
print(config["message"])
# Find the key "my_json" and print the value for "key" from the dictionary.
print(config["my_json"]["key"])

# Connect to Azure App Configuration using a connection string and trimmed key prefixes.
trimmed = {"test."}
config = load(connection_string=connection_string, trim_prefixes=trimmed)
# From the keys with trimmed prefixes, find a key with "message" and print its value.
print(config["message"])

# Connect to Azure App Configuration using SettingSelector.
selects = {SettingSelector(key_filter="message*", label_filter="\0")}
config = load(connection_string=connection_string, selects=selects)

# Print True or False to indicate if "message" is found in Azure App Configuration.
print("message found: " + str("message" in config))
print("test.message found: " + str("test.message" in config))

Eseguire l'applicazione

Impostare una variabile di ambiente.
- Microsoft Entra ID (scelta consigliata)
- Stringa di connessione
Impostare la variabile di ambiente denominata AZURE_APPCONFIG_ENDPOINT sull'endpoint dell'archivio Configurazione app disponibile in Panoramica dell'archivio nel portale di Azure.

Se si usa il prompt dei comandi di Windows, eseguire il comando seguente e riavviare il prompt per rendere effettiva la modifica:
```
setx AZURE_APPCONFIG_ENDPOINT "endpoint-of-your-app-configuration-store"
```
Se si usa PowerShell, eseguire il comando seguente:
```
$Env:AZURE_APPCONFIG_ENDPOINT = "endpoint-of-your-app-configuration-store"
```
Se si usa macOS o Linux, eseguire il comando seguente:
```
export AZURE_APPCONFIG_ENDPOINT='<endpoint-of-your-app-configuration-store>'
```
Impostare la variabile di ambiente denominata AZURE_APPCONFIG_CONNECTION_STRING sull'stringa di connessione di sola lettura dell'archivio Configurazione app disponibile in Chiavi di accesso dell'archivio nel portale di Azure.

Se si usa il prompt dei comandi di Windows, eseguire il comando seguente e riavviare il prompt per rendere effettiva la modifica:
```
setx AZURE_APPCONFIG_CONNECTION_STRING "<connection-string-of-your-app-configuration-store>"
```
Se si usa PowerShell, eseguire il comando seguente:
```
$Env:AZURE_APPCONFIG_CONNECTION_STRING = "connection-string-of-your-app-configuration-store"
```
Se si usa macOS o Linux, eseguire il comando seguente:
```
export AZURE_APPCONFIG_CONNECTION_STRING='<connection-string-of-your-app-configuration-store>'
```
Dopo aver impostato correttamente la variabile di ambiente, eseguire il comando seguente per eseguire l'app in locale:
```
python app-configuration-quickstart.py
```
Verrà visualizzato l'output seguente:
```
Hello
value
Hello test
message found: True
test.message found: False
```

Applicazioni Web

Il provider Configurazione app carica i dati in un Mapping oggetto accessibile come dizionario, che può essere usato in combinazione con la configurazione esistente di vari framework Python. Questa sezione illustra come usare il provider di Configurazione app in framework Web comuni come Flask e Django.

Flask
Django

È possibile usare app Azure Configurazione nelle app Web Flask esistenti aggiornandone la configurazione predefinita. A tale scopo, passare l'oggetto provider Configurazione app alla update funzione dell'istanza dell'app Flask in app.py:

azure_app_config = load(endpoint=os.environ.get("AZURE_APPCONFIG_ENDPOINT"), credential=credential)

# NOTE: This will override all existing configuration settings with the same key name.
app.config.update(azure_app_config)

# Access a configuration setting directly from within Flask configuration
message = app.config.get("message")

È possibile usare app Azure Configurazione nelle app Web Django esistenti aggiungendo le righe di codice seguenti nel settings.py file

AZURE_APPCONFIGURATION = load(endpoint=os.environ.get("AZURE_APPCONFIG_ENDPOINT"), credential=credential)

Per accedere alle singole impostazioni di configurazione nelle visualizzazioni Django, è possibile farvi riferimento dall'oggetto provider creato nelle impostazioni django. Ad esempio: in views.py:

# Import Django settings
from django.conf import settings

# Access a configuration setting from Django settings instance.
MESSAGE = settings.AZURE_APPCONFIGURATION.get("message")

Gli esempi di codice completi su come usare app Azure Configurazione nelle applicazioni Web Python sono disponibili nel repository GitHub di configurazione app Azure.

Pulire le risorse

Se non si vuole continuare a usare le risorse create in questo articolo, eliminare il gruppo di risorse creato qui per evitare addebiti.

Importante

L'eliminazione di un gruppo di risorse è irreversibile. Il gruppo di risorse e tutte le risorse in esso contenute vengono eliminati in modo permanente. Assicurarsi di non eliminare accidentalmente il gruppo di risorse o le risorse sbagliate. Se le risorse per questo articolo sono state create in un gruppo di risorse che contiene altre risorse che si vogliono mantenere, eliminare ogni risorsa singolarmente dal rispettivo riquadro anziché eliminare il gruppo di risorse.

Accedere al portale di Azure e selezionare Gruppi di risorse.
Nella casella Filtra per nome immettere il nome del gruppo di risorse.
Nell'elenco dei risultati selezionare il nome del gruppo di risorse per visualizzare una panoramica.
Selezionare Elimina gruppo di risorse.
Verrà chiesto di confermare l'eliminazione del gruppo di risorse. Immettere il nome del gruppo di risorse per confermare e selezionare Elimina.

Dopo qualche istante, il gruppo di risorse e tutte le risorse che contiene vengono eliminati.

Passaggi successivi

In questa guida introduttiva è stato creato un nuovo archivio Configurazione app e si è appreso come accedere ai valori chiave da un'app Python.

Per altri esempi di codice, vedere:

Esempio di Flask di esempio Django app Azure provider Python di configurazione

Condividi tramite