Guia de início rápido: criar um aplicativo do Azure Functions com a Configuração do Aplicativo do Azure

Este guia de início rápido mostra como centralizar e gerenciar as configurações do aplicativo Azure Functions fora do seu código usando a Configuração do Aplicativo do Azure. Com a integração do provedor de configuração .NET, você pode adicionar a Configuração do Aplicativo como uma fonte de configuração extra com apenas algumas alterações de código simples.

Pré-requisitos

• Uma conta do Azure com uma subscrição ativa. Crie um gratuitamente.
• Uma loja de configuração de aplicativos, conforme mostrado no tutorial para criar uma loja.
• Visual Studio com a carga de trabalho de desenvolvimento do Azure.
• Ferramentas do Azure Functions.

Adicionar um valor-chave

Adicione o seguinte valor-chave à loja de Configuração de Aplicativos e deixe Rótulo e Tipo de Conteúdo com seus valores padrão. Para obter mais informações sobre como adicionar valores-chave a uma loja usando o portal do Azure ou a CLI, vá para Criar um valor-chave.

Chave	valor
TestApp:Configurações:Mensagem	Dados da Configuração do Aplicativo do Azure

Criar um aplicativo de função

Crie um aplicativo do Azure Functions usando o Visual Studio selecionando o modelo do Azure Functions (C# ). Este modelo orienta você na definição de configurações essenciais para seu projeto. Para obter instruções detalhadas, consulte Desenvolver funções do Azure usando o Visual Studio.

Use a tabela a seguir como referência para parâmetros-chave ao criar seu aplicativo de função.

Configuração	valor
Trabalhador de funções	.NET 8.0 em implementação isolada
Função	Acionador HTTP
Nível de autorização	Anônimo

Nota

A Configuração de Aplicativo do Azure pode ser usada com o Azure Functions no modelo de trabalho isolado ou no modelo em processo. Este guia de início rápido usa o modelo de trabalhador isolado como exemplo. Você pode encontrar exemplos de código completos para ambos os modelos no repositório GitHub de Configuração de Aplicativo do Azure.

Conectar-se a uma loja de configuração de aplicativos

Você pode se conectar à sua loja de Configuração de Aplicativos usando a ID do Microsoft Entra (recomendado) ou uma cadeia de conexão.

1. Clique com o botão direito do mouse em seu projeto e selecione Gerenciar pacotes NuGet. Na guia Procurar , procure e adicione a versão estável mais recente dos seguintes pacotes NuGet ao seu projeto.

   Microsoft Entra ID (recomendado)

   • Microsoft.Azure.AppConfiguration.Functions.Worker
   • Azure.Identity

   Cadeia de conexão

   • Microsoft.Azure.AppConfiguration.Functions.Worker

2. Abra Program.cs e atualize o código da seguinte maneira. Você adiciona a Configuração do Aplicativo do Azure como uma fonte de configuração adicional chamando o AddAzureAppConfiguration método.

   Microsoft Entra ID (recomendado)

   Você usa o DefaultAzureCredential para autenticar na sua loja de configuração de aplicativos. Siga as instruções para atribuir à sua credencial a função de Leitor de Dados de Configuração do Aplicativo. Certifique-se de dar tempo suficiente para que a permissão se propague antes de executar seu aplicativo.

   using Azure.Identity;
   using Microsoft.Azure.Functions.Worker.Builder;
   using Microsoft.Extensions.Configuration;
   using Microsoft.Extensions.Hosting;
   
   var builder = FunctionsApplication.CreateBuilder(args);
   
   // Connect to Azure App Configuration
   builder.Configuration.AddAzureAppConfiguration(options =>
   {
       Uri endpoint = new(Environment.GetEnvironmentVariable("AZURE_APPCONFIG_ENDPOINT") ?? 
           throw new InvalidOperationException("The environment variable 'AZURE_APPCONFIG_ENDPOINT' is not set or is empty."));
       options.Connect(endpoint, new DefaultAzureCredential())
              // Load all keys that start with `TestApp:` and have no label
              .Select("TestApp:*");
   });
   

   Cadeia de conexão

   using Microsoft.Azure.Functions.Worker.Builder;
   using Microsoft.Extensions.Configuration;
   using Microsoft.Extensions.Hosting;
   
   var builder = FunctionsApplication.CreateBuilder(args);
   
   // Connect to Azure App Configuration
   builder.Configuration.AddAzureAppConfiguration(options =>
   {
       string connectionString = Environment.GetEnvironmentVariable("AZURE_APPCONFIG_CONNECTION_STRING") ?? 
           throw new InvalidOperationException("The environment variable 'AZURE_APPCONFIG_CONNECTION_STRING' is not set or is empty.");
       options.Connect(connectionString)
              // Load all keys that start with `TestApp:` and have no label
              .Select("TestApp:*");
   });
   

3. Abra Function1.cs e adicione o namespace a seguir.

   using Microsoft.Extensions.Configuration;
   

   Atualize o construtor para obter uma instância de IConfiguration através de injeção de dependência.

   private readonly IConfiguration _configuration;
   private readonly ILogger<Function1> _logger;
   
   public Function1(IConfiguration configuration, ILogger<Function1> logger)
   {
       _configuration = configuration;
       _logger = logger;
   }
   

4. Atualize o Run método para ler valores da configuração.

   [Function("Function1")]
   public IActionResult Run([HttpTrigger(AuthorizationLevel.Anonymous, "get", "post")] HttpRequest req)
   {
       _logger.LogInformation("C# HTTP trigger function processed a request.");
   
       // Read configuration data
       string key = "TestApp:Settings:Message";
       string? message = _configuration[key];
   
       return new OkObjectResult(message ?? $"Please create a key-value with the key '{key}' in Azure App Configuration.");
   }
   

Testar localmente a função

1. Defina a variável de ambiente .

   Microsoft Entra ID (recomendado)

   Defina a variável de ambiente chamada AZURE_APPCONFIG_ENDPOINT para o ponto de extremidade da sua loja de Configuração de Aplicativos encontrado em Visão geral da sua loja no portal do Azure.

   Se você usar o prompt de comando do Windows, execute o seguinte comando 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 seguinte comando:

   export AZURE_APPCONFIG_ENDPOINT='<endpoint-of-your-app-configuration-store>'
   

   Cadeia de conexão

   Defina a variável de ambiente chamada AZURE_APPCONFIG_CONNECTION_STRING para a cadeia de conexão somente leitura da configuração de aplicação encontrada em Configurações de acesso do seu armazenamento no portal do Azure.

   Se você usar o prompt de comando do Windows, execute o seguinte comando 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 seguinte comando:

   export AZURE_APPCONFIG_CONNECTION_STRING='<connection-string-of-your-app-configuration-store>'
   

2. Pressione F5 para testar sua função. Se solicitado, aceite a solicitação do Visual Studio para baixar e instalar as ferramentas CLI (Azure Functions Core). Também pode ser necessário habilitar uma exceção de firewall para que as ferramentas possam lidar com solicitações HTTP.

3. Copie o URL da sua função na saída do tempo de execução das funções do Azure.

   

4. Cole o URL do pedido HTTP na barra de endereço do browser. A imagem a seguir mostra a resposta no navegador para a solicitação GET local retornada pela função.

   

Gerencie parâmetros de gatilho com referências de Configuração de Aplicativo

Os gatilhos do Azure Functions definem como uma função é invocada. Os atributos de gatilho, como nomes de fila ou nomes de banco de dados, são carregados no momento da inicialização do host e não podem recuperar valores diretamente da Configuração do Aplicativo do Azure. Para gerenciar esses parâmetros, você pode usar o recurso de referência Configuração do Aplicativo disponível para o Azure Functions e o Serviço de Aplicativo.

O recurso de referência de Configuração do Aplicativo permite que você faça referência a valores-chave armazenados na Configuração do Aplicativo do Azure diretamente das configurações do seu aplicativo. O Azure Functions resolve essas referências na inicialização, permitindo que você gerencie parâmetros de gatilho de forma centralizada e segura.

Por exemplo, considere uma aplicação de funções acionada por fila. Em vez de especificar o nome da fila diretamente no atributo trigger, você pode fazer referência a um valor-chave armazenado na Configuração do Aplicativo do Azure.

1. Na sua loja de Configuração de Aplicações do Azure, adicione um valor-chave para o nome da fila:

   Chave	valor
   TestApp:Armazenamento:QueueName	<O nome da fila na sua conta de armazenamento>

2. No seu aplicativo Função, selecione Configurações ->Variáveis de ambiente ->Configurações do aplicativo no portal do Azure e crie uma configuração de aplicativo que faça referência à chave Configuração do Aplicativo:

   Nome	valor
   MyQueueName	@Microsoft.AppConfiguration(Endpoint=<your-store-endpoint>; Key=TestApp:Storage:QueueName)

   Sugestão

   Se você tiver vários valores de chave na Configuração do Aplicativo do Azure, poderá exportá-los em lote como referências de Configuração do Aplicativo para o Azure Functions usando o portal do Azure ou a CLI.

3. Habilite a identidade gerenciada para seu aplicativo Azure Functions e atribua-lhe a função Leitor de Dados de Configuração do Aplicativo para sua loja de Configuração de Aplicativos. Para obter instruções detalhadas sobre como configurar referências de Configuração de Aplicativo, consulte Usar referências de Configuração de Aplicativo no Serviço de Aplicativo e no Azure Functions.

4. Atualize sua função acionada por fila para usar a configuração do aplicativo:

   [Function("QueueTriggeredFunction")]
   public void Run([QueueTrigger(queueName: "%MyQueueName%")] QueueMessage message)
   {
       _logger.LogInformation($"C# Queue trigger function processed: {message.MessageText}");
   }
   

   No tempo de execução, o Azure Functions resolve o marcador de posição %MyQueueName% para o valor armazenado na Configuração de Aplicativos do Azure, permitindo que você gere os parâmetros de gatilho centralmente sem os codificar no seu código de função.

Clean up resources (Limpar recursos)

Se não quiser continuar a utilizar os recursos criados neste artigo, elimine o grupo de recursos que criou aqui para evitar cobranças.

Importante

A eliminação de um grupo de recursos é irreversível. O grupo de recursos e todos os recursos nele contidos são excluídos permanentemente. Certifique-se de não excluir acidentalmente o grupo de recursos ou recursos errados. Se você criou os recursos para este artigo dentro de um grupo de recursos que contém outros recursos que deseja manter, exclua cada recurso individualmente de seu respetivo painel em vez de excluir o grupo de recursos.

1. Entre no portal do Azure e selecione Grupos de recursos.
2. Na caixa Filtrar por nome, introduza o nome do seu grupo de recursos.
3. Na lista de resultados, selecione o nome do grupo de recursos para ver uma visão geral.
4. Selecione Eliminar grupo de recursos.
5. É-lhe pedido que confirme a eliminação do grupo de recursos. Insira o nome do grupo de recursos a ser confirmado e selecione Excluir.

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

Próximos passos

Neste início rápido, você integrou a Configuração do Aplicativo do Azure com um aplicativo do Azure Functions. Para saber como habilitar seu aplicativo Function para atualizar dinamicamente as definições de configuração, continue para o próximo tutorial.

Ativar a configuração dinâmica nas Funções do Azure

Para saber como usar sinalizadores de recursos da Configuração de Aplicativo do Azure em seu aplicativo Azure Functions, prossiga para o tutorial a seguir.

Usar sinalizadores de recursos no Azure Functions

Para saber como usar uma identidade gerenciada do Azure para simplificar o acesso à Configuração do Aplicativo, continue para o tutorial a seguir.

Acessar a configuração do aplicativo usando identidade gerenciada