Compartilhar via

Melhores práticas da Configuração de Aplicativos do Azure

Este artigo aborda padrões comuns e práticas recomendadas quando você estiver usando Azure App configuração.

Agrupamentos de chaves

A configuração do aplicativo fornece duas opções para organizar as chaves:

  • Prefixos de chave
  • Rótulos

Você pode usar uma ou ambas as opções para agrupar suas chaves.

Os prefixos de chave permitem agrupar chaves relacionadas usando um prefixo comum em seus nomes. Os prefixos podem incluir vários segmentos separados por delimitadores, como / ou :, formando um namespace hierárquico. Essa abordagem é útil ao armazenar chaves de configuração para vários aplicativos ou microsserviços em um único repositório de Configuração de Aplicativos.

É importante lembrar que as chaves são referenciadas diretamente pelo código do aplicativo para recuperar seus valores correspondentes. Portanto, as chaves devem permanecer estáveis para evitar alterações de código. Se necessário, você pode usar o provedor de Configuração de Aplicativos para cortar prefixos de chave em runtime.

Os rótulos permitem que você crie variações de uma chave, como versões diferentes ou configurações específicas do ambiente. Ao atribuir rótulos, você pode manter vários valores para a mesma chave. Em seguida, seu aplicativo pode recuperar diferentes conjuntos de valores-chave especificando o rótulo apropriado, permitindo que suas referências de chave no código permaneçam consistentes.

Composições chave-valor

A Configuração de Aplicativos trata cada chave armazenada dentro dela como uma entidade independente. Ele não infere relações entre chaves ou herda valores com base na hierarquia de chaves. No entanto, você pode agregar vários conjuntos de chaves efetivamente, usando rótulos combinados com configuração em camadas em seu aplicativo.

Considere um exemplo em que você tem uma configuração chamada TestApp:MySetting, cujo valor varia dependendo do ambiente. Você pode criar duas chaves com o mesmo nome, mas atribuir rótulos diferentes: uma sem rótulo (padrão) e outra rotulada Desenvolvimento. A chave não rotulada contém o valor padrão, enquanto a chave rotulada contém o valor específico do ambiente.

No código do aplicativo, primeiro você carrega os valores de chave padrão (sem rótulo) e, em seguida, carrega os valores de chave específicos do ambiente usando o rótulo desenvolvimento . Ao carregar o segundo conjunto, todas as chaves correspondentes substituem os valores carregados anteriormente. Essa abordagem permite que você "empilhe" vários conjuntos de configuração, com o último valor carregado tendo precedência. Os provedores de Configuração de Aplicativos em linguagens e plataformas com suporte oferecem essa funcionalidade de empilhamento.

O exemplo a seguir demonstra como implementar a composição chave-valor em um aplicativo .NET:

configBuilder.AddAzureAppConfiguration(options => {
    options.Connect(new Uri("<your-app-config-endpoint>"), new DefaultAzureCredential())
           // Load all keys that start with `TestApp:` and compose with two different labels
           .Select(keyFilter: "TestApp:*", labelFilter: LabelFilter.Null)
           .Select(keyFilter: "TestApp:*", labelFilter: "Development");
});

Usar rótulos para habilitar configurações diferentes para ambientes diferentes fornece um exemplo completo.

Atualização de configuração

A Configuração de Aplicativo do Azure dá suporte à atualização de configuração dinâmica sem a necessidade de uma reinicialização do aplicativo. Os provedores de Configuração de Aplicativos podem monitorar as alterações de configuração usando duas abordagens:

Monitorando todas as chaves selecionadas

Nessa abordagem, o provedor monitora todas as chaves selecionadas. Se uma alteração for detectada em qualquer um dos valores de chave selecionados, toda a configuração será recarregada. Essa abordagem garante atualizações imediatas sem a necessidade de modificações de chave adicionais.

configBuilder.AddAzureAppConfiguration(options =>
{
    options.Connect(new Uri("<your-app-config-endpoint>"), new DefaultAzureCredential())
           // Load all keys that start with `TestApp:` and have no label
           .Select(keyFilter: "TestApp:*", labelFilter: LabelFilter.Null)
           .ConfigureRefresh(refreshOptions =>
           {
               // Trigger full configuration refresh when any selected key changes.
               refreshOptions.RegisterAll();
           });
});

Monitorar uma chave sentinela

Como alternativa, você pode monitorar uma chave individual, geralmente chamada de chave sentinela. Essa abordagem é útil ao atualizar vários valores-chave. Atualizando a chave sentinela somente depois que todas as outras alterações de configuração forem concluídas, verifique se o aplicativo recarrega a configuração apenas uma vez, mantendo a consistência.

configBuilder.AddAzureAppConfiguration(options =>
{
    options.Connect(new Uri("<your-app-config-endpoint>"), new DefaultAzureCredential())
           // Load all keys that start with `TestApp:` and have no label
           .Select(keyFilter: "TestApp:*", labelFilter: LabelFilter.Null)
           .ConfigureRefresh(refreshOptions =>
           {
               // Trigger full configuration refresh only if the `SentinelKey` changes.
               refreshOptions.Register("SentinelKey", refreshAll: true);
           });
});

Ambas as abordagens estão disponíveis por meio de provedores de Configuração de Aplicativos em linguagens e plataformas com suporte.

Para reduzir o risco de inconsistências de configuração, use instantâneos de configuração para garantir a integridade da configuração.

Referências a dados externos

A Configuração de Aplicativos foi projetada para armazenar todos os dados de configuração que você normalmente salvaria em arquivos de configuração ou variáveis de ambiente. No entanto, alguns tipos de dados podem ser mais adequados para residir em outras fontes. Por exemplo, armazene segredos no Key Vault, arquivos no Armazenamento do Azure, informações de associação em grupos do Microsoft Entra ou listas de clientes em um banco de dados.

Você ainda pode aproveitar a Configuração de Aplicativos salvando uma referência a dados externos em um valor-chave. Você pode usar o tipo de conteúdo para diferenciar cada fonte de dados. Quando o aplicativo lê uma referência, ele carrega os dados reais da fonte referenciada, supondo que ele tenha a permissão necessária para ela. Ao alterar o local dos dados externos, você só precisa atualizar a referência na Configuração de Aplicativos em vez de atualizar e reimplantar todo o aplicativo.

O recurso referência do Key Vault da Configuração de Aplicativos é um exemplo neste caso. Ele permite que os segredos necessários para um aplicativo sejam atualizados conforme necessário, enquanto os próprios segredos subjacentes permanecem no Key Vault.

Inicialização da Configuração de Aplicativos

Para acessar um repositório de Configuração de Aplicativos do Azure, você pode autenticar usando uma cadeia de conexão ou a ID do Microsoft Entra. Embora as cadeias de conexão estejam prontamente disponíveis no portal do Azure, elas contêm informações de credencial e devem ser tratadas como segredos. Se você escolher essa abordagem, armazene a cadeia de conexão com segurança no Azure Key Vault e garanta que seu aplicativo se autentique no Key Vault para recuperá-la.

Uma abordagem mais segura e recomendada é usar a autenticação da ID do Microsoft Entra. Se o aplicativo estiver hospedado no Azure , como no Serviço de Kubernetes do Azure, no Serviço de Aplicativo ou no Azure Functions, você poderá usar identidades gerenciadas fornecidas pelo Microsoft Entra ID. As identidades gerenciadas eliminam a necessidade de gerenciar segredos explicitamente. Com esse método, seu aplicativo requer apenas a URL do ponto de extremidade da Configuração de Aplicativo, que pode ser inserida com segurança no código do aplicativo ou nos arquivos de configuração.

Para obter mais informações, confira Como usar identidades gerenciadas para acessar a Configuração de Aplicativos.

Acesso do Serviço de Kubernetes do Azure à Configuração de Aplicativos

As opções a seguir estão disponíveis para cargas de trabalho hospedadas no AKS (Serviço de Kubernetes do Azure) para acessar a Configuração de Aplicativos do Azure. Essas opções também se aplicam ao Kubernetes em geral.

  • Adicione o Provedor de Kubernetes de Configuração de Aplicativos do Azure ao cluster do AKS. O provedor do Kubernetes é executado como um pod no cluster. Ele pode construir ConfigMaps e Segredos a partir de chave-valores e referências do Key Vault em seu repositório de Configuração de Aplicativos. O ConfigMap e o Segredo são consumíveis como variáveis de ambiente ou arquivos montados sem a necessidade de modificações no código do aplicativo. Se você tiver vários aplicativos em execução no mesmo cluster do AKS, todos eles poderão acessar o ConfigMaps e os Segredos gerados, eliminando a necessidade de solicitações individuais para a Configuração de Aplicativos. O provedor do Kubernetes também dá suporte a atualizações de configuração dinâmicas. Essa é a opção recomendada, se viável para você.

  • Atualize seu aplicativo para usar bibliotecas do provedor de Configuração de Aplicativos do Azure. As bibliotecas de provedor estão disponíveis em muitas estruturas e idiomas, como ASP.NET, .NET, Java Spring, JavaScript/Node.js e Python. Essa abordagem permite acesso completo às funcionalidades da Configuração de Aplicativos, incluindo a configuração dinâmica e o gerenciamento de recursos. Você tem controle granular de quais dados carregar e de qual repositório de Configuração de Aplicativos para cada aplicativo.

  • Integre-se à implantação do Kubernetes usando o Helm. Se você não quiser atualizar seu aplicativo ou adicionar um novo pod ao cluster do AKS, terá a opção de trazer dados da Configuração de Aplicativos para o cluster do Kubernetes usando o Helm por meio da implantação. Essa abordagem permite que seu aplicativo continue acessando a configuração de variáveis e segredos do Kubernetes. Você pode executar a atualização do Helm sempre que quiser que seu aplicativo incorpore novas alterações de configuração.

Acesso do Serviço de Aplicativo ou do Azure Functions à Configuração de Aplicativos

Use o provedor de Configuração de Aplicativos ou as bibliotecas do SDK para acessar a Configuração de Aplicativos diretamente no aplicativo. Essa abordagem permite acesso completo às funcionalidades da Configuração de Aplicativos, incluindo a configuração dinâmica e o gerenciamento de recursos. O aplicativo em execução no Serviço de Aplicativo ou no Azure Functions pode obter acesso ao repositório Configuração de Aplicativos com um dos seguintes métodos:

Você também pode deixar os dados da Configuração de Aplicativos acessíveis ao aplicativo como Configurações do aplicativo ou variáveis de ambiente. Com essa abordagem, você evita alterar o código do aplicativo.

Reduzir solicitações feitas à configuração do aplicativo

Solicitações excessivas para a configuração do aplicativo podem resultar na limitação ou encargos excedentes. Para reduzir o número de solicitações feitas:

  • Aumente o intervalo de atualização, especialmente se os valores de configuração não forem alterados com frequência. Especifique um novo intervalo de atualização usando o método SetRefreshInterval.

  • Assista a uma única chave do Sentinela, em vez de observar as chaves individuais. Atualize todas as configurações somente se a chave do Sentinela for alterada. Consulte Usar a configuração dinâmica em um aplicativo ASP.NET Core para ver um exemplo.

  • Use o provedor de Kubernetes de Configuração de Aplicativo se você executar várias cargas de trabalho em um cluster do Kubernetes, cada um extraindo dados da Configuração de Aplicativos individualmente. O provedor do Kubernetes recupera dados da Configuração de Aplicativos e os disponibiliza como Kubernetes ConfigMaps e Segredos. Dessa forma, suas cargas de trabalho podem acessar os dados por meio de ConfigMaps e Segredos sem a necessidade de efetuar pull de dados da Configuração de Aplicativos separadamente.

  • Habilite a replicação geográfica do seu repositório de Configuração de Aplicativos e espalhe suas solicitações em várias réplicas. Por exemplo, use uma réplica diferente de cada região geográfica para um aplicativo implantado globalmente. Cada réplica de Configuração de Aplicativo tem sua cota de solicitação separada. Essa configuração oferece um modelo de escalabilidade e resiliência aprimorada contra paralisações transitórias e regionais.

Importando dados de configuração para configuração de aplicativo

A configuração de aplicativo oferece a opção de importar em massa suas definições de configuração de seus arquivos de configuração atuais usando o portal do Azure ou a CLI. Você também pode usar as mesmas opções para exportar valores-chave da Configuração de Aplicativos, por exemplo, entre lojas relacionadas. Se você adotar a Configuração como Código e gerenciar suas configurações no GitHub ou no Azure DevOps, poderá configurar a importação contínua de arquivos de configuração usando o GitHub Actions ou a Tarefa de Importação de Pipeline do Azure.

Implantação de várias regiões na Configuração de Aplicativos

Se seu aplicativo for implantado em várias regiões, recomendamos que você habilite a replicação geográfica do repositório de Configuração de Aplicativos. Você pode permitir que seu aplicativo se conecte principalmente à réplica correspondente à região onde as instâncias do aplicativo são implantadas e permitir que elas façam failover para réplicas em outras regiões. Essa configuração minimiza a latência entre o aplicativo e a Configuração do Aplicativo, distribui a carga à medida que cada réplica tem cotas de limitação separadas e aumenta a resiliência do aplicativo contra paralisações transitórias e regionais. Para obter mais informações, consulte Resiliência e Recuperação de Desastre.

Criando aplicativos com alta resiliência

Os aplicativos geralmente dependem da configuração para iniciar, tornando a alta disponibilidade da Configuração de Aplicativos do Azure crítica. Para melhorar a resiliência, os aplicativos devem usar os recursos de confiabilidade da Configuração de Aplicativos e considerar tomar as medidas a seguir com base em seus requisitos específicos.

  • Provisionar em regiões com suporte à zona de disponibilidade do Azure. As zonas de disponibilidade permitem que os aplicativos sejam resilientes a interrupções de data center. A Configuração de Aplicativos oferece redundância de zona para todos os clientes sem encargos extras. É recomendável criar seu repositório de Configuração de Aplicativos em regiões com suporte para zonas de disponibilidade. Você pode encontrar uma lista de regiões em que a Configuração de Aplicativos habilitou o suporte à zona de disponibilidade.
  • Habilite a replicação geográfica e permita que seu aplicativo faça failover ou distribua a carga entre réplicas. Essa configuração oferece um modelo de escalabilidade e resiliência aprimorada contra falhas transitórias e interrupções regionais. Para obter mais informações, consulte Resiliência e Recuperação de Desastre.
  • Implantar a configuração com práticas de implantação seguras. Alterações de configuração incorretas ou acidentais podem frequentemente causar tempo de inatividade do aplicativo. Você deve evitar fazer alterações de configuração que afetam a produção diretamente do portal do Azure, por exemplo, sempre que possível. Em SDP (práticas de implantação seguras), você usa um modelo de implantação de exposição progressiva para minimizar o raio de explosão potencial de problemas causados pela implantação. Se você adotar o SDP, poderá criar e testar um instantâneo de configuração antes de implantá-lo na produção. Durante a implantação, você pode atualizar as instâncias do aplicativo para selecionar progressivamente o novo instantâneo. Se forem detectados problemas, você poderá reverter a alteração reimplantando o instantâneo LKG (last-known-good). O instantâneo é imutável, garantindo consistência em todas as implantações. Você pode utilizar instantâneos junto com a configuração dinâmica. Use um instantâneo para sua configuração básica e configuração dinâmica para substituições de configuração de emergência e sinalizadores de recursos.
  • Inclua a configuração com seu aplicativo. Se você quiser garantir que seu aplicativo sempre tenha acesso a uma cópia da configuração ou se preferir evitar uma dependência de runtime na Configuração de Aplicativos completamente, você poderá efetuar pull da configuração da Configuração de Aplicativos durante o tempo de build ou lançamento e incluí-la com seu aplicativo. Para saber mais, confira exemplos de integração da Configuração de Aplicativos ao pipeline de CI/CD ou implantação do Kubernetes.
  • Use provedores de Configuração de Aplicativos. Os aplicativos desempenham um papel fundamental na obtenção de alta resiliência porque podem considerar problemas decorrentes durante o runtime, como problemas de rede, e responder a falhas mais rapidamente. Os provedores de Configuração de Aplicativos oferecem uma variedade de recursos internos de resiliência, incluindo descoberta automática de réplica, failover de réplica, tentativas de inicialização com tempos limite personalizáveis, cache de configuração e estratégias adaptáveis para atualização de configuração confiável. É altamente recomendável que você use provedores de Configuração de Aplicativos para se beneficiar desses recursos. Se essa não for uma opção, considere implementar recursos semelhantes em sua solução personalizada para alcançar o nível mais alto de resiliência.

Aplicativos cliente na Configuração de Aplicativos

Quando usar a Configuração de Aplicativos em aplicativos cliente, não deixe de considerar dois fatores principais. Primeiro, se estiver usando a cadeia de conexão em um aplicativo cliente, você correrá o risco de expor a chave de acesso do seu armazenamento de Configuração de Aplicativos para o público. Segundo, a escala comum de um aplicativo cliente pode causar solicitações excessivas ao armazenamento de Configuração do Aplicativos, o que pode resultar em encargos excedentes ou limitação. Para saber mais informações sobre limitação, consulte as Perguntas frequentes.

Para resolver essas preocupações, recomendamos que você use um serviço de proxy entre seus aplicativos cliente e seu armazenamento de Configuração de Aplicativos. O serviço de proxy pode se autenticar com segurança com seu armazenamento de Configuração de Aplicativos sem um problema de segurança ao vazar informações de autenticação. Você pode criar um serviço de proxy usando uma das bibliotecas de provedor da Configuração de Aplicativos, para que você possa aproveitar os recursos internos de cache e atualização para otimizar o volume de solicitações enviadas para a Configuração de Aplicativos. Para obter mais informações sobre como usar provedores de Configuração de Aplicativos, consulte os artigos nas Guias de Início Rápido e Tutoriais. O serviço de proxy serve a configuração de seu cache para seus aplicativos cliente e você evita os dois problemas potenciais que são discutidos nesta seção.

Aplicativos multilocatário na Configuração de Aplicativos

Um aplicativo multilocatário é criado em uma arquitetura em que uma instância compartilhada do aplicativo atende a vários clientes ou locatários. Por exemplo, você pode ter um serviço de email que oferece aos usuários contas separadas e experiências personalizadas. Seu aplicativo normalmente gerencia configurações diferentes para cada locatário. Aqui estão algumas considerações de arquitetura para usar a Configuração de Aplicativos em um aplicativo multilocatário. Você também pode referenciar o código de exemplo para configuração de aplicativo multilocatário.

Configuração como código

A configuração como código é uma prática de gerenciar arquivos de configuração no sistema de controle do código-fonte, por exemplo, um repositório Git. Ela oferece benefícios como rastreabilidade e processo de aprovação para qualquer alteração de configuração. Se você adotar a configuração como código, a Configuração de Aplicativos terá ferramentas para ajudar você a gerenciar seus dados de configuração em arquivos e implantá-los como parte do processo da CI/CD, de liberação ou de compilação. Dessa forma, seus aplicativos podem acessar os dados mais recentes do repositório de Configuração de Aplicativos.

  • Para o GitHub, você pode importar arquivos de configuração do repositório do GitHub para o repositório de Configuração de Aplicativos usando o GitHub Actions
  • Para o Azure DevOps, você pode incluir a Importação da Configuração de Aplicativos do Azure, uma tarefa de pipeline do Azure, nos seus pipelines de build ou de lançamento para a sincronização de dados.
  • Para outras pessoas, você pode importar arquivos de configuração para a Configuração de Aplicativos usando a CLI do Azure como parte do seu sistema de CI/CD. Para obter mais informações, confira az appconfig kv import.

Esse modelo permite que você inclua etapas de validação e de teste antes de confirmar os dados na Configuração de Aplicativos. Se você usar vários repositórios da Configuração de Aplicativos, também poderá enviar por push os dados de configuração para eles de modo incremental ou todos de uma só vez.

Próximas etapas