Desenvolver o Azure Functions usando o Visual Studio

O Visual Studio fornece uma maneira de desenvolver, testar e implantar funções de biblioteca de classes C# no Azure. Se essa experiência for a primeira com o Azure Functions, confira a visão geral do Azure Functions.

Este artigo fornece informações detalhadas sobre como usar o Visual Studio para desenvolver funções de biblioteca de classes em C# e publicá-las no Azure. Há dois modelos para desenvolver funções de biblioteca de classes em C#: o modelo de trabalho isolado e o modelo em processo.

Os procedimentos e exemplos mostrados são para o Visual Studio 2022, a não ser que haja alguma indicação contrária. Para obter mais informações sobre as versões do Visual Studio 2022, consulte as notas de versão ou as notas de versão prévia.

Pré-requisitos

• Visual Studio 2022, incluindo a carga de trabalho de Desenvolvimento do Azure.

• Outros recursos necessários, como uma conta de armazenamento do Azure, são criados em sua assinatura durante o processo de publicação.

• Se você ainda não tiver uma conta do Azure, crie uma conta gratuita antes de começar.

Criar um projeto do Azure Functions

O modelo de projeto do Azure Functions no Visual Studio cria um projeto de biblioteca de classes C# que você pode publicar em um aplicativo de funções no Azure. Você pode usar um aplicativo de funções para agrupar funções como uma unidade lógica para facilitar o gerenciamento, a implantação, o dimensionamento e o compartilhamento de recursos.

1. No menu do Visual Studio, selecione Arquivo>Novo>Projeto.

2. Na caixa de diálogo Criar um novo projeto , insira funções na caixa de pesquisa, selecione o modelo do Azure Functions e selecione Avançar.

3. Na caixa de diálogo Configurar seu novo projeto , para o nome do Projeto, insira um nome para seu projeto e selecione Avançar. O nome do aplicativo de funções deve ser válido como um namespace do C# e, portanto, não use outros caracteres não alfanuméricos, hífens ou sublinhados.

4. Na caixa de diálogo de Informações adicionais execute as ações listadas na tabela a seguir.

   Configuração	Ação	Descrição
   Função de trabalho do Functions	Selecione .NET 8.0 isolado (suporte a longo prazo).	O Visual Studio cria um projeto de função que é executado em um processo de trabalho isolado. O processo de trabalho isolado também dá suporte a outras versões do .NET e do .NET Framework que não oferecem LTS (suporte a longo prazo). Para obter mais informações, consulte Visão geral de versões do Azure Functions runtime.
   Função	Selecione Http trigger.	O Visual Studio cria uma função disparada por uma solicitação HTTP.
   Usar o Azurite para a conta de armazenamento de runtime (AzureWebJobsStorage)	Selecione essa caixa de seleção.	Como um aplicativo de funções no Azure requer uma conta de armazenamento, ela será atribuída ou criada quando você publicar seu projeto no Azure. Um disparador HTTP não usa uma cadeia de conexão da conta de armazenamento. Todos os outros tipos de gatilho exigem uma cadeia de conexão de conta de armazenamento válida.
   Nível de autorização	Selecione Anônimo.	Quando você usa essa configuração de autorização, qualquer cliente pode disparar a função criada sem fornecer uma chave. Essa configuração facilita o teste da nova função. Para obter mais informações, confira Nível de autorização.

   

   Configuração	Ação	Descrição
   Função de trabalho do Functions	Selecione .NET 8.0 em processo (suporte a longo prazo).	O Visual Studio cria um projeto de função que é executado em processo com a versão 4.x do runtime do Functions. Para obter mais informações, consulte Visão geral de versões do Azure Functions runtime.
   Função	Selecione Http trigger.	O Visual Studio cria uma função disparada por uma solicitação HTTP.
   Usar o Azurite para a conta de armazenamento de runtime (AzureWebJobsStorage)	Selecione essa caixa de seleção.	Como um aplicativo de funções no Azure requer uma conta de armazenamento, ela será atribuída ou criada quando você publicar seu projeto no Azure. Um disparador HTTP não usa uma cadeia de conexão da conta de armazenamento. Todos os outros tipos de gatilho exigem uma cadeia de conexão de conta de armazenamento válida.
   Nível de autorização	Selecionar Anônimo	Quando você usa essa configuração de autorização, qualquer cliente pode disparar a função criada sem fornecer uma chave. Essa configuração facilita o teste da nova função. Para obter mais informações, confira Nível de autorização.

   

   Verifique se você definiu o Nível de autorização como Anônimo. Se você selecionar o nível padrão da Função, será necessário apresentar a chave de função em solicitações para acessar o ponto de extremidade da função.

5. Selecione Criar para criar o projeto de função e a função de gatilho HTTP.

O novo projeto contém os seguintes arquivos:

• host.json: esse arquivo fornece uma maneira de configurar o host do Functions. Essas configurações se aplicam para execução local e no Azure. Para obter mais informações, consulte a referência para host.json.

• local.settings.json: esse arquivo mantém as configurações que você usa ao executar funções localmente. Essas configurações não são usadas quando seu aplicativo é executado no Azure. Para obter mais informações, consulte Trabalhar com as configurações do aplicativo localmente.

  Importante

  Como o arquivo local.settings.json pode conter segredos, você deve excluí-lo do controle do código-fonte do projeto. Na caixa de diálogo Propriedades desse arquivo, verifique se a configuração Copiar para Diretório de Saída está definida como Copiar se for mais recente.

Trabalhar com configurações de aplicativo localmente

Quando seu aplicativo de funções é executado no Azure, as configurações exigidas por suas funções são armazenadas criptografadas nas configurações do aplicativo. Durante o desenvolvimento local, essas configurações são adicionadas à Values coleção no arquivo local.settings.json. O arquivo local.settings.json também armazena as configurações usadas pelas ferramentas de desenvolvimento locais.

Os itens da coleção Values no arquivo local.settings.json do seu projeto destinam-se a espelhar itens nas configurações de aplicativo do seu aplicativo de funções no Azure.

O Visual Studio não carrega automaticamente as configurações em local.settings.json quando você publica o projeto. Para que essas configurações também existam em seu aplicativo de funções no Azure, carregue-as depois de publicar seu projeto. Para obter mais informações, confira Configurações do aplicativo de funções. Os valores em uma ConnectionStrings coleção não são publicados.

Seu código também pode ler os valores de configurações do aplicativo de funções como variáveis de ambiente. Para obter mais informações, confira Variáveis de ambiente.

Configurar seu projeto para desenvolvimento local

O runtime do Functions usa uma conta de Armazenamento internamente. Durante o desenvolvimento, você pode usar uma conta de Armazenamento válida para essa conta interna ou usar o emulador do Azurite.

Para todos os tipos de gatilho que não sejam HTTP e webhooks, você precisa definir o valor da Values.AzureWebJobsStorage chave no arquivo local.settings.json :

• Para uma conta de armazenamento, configure o valor para a string de conexão da sua conta de armazenamento.
• Para o emulador, defina o valor como UseDevelopmentStorage=true.

Se você usar o emulador, altere essa configuração para uma cadeia de conexão de conta de armazenamento real antes da implantação. Para mais informações, confira Emulador de armazenamento local.

Para definir a cadeia de conexão da conta de armazenamento, execute as seguintes etapas:

1. Entre no portal do Azure e vá para sua conta de armazenamento.

2. Selecione Segurança + chaves de acesso de> rede. Na chave1, copie o valor da cadeia de conexão .

3. No projeto do Visual Studio, abra o arquivo local.settings.json . Defina o valor da AzureWebJobsStorage chave para a cadeia de conexão copiada.

4. Repita a etapa anterior para adicionar as chaves exclusivas para a matriz de Values para todas as outras conexões necessárias para as suas funções.

Adicionar uma função ao projeto

Em funções de biblioteca de classes C#, as associações que as funções usam são definidas aplicando atributos no código. Quando você cria seus gatilhos de função com base nos modelos fornecidos, os atributos de gatilho são aplicados para você.

1. No Gerenciador de Soluções, clique com o botão direito do mouse no nó do seu projeto e selecione Adicionar>Novo Azure Function.

2. Na caixa de diálogo Adicionar Novo Item , selecione a Função do Azure e, em seguida, selecione Adicionar.

3. Selecione um gatilho e defina as propriedades de associação necessárias. Se você selecionar um gatilho de serviço de armazenamento e quiser configurar a conexão, marque a caixa de seleção para configuração da conexão do gatilho. O exemplo a seguir mostra as configurações para criar uma função de gatilho de Armazenamento em Fila.

   

4. Selecione Adicionar. Se você selecionar a caixa de seleção para configurar uma conexão de armazenamento na etapa anterior, a página Conectar à dependência será exibida. Selecione um emulador de armazenamento do Azurite ou o Armazenamento do Azure e selecione Avançar.

   • Se você selecionar um emulador de armazenamento do Azurite, a página Conectar ao emulador do Azurite de Armazenamento será exibida. Execute as seguintes etapas:
     1. Selecione Próximo.
     2. Na página Resumo das alterações , selecione Concluir. O Visual Studio configura a dependência e cria a classe de gatilho.
   • Se você selecionar o Armazenamento do Azure, a página Conectar ao Armazenamento do Azure será exibida. Execute as seguintes etapas:
     1. Selecione uma conta de armazenamento e selecione Avançar. O Visual Studio tenta se conectar à sua conta do Azure e recuperar um endpoint.
     2. Selecione Próximo.
     3. Na página Resumo das alterações , selecione Concluir. O Visual Studio configura a dependência e cria a classe de gatilho.

   Esse exemplo de gatilho usa uma configuração de aplicativo para a conexão de armazenamento com uma chave chamada QueueStorage. Essa chave, armazenada no arquivolocal.settings.json, faz referência ao emulador do Azurite ou a uma conta de Armazenamento.

5. Examine a classe recém-adicionada. Por exemplo, a seguinte classe C# representa uma função básica de gatilho do Armazenamento de Filas:

   Um Run() método é atribuído com Function. Esse atributo indica que o método é o ponto de entrada para a função.

   using System;
   using Azure.Storage.Queues.Models;
   using Microsoft.Azure.Functions.Worker;
   using Microsoft.Extensions.Logging;
   
   namespace Company.Function;
   
   public class QueueTriggerCSharp
   {
       private readonly ILogger<QueueTriggerCSharp> _logger;
   
       public QueueTriggerCSharp(ILogger<QueueTriggerCSharp> logger)
       {
           _logger = logger;
       }
   
       [Function(nameof(QueueTriggerCSharp))]
       public void Run([QueueTrigger("PathValue", Connection = "ConnectionValue")] QueueMessage message)
       {
           _logger.LogInformation("C# Queue trigger function processed: {messageText}", message.MessageText);
       }
   }
   

   Um método estático Run() é atribuído com FunctionName. Esse atributo indica que o método é o ponto de entrada para a função.

   using System;
   using Microsoft.Azure.WebJobs;
   using Microsoft.Azure.WebJobs.Host;
   using Microsoft.Extensions.Logging;
   
   namespace Company.Function
   {
       public class QueueTriggerCSharp
       {
           [FunctionName("QueueTriggerCSharp")]
           public void Run([QueueTrigger("PathValue", Connection = "ConnectionValue")]string myQueueItem, ILogger log)
           {
               log.LogInformation($"C# Queue trigger function processed: {myQueueItem}");
           }
       }
   }
   

Um atributo específico de associação é aplicado a cada parâmetro de associação fornecido ao método do ponto de entrada. O atributo utiliza as informações de associação como parâmetros.

No código anterior, é aplicado um atributo QueueTrigger ao primeiro parâmetro, o que indica uma função de gatilho do Armazenamento de Filas. O nome da fila e o nome de configuração da cadeia de conexão são passadas como parâmetros ao atributo QueueTrigger. Na sua turma:

• O parâmetro de nome da fila deve corresponder ao nome da fila que você usa em uma etapa anterior para criar o gatilho, como myqueue-items.
• O nome da configuração da cadeia de conexão deve corresponder ao que você usa em uma etapa anterior para criar o gatilho, como QueueStorage.

Para obter mais informações, confira Gatilho do Armazenamento de Filas do Azure para o Azure Functions.

Use o procedimento anterior para adicionar mais funções ao projeto do aplicativo de funções. Cada função no projeto pode ter um gatilho diferente, mas uma função deve ter apenas um gatilho. Para obter mais informações, consulte gatilhos e associações do Azure Functions.

Adicionar associações

Assim como acontece com gatilhos, as associações de entrada e saída são adicionadas à sua função como atributos de associação. Para adicionar associações a uma função, execute as seguintes etapas:

1. Verifique se você configurou o projeto de desenvolvimento local.

2. Adicione o pacote de extensão NuGet apropriado para cada associação específica. Para obter requisitos de pacote NuGet específicos da associação, confira o artigo de referência para a associação. Por exemplo, para obter requisitos de pacote para o gatilho dos Hubs de Eventos do Azure, confira Gatilhos e associações dos Hubs de Eventos do Azure para o Azure Functions.

3. Use o seguinte comando no Console do Gerenciador de Pacotes para instalar um pacote específico:

   Install-Package Microsoft.Azure.Functions.Worker.Extensions.<BINDING_TYPE> -Version <TARGET_VERSION>
   

   Install-Package Microsoft.Azure.WebJobs.Extensions.<BINDING_TYPE> -Version <TARGET_VERSION>
   

   Nesse código, substitua <BINDING_TYPE> pelo nome específico da extensão de associação e substitua <TARGET_VERSION> por uma versão específica do pacote, como 4.0.0. Versões válidas são listadas nas páginas de pacotes individuais em NuGet.org.

4. Se houver configurações de aplicativo exigidas pela associação, adicione-as à coleção Values no arquivo de configuração local.

   A função usa esses valores quando ele é executado localmente. Quando a função é executada no aplicativo de funções no Azure, ela usa configurações do aplicativo de funções. O Visual Studio facilita a publicação de configurações locais no Azure.

5. Adicione o atributo de associação apropriado para a assinatura do método. No código a seguir, uma mensagem de fila dispara a função Run. Em seguida, a associação de saída cria uma nova mensagem de fila com o mesmo texto em uma fila diferente.

    public class QueueTrigger
   {
       private readonly ILogger _logger;
   
       public QueueTrigger(ILoggerFactory loggerFactory)
       {
           _logger = loggerFactory.CreateLogger<QueueTrigger>();
       }
   
       [Function("CopyQueueMessage")]
       [QueueOutput("myqueue-items-destination", Connection = "QueueStorage")]
       public string Run([QueueTrigger("myqueue-items-source", Connection = "QueueStorage")] string myQueueItem)
       {
           _logger.LogInformation($"C# Queue trigger function processed: {myQueueItem}");
           return myQueueItem;
       }
   }
   

   O atributo QueueOutput define a associação no método. Para várias associações de saída, coloque esse atributo em uma propriedade de cadeia de caracteres do objeto retornado. Para obter mais informações, consulte Várias associações de saída.

   public static class SimpleExampleWithOutput
   {
       [FunctionName("CopyQueueMessage")]
       public static void Run(
           [QueueTrigger("myqueue-items-source", Connection = "QueueStorage")] string myQueueItem, 
           [Queue("myqueue-items-destination", Connection = "QueueStorage")] out string myQueueItemCopy,
           ILogger log)
       {
           log.LogInformation($"CopyQueueMessage function processed: {myQueueItem}");
           myQueueItemCopy = myQueueItem;
       }
   }
   

   O atributo Queue no parâmetro out define a associação de saída.

   A conexão com o Armazenamento de Filas é obtida a partir da configuração QueueStorage. Para saber mais, confira o artigo de referência da associação específica.

Para ver uma lista completa das vinculações compatíveis com o Functions, confira Vinculações compatíveis. Para obter um exemplo mais completo desse cenário, consulte Conectar funções ao Armazenamento do Azure usando o Visual Studio.

Executar funções localmente

Você pode usar as Ferramentas Principais do Azure Functions para executar projetos do Functions em seu computador de desenvolvimento local. Quando você pressiona F5 para depurar um projeto do Functions, o host local do Functions (func.exe) começa a escutar em uma porta local (geralmente a 7071). Todos os pontos de extremidade de função que podem ser chamados são gravados na saída, e você pode usar esses pontos de extremidade para testar as funções. Para obter mais informações, consulte Desenvolver o Azure Functions localmente usando o Core Tools. É solicitado que você instale essas ferramentas na primeira vez em que inicia uma função no Visual Studio.

Para iniciar sua função no Visual Studio no modo de depuração, execute as seguintes etapas:

1. Selecione F5. Se solicitado, aceite a solicitação do Visual Studio para baixar e instalar o Azure Functions Core Tools. Talvez você também precise ativar uma exceção de firewall para que as ferramentas possam lidar com solicitações HTTP.

2. Quando o projeto for executado, teste seu código da mesma forma que você testa uma função implantada.

   Quando você executa o Visual Studio em modo de depuração, os pontos de interrupção são atingidos conforme o esperado.

Publicar no Azure

Quando você publica seu projeto do Functions no Azure, o Visual Studio usa a implantação zip para implantar os arquivos de projeto. Quando possível, você também deve selecionar Executar no arquivo de pacote para que o projeto seja executado no pacote de implantação (.zip). Para obter mais informações, consulte Executar suas funções de um arquivo de pacote no Azure.

Não implante no Azure Functions usando o Web Deploy (msdeploy).

Use as seguintes etapas para publicar seu projeto em um aplicativo de funções no Azure:

1. No Gerenciador de Soluções, clique com o botão direito do mouse no projeto e selecione Publicar.

2. Na página Publicar , faça as seguintes seleções:

   • No Destino, selecione o Azure e, em seguida, selecione Avançar.
   • No destino específico, selecione Aplicativo de Funções do Azure e selecione Avançar.
   • Na instância do Functions, selecione Criar novo.

   

3. Crie uma nova instância usando os valores especificados na tabela a seguir:

   Configuração	Valor	Descrição
   Nome	Um nome globalmente exclusivo	O nome deve identificar exclusivamente seu novo aplicativo de funções. Aceite o nome sugerido ou insira um novo nome. Os seguintes caracteres são válidos: a-z, 0-9e -.
   Nome da assinatura	O nome da sua assinatura	O aplicativo de funções é criado em uma assinatura do Azure. Aceite a assinatura padrão ou selecione uma diferente na lista.
   Grupo de recursos	O nome do grupo de recursos	O aplicativo de funções é criado em um grupo de recursos. Selecione Novo para criar um novo grupo de recursos. Você também pode selecionar um grupo de recursos existente na lista.
   Tipo de plano	Consumo flexível	Quando você publica seu projeto em um aplicativo de funções executado em um plano de Consumo Flex, você pode pagar apenas pelas execuções do aplicativo de funções. Outros planos de hospedagem podem incorrer em custos mais altos. IMPORTANTE: Ao criar um plano de Consumo Flex, primeiro você deve selecionar o Plano de Serviço de Aplicativos e, em seguida, reelecionar o Consumo Flex para resolver um problema com a caixa de diálogo.
   Sistema operacional	Linux	O plano de Consumo Flex atualmente requer Linux.
   Localidade	O local do serviço de aplicativo	Selecione um local em uma região do Azure compatível com o plano de Consumo Flex. Quando uma região não suportada é selecionada, o botão Criar fica desativado.
   Tamanho da memória da instância	2048	O tamanho da memória das instâncias da máquina virtual em que o aplicativo é executado é exclusivo do plano de Consumo Flex.
   Armazenamento do Azure	Uma conta de armazenamento de uso geral	O runtime do Functions requer uma conta de Armazenamento. Selecione Novo para configurar uma conta de armazenamento para uso geral. Você também pode usar uma conta existente que atenda aos requisitos da conta de armazenamento.
   Application Insights	Uma instância do Application Insights	Você deve ativar a integração do Application Insights para seu aplicativo de funções. Selecione Novo para criar uma nova instância, em um workspace novo ou em um workspace do Log Analytics existente. Você também pode usar uma instância existente.

   

4. Selecione Criar para criar um aplicativo de funções e recursos relacionados no Azure. O status da criação de recursos é mostrado no canto inferior esquerdo da janela.

5. Selecione Concluir. A janela Progresso da Criação do Perfil de Publicação é exibida. Quando o perfil for criado, selecione Fechar.

6. Na página publicar perfil, selecione Publicar para implantar o pacote que contém seus arquivos de projeto em seu novo aplicativo de funções no Azure.

   Quando a implantação é concluída, a URL raiz do aplicativo de funções no Azure é mostrada na página de perfil de publicação.

7. Na página publicar perfil, vá para a seção Hospedagem . Selecione as reticências (...) e, em seguida, selecione Abrir no portal do Azure. O novo recurso de aplicativo de funções do Azure é aberto no portal do Azure.

   

Configurações do aplicativo de funções

O Visual Studio não carrega as configurações do aplicativo automaticamente quando você publica seu projeto. Se você adicionar configurações ao arquivo local.settings.json , também deverá adicioná-las ao aplicativo de funções no Azure.

A maneira mais fácil de carregar as configurações necessárias para seu aplicativo de funções no Azure é gerenciá-las no Visual Studio. Na página publicar perfil, vá para a seção Hospedagem . Selecione as reticências (...) e, em seguida, selecione Gerenciar as configurações do Serviço de Aplicativo do Azure.

Quando você faz a seleção, a caixa de diálogo Configurações do aplicativo é aberta para o aplicativo de funções. Você pode usar essa caixa de diálogo para adicionar configurações de aplicativo ou modificar as existentes.

Para cada configuração, o valor Local é o valor no arquivo local.settings.json e o valor remoto é o valor no aplicativo de funções no Azure.

• Para criar uma configuração de aplicativo, selecione Adicionar configuração.
• Para copiar um valor de configuração do campo Local para o campo Remoto , selecione Inserir valor de Local.

As alterações pendentes serão gravadas no arquivo de configurações local e no aplicativo de funções quando você selecionar OK.

Você também pode gerenciar as configurações de aplicativo em um desses outros modos:

• Use o portal do Azure.
• Use a opção--publish-local-settings de publicação nas Ferramentas Principais do Azure Functions.
• Utilize o CLI do Azure.

Depuração remota

Para depurar seu aplicativo de funções remotamente, você precisa publicar uma configuração de depuração do seu projeto. Você também precisa ativar a depuração remota em seu aplicativo de funções no Azure.

Esta seção pressupõe que uma configuração de depuração em seu aplicativo de funções seja publicada.

Considerações de depuração remota

• A depuração remota não é recomendada em um serviço de produção.
• Para usar a depuração remota, você deve hospedar seu aplicativo de funções em um plano premium ou do Serviço de Aplicativo.
• Atualmente, a depuração remota só é suportada quando seu aplicativo em C# é executado no Windows.
• Se você tiver o recurso Just My Code ativado no Visual Studio, desative-o. Para obter instruções, consulte Habilitar ou desabilitar Just My Code.
• Evite paradas longas em pontos de interrupção ao usar a depuração remota. Quando um processo é interrompido por mais de alguns minutos, o Azure o trata como um processo sem resposta e o desliga.
• Enquanto você está depurando, o servidor está enviando dados para o Visual Studio, o que pode afetar os encargos de largura de banda. Para obter informações sobre as taxas de largura de banda, consulte a calculadora de preços.
• A depuração remota é desativada automaticamente em seu aplicativo de funções após 48 horas. Depois desse ponto, você precisa habilitar a depuração remota novamente.

Anexar o depurador

Ao concluir a depuração, desative a depuração remota.

Desativar a depuração remota

Depois de concluir a depuração remota do código, desative a depuração remota no portal do Azure. A depuração remota é desativada automaticamente após 48 horas, caso você esqueça.

1. Na página publicar perfil, vá para a seção Hospedagem . Selecione as reticências (...) e, em seguida, selecione Abrir no portal do Azure. O portal do Azure é aberto para o aplicativo de funções no qual seu projeto é implantado.

2. No aplicativo de funções, selecione Configurações> e vá para a guia Configurações gerais. Ao lado da depuração remota, selecione Desativar. Selecione Salvar e, em seguida, selecione Continuar.

Depois que o aplicativo de funções for reiniciado, você não poderá mais se conectar remotamente aos seus processos remotos. Você pode usar essa mesma guia no portal do Azure para ativar a depuração remota fora do Visual Studio.

Funções do monitor

A maneira recomendada de monitorar suas funções é integrando seu aplicativo de funções ao Application Insights. Você deve ativar essa integração ao criar seu aplicativo de funções durante a publicação do Visual Studio.

Se a integração não estiver configurada durante a publicação por algum motivo, você ainda deverá ativar a integração do Application Insights para seu aplicativo de funções no Azure.

Para obter mais informações sobre como usar o Application Insights para monitoramento, consulte Monitorar execuções no Azure Functions.

Conteúdo relacionado

• Desenvolver o Azure Functions localmente usando ferramentas principais