Início Rápido: Criar um aplicativo Python com a Configuração de Aplicativos do Azure

Artigo
12/18/2024

Neste guia de início rápido, você usará o provedor de Python da Configuração de Aplicativos do Azure para centralizar o armazenamento e o gerenciamento de configurações de aplicativos usando a biblioteca de clientes do provedor de Python da Configuração de Aplicativos do Azure.

O provedor da Configuração de Aplicativos para Python é uma biblioteca executada sobre o SDK do Azure para Python que ajuda os desenvolvedores de Python a consumir facilmente o serviço de Configuração de Aplicativos. Ele permite que as definições de configuração sejam usadas como um dicionário.

Pré-requisitos

Uma conta do Azure com uma assinatura ativa. Crie um gratuitamente.
Um repositório de Configuração de Aplicativos. Criar um repositório.
Python 3.8 ou posterior – para obter informações sobre como configurar o Python no Windows, confira a Documentação do Python no Windows

Adicionar valores-chave

Adicione os seguintes valores-chave ao repositório de Configuração do Aplicativos. Para obter mais informações sobre como adicionar valores-chave a um repositório usando o portal do Azure ou a CLI, acesse Criar um valor-chave.

Chave	Valor	Rótulo	Tipo de conteúdo
message	Olá	Deixar em branco	Deixar em branco
test.message	Hello test	Deixar em branco	Deixar em branco
my_json	{"chave":"valor"}	Deixar em branco	aplicativo/json

Aplicativos de console

Nesta seção, você criará um aplicativo de console e carregará dados do repositório Configuração de Aplicativos.

Conectar-se à Configuração de Aplicativos

Crie um diretório para o projeto chamado app-configuration-quickstart.
```
mkdir app-configuration-quickstart
```
Mude para o diretório app-configuration-quickstart que foi recém-criado.
```
cd app-configuration-quickstart
```
Instale o provedor da Configuração de Aplicativos do Azure usando o comando pip install.
```
pip install azure-appconfiguration-provider
```

Crie um arquivo chamado app-configuration-quickstart.py no diretório app-configuration-quickstart e adicione o seguinte código:

Microsoft Entra ID (recomendado)
Cadeia de conexão

Você usa a autenticação DefaultAzureCredential no repositório de Configuração de Aplicativos. Siga as instruções para atribuir à credencial a função Leitor de Dados de Configuração de Aplicativo. Certifique-se de permitir tempo suficiente para a permissão se propagar antes de executar seu aplicativo.

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))

Executar o aplicativo

Defina uma variável de ambiente.
- Microsoft Entra ID (recomendado)
- Cadeia de conexão
Defina a variável de ambiente chamada AZURE_APPCONFIG_ENDPOINT como o ponto de extremidade do seu repositório de configuração de aplicativos, encontrado na Visão geral do seu repositório no portal do Azure.

Se você usar o prompt de comando do Windows, execute o comando a seguir e reinicie o prompt de comando para permitir que a alteração entre em vigor:
```
setx AZURE_APPCONFIG_ENDPOINT "endpoint-of-your-app-configuration-store"
```
Se você usar o PowerShell, execute o seguinte comando:
```
$Env:AZURE_APPCONFIG_ENDPOINT = "endpoint-of-your-app-configuration-store"
```
Se você usa macOS ou Linux, execute o comando a seguir:
```
export AZURE_APPCONFIG_ENDPOINT='<endpoint-of-your-app-configuration-store>'
```
Defina a variável de ambiente chamada AZURE_APPCONFIG_CONNECTION_STRING como a cadeia de conexão somente leitura do seu repositório de configuração de aplicativos, encontrada em Chaves de acesso do seu repositório no portal do Azure.

Se você usar o prompt de comando do Windows, execute o comando a seguir e reinicie o prompt de comando para permitir que a alteração entre em vigor:
```
setx AZURE_APPCONFIG_CONNECTION_STRING "<connection-string-of-your-app-configuration-store>"
```
Se você usar o PowerShell, execute o seguinte comando:
```
$Env:AZURE_APPCONFIG_CONNECTION_STRING = "connection-string-of-your-app-configuration-store"
```
Se você usa macOS ou Linux, execute o comando a seguir:
```
export AZURE_APPCONFIG_CONNECTION_STRING='<connection-string-of-your-app-configuration-store>'
```
Depois que a variável de ambiente for definida de maneira correta, execute o seguinte comando para executar o aplicativo localmente:
```
python app-configuration-quickstart.py
```
Você deve ver o seguinte resultado:
```
Hello
value
Hello test
message found: True
test.message found: False
```

Aplicativos Web

O provedor da Configuração de Aplicativos carrega dados em um objeto Mapping, acessível como um dicionário, que pode ser usado em combinação com a configuração existente de várias estruturas do Python. Esta seção mostra como usar o provedor da Configuração de Aplicativos em estruturas da Web populares, como Flask e Django.

Flask
Django

Você pode usar a Configuração de Aplicativos do Azure em seus aplicativos Web do Flask existentes atualizando sua configuração interna. Você pode fazer isso passando seu objeto de provedor da Configuração de Aplicativos para a função update da instância do aplicativo Flask em 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")

Você pode usar a Configuração de Aplicativos do Azure em seus aplicativos Web do Django existentes adicionando as seguintes linhas de código ao arquivo settings.py

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

Para acessar as configurações individuais nas exibições do Django, você pode referenciá-las a partir do objeto de provedor criado nas configurações do Django. Por exemplo, em views.py:

# Import Django settings
from django.conf import settings

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

Exemplos de código completo sobre como usar a Configuração de Aplicativos do Azure em aplicativos Web Python podem ser encontrados no repositório GitHub da Configuração de Aplicativos do Azure.

Limpar os recursos

Se não deseja continuar usando os recursos criados neste artigo, exclua o grupo de recursos que você criou aqui para evitar encargos.

Importante

A exclusão de um grupo de recursos é irreversível. O grupo de recursos e todos os recursos contidos nele são excluídos permanentemente. Não exclua acidentalmente grupo de recursos ou recursos incorretos. Se tiver criado os recursos para este artigo dentro de um grupo de recursos que contém outros recursos que você deseja manter, exclua cada um individualmente do respectivo painel em vez de excluir o grupo de recursos.

Entre no portal do Azure e selecione Grupos de recursos.
Na caixa Filtrar por nome..., digite o nome do seu grupo de recursos.
Na lista de resultados, selecione o nome do grupo de recursos para conferir uma visão geral.
Selecione Excluir grupo de recursos.
Você receberá uma solicitação para confirmar a exclusão do grupo de recursos. Insira o nome do grupo de recursos para confirmar e selecione Excluir.

Após alguns instantes, o grupo de recursos e todos os recursos dele são excluídos.

Próximas etapas

Neste guia de início rápido, você criou um repositório da Configuração de Aplicativos e aprendeu a acessar pares chave-valor em um aplicativo Python.

Para obter códigos de exemplo adicionais, visite:

Exemplo do Django Exemplo do Flask Provedor Python de Configuração de Aplicativos do Azure

Compartilhar via