Desenvolver as Funções do Azure com o Visual Studio Code

A extensão do Azure Functions para Visual Studio Code permite desenvolver funções localmente e implantá-las no Azure. Se esta experiência for a sua primeira com o Azure Functions, pode saber mais em Uma introdução ao Azure Functions.

A extensão do Azure Functions fornece estes benefícios:

• Edite, crie e execute funções no seu computador de desenvolvimento local.
• Publique seu projeto do Azure Functions diretamente no Azure.
• Escreva suas funções em vários idiomas enquanto aproveita os benefícios do Visual Studio Code.

Pré-requisitos

• Visual Studio Code instalado em uma das plataformas suportadas.

• Extensão do Azure Functions. Você também pode instalar o pacote de extensão Ferramentas do Azure, que é recomendado para trabalhar com recursos do Azure.

• Uma subscrição ativa do Azure. Se você ainda não tiver uma conta, poderá criar uma a partir da extensão no Visual Studio Code.

Você também precisa desses pré-requisitos para executar e depurar suas funções localmente. Eles não precisam apenas criar ou publicar projetos no Azure Functions.

• As Ferramentas Principais do Azure Functions, que permitem uma experiência de depuração local integrada. Quando você tem a extensão do Azure Functions instalada, a maneira mais fácil de instalar ou atualizar as Ferramentas Principais é executando o Azure Functions: Install or Update Azure Functions Core Tools comando na paleta de comandos.

Criar um projeto das Funções do Azure

A extensão Functions permite que você crie o projeto de aplicativo de função necessário ao mesmo tempo em que cria sua primeira função. Use estas etapas para criar uma função acionada por HTTP em um novo projeto. Um gatilho HTTP é o modelo de gatilho de função mais simples de demonstrar.

1. No Visual Studio Code, pressione F1 para abrir a paleta de comandos e procure e execute o comando Azure Functions: Create New Project.... Selecione o local do diretório para o espaço de trabalho do projeto e escolha Selecionar.

   Você pode criar uma nova pasta ou escolher uma pasta vazia para o espaço de trabalho do projeto, mas não escolha uma pasta de projeto que já faça parte de um espaço de trabalho.

   Em vez disso, você pode executar o comando Azure Functions: Create New Containerized Project... para também obter um Dockerfile gerado para o projeto.

2. Quando solicitado, selecione um idioma para o seu projeto. Se necessário, escolha uma versão linguística específica.

3. Selecione o modelo de função de gatilho HTTP ou você pode selecionar Ignorar por enquanto para criar um projeto sem uma função. Você sempre pode adicionar uma função ao seu projeto mais tarde.

   Gorjeta

   Você pode exibir modelos adicionais selecionando a opção Alterar filtro de modelo e definindo o valor como Núcleo ou Todos.

4. Para o nome da função, digite HttpExample, selecione Enter e, em seguida, selecione Autorização da função .

   Esse nível de autorização requer que você forneça uma chave de função quando chamar o ponto de extremidade da função.

5. Na lista suspensa, selecione Adicionar ao espaço de trabalho.

6. Na janela Você confia nos autores dos arquivos nesta pasta?, selecione Sim.

O Visual Studio Code cria uma função no idioma escolhido e no modelo para uma função acionada por HTTP.

Arquivos de projeto gerados

O modelo de projeto cria um projeto no idioma escolhido e instala as dependências necessárias. Para qualquer idioma, o novo projeto tem estes arquivos:

• host.json: Permite configurar o host Functions. Essas configurações se aplicam quando você executa funções localmente e quando as executa no Azure. Para obter mais informações, consulte host.json referência.

• local.settings.json: Mantém as configurações usadas quando você executa funções localmente. Essas configurações são usadas somente quando você está executando funções localmente. Para obter mais informações, consulte Arquivo de configurações locais.

  Importante

  Como o arquivo local.settings.json pode conter segredos, certifique-se de excluir o arquivo do controle do código-fonte do projeto.

• Dockerfile (opcional): Permite criar um aplicativo de função em contêiner a partir do seu projeto usando uma imagem base aprovada para o seu projeto. Você só obtém esse arquivo quando executa o comando Azure Functions: Create New Containerized Project.... Você pode adicionar um Dockerfile a um projeto existente usando o func init --docker-only comando em Core Tools.

Dependendo do seu idioma, estes outros ficheiros são criados:

Neste ponto, você pode executar sua função de gatilho HTTP localmente.

Adicionar uma função ao seu projeto

Você pode adicionar uma nova função a um projeto existente com base em um dos modelos de gatilho Functions predefinidos. Para adicionar um novo gatilho de função, selecione F1 para abrir a paleta de comandos e, em seguida, localize e execute o comando Azure Functions: Create Function. Siga as instruções para escolher o tipo de gatilho e definir os atributos necessários do gatilho. Se o gatilho exigir uma chave de acesso ou cadeia de conexão para se conectar a um serviço, prepare esse item antes de criar o gatilho de função.

Ligar aos serviços

Você pode conectar sua função a outros serviços do Azure adicionando associações de entrada e saída. As ligações ligam a sua função a outros serviços sem que tenha de escrever o código de ligação.

{
    "type": "queue",
    "direction": "out",
    "name": "msg",
    "queueName": "outqueue",
    "connection": "MyStorageConnection"
}

{
    "type": "queue",
    "direction": "out",
    "name": "msg",
    "queueName": "outqueue",
    "connection": "MyStorageConnection"
}

{
    "type": "queue",
    "direction": "out",
    "name": "msg",
    "queueName": "outqueue",
    "connection": "MyStorageConnection"
}

O exemplo a seguir mostra a definição de função depois de adicionar uma ligação de saída de armazenamento de fila a uma função acionada por HTTP:

[Function("HttpExample")]
public static MultiResponse Run([HttpTrigger(AuthorizationLevel.Function, "get", "post")] HttpRequest req,
    FunctionContext executionContext)
{

public class MultiResponse
{
    [QueueOutput("outqueue",Connection = "AzureWebJobsStorage")]
    public string[] Messages { get; set; }
    public IActionResult HttpResponse { get; set; }
}

[FunctionName("HttpExample")]
public static async Task<IActionResult> Run(
    [HttpTrigger(AuthorizationLevel.Anonymous, "get", "post", Route = null)] HttpRequest req, 
    [Queue("outqueue"),StorageAccount("AzureWebJobsStorage")] ICollector<string> msg, 
    ILogger log)

@FunctionName("HttpExample")
public HttpResponseMessage run(
        @HttpTrigger(name = "req", methods = {HttpMethod.GET, HttpMethod.POST}, authLevel = AuthorizationLevel.ANONYMOUS) 
        HttpRequestMessage<Optional<String>> request, 
        @QueueOutput(name = "msg", queueName = "outqueue", 
        connection = "AzureWebJobsStorage") OutputBinding<String> msg, 
        final ExecutionContext context) {

{
  "bindings": [
    {
      "authLevel": "function",
      "type": "httpTrigger",
      "direction": "in",
      "name": "req",
      "methods": ["get", "post"]
    },
    {
      "type": "http",
      "direction": "out",
      "name": "res"
    },
    {
      "type": "queue",
      "direction": "out",
      "name": "msg",
      "queueName": "outqueue",
      "connection": "AzureWebJobsStorage"
    }
  ]
}

$outputMsg = $name
Push-OutputBinding -name msg -Value $outputMsg

@app.route(route="HttpExample")
@app.queue_output(arg_name="msg", queue_name="outqueue", connection="AzureWebJobsStorage")
def HttpExample(req: func.HttpRequest, msg: func.Out [func.QueueMessage]) -> func.HttpResponse:
    logging.info('Python HTTP trigger function processed a request.')

{
  "bindings": [
    {
      "authLevel": "function",
      "type": "httpTrigger",
      "direction": "in",
      "name": "req",
      "methods": ["get", "post"]
    },
    {
      "type": "http",
      "direction": "out",
      "name": "res"
    },
    {
      "type": "queue",
      "direction": "out",
      "name": "msg",
      "queueName": "outqueue",
      "connection": "AzureWebJobsStorage"
    }
  ]
}

{
  "bindings": [
    {
      "authLevel": "function",
      "type": "httpTrigger",
      "direction": "in",
      "name": "req",
      "methods": ["get", "post"]
    },
    {
      "type": "http",
      "direction": "out",
      "name": "res"
    },
    {
      "type": "queue",
      "direction": "out",
      "name": "msg",
      "queueName": "outqueue",
      "connection": "AzureWebJobsStorage"
    }
  ]
}

Iniciar sessão no Azure

Antes de criar recursos do Azure ou publicar seu aplicativo, você deve entrar no Azure.

1. Se ainda não tiver sessão iniciada, na barra de atividades, selecione o ícone do Azure. Em seguida, em Recursos, selecione Entrar no Azure.

   

   Se já tiver sessão iniciada e conseguir ver as suas subscrições existentes, vá para a secção seguinte. Se ainda não tiver uma conta do Azure, selecione Criar uma Conta do Azure. Os alunos podem selecionar Criar uma Conta do Azure para Estudantes.

2. Quando você for solicitado no navegador, selecione sua conta do Azure e entre usando suas credenciais de conta do Azure. Se criar uma nova conta, pode iniciar sessão depois de a sua conta ser criada.

3. Depois de iniciar sessão com êxito, pode fechar a nova janela do browser. As assinaturas que pertencem à sua conta do Azure são exibidas na barra lateral.

Criar recursos do Azure

Antes de publicar seu projeto do Functions no Azure, você deve ter um aplicativo de função e recursos relacionados em sua assinatura do Azure para executar seu código. A aplicação de funções proporciona um contexto de execução para as suas funções. Quando você publica do Visual Studio Code em um aplicativo de função no Azure, o projeto é empacotado e implantado no aplicativo de função selecionado em sua assinatura do Azure.

Ao criar um aplicativo de função no Azure, você pode escolher um caminho de criação de aplicativo de função rápida usando padrões ou um caminho que ofereça opções avançadas, como usar recursos existentes do Azure. Dessa forma, você tem mais controle sobre a criação dos recursos remotos.

Criar uma implantação de Aplicativos de Contêiner do Azure

Você usa o Visual Studio Code para criar recursos do Azure para um projeto de código em contêiner. Quando a extensão deteta a presença de um Dockerfile durante a criação de recursos, ela pergunta se você deseja implantar a imagem de contêiner em vez de apenas o código. O Visual Studio Code cria um ambiente de Aplicativos de Contêiner do Azure para seu projeto de código em contêiner integrado ao Azure Functions. Para obter mais informações, consulte Aplicativos de contêiner do Azure hospedando o Azure Functions.

O processo de criação depende se você escolhe uma criação rápida ou se precisa usar opções avançadas:

Para obter mais informações sobre os recursos necessários para executar suas funções em contêineres em Aplicativos de Contêiner, consulte Recursos necessários.

Implantar arquivos de projeto

Recomendamos configurar a implantação contínua para que seu aplicativo de função no Azure seja atualizado quando você atualizar os arquivos de origem no local de origem conectado. Você também pode implantar seus arquivos de projeto do Visual Studio Code. Quando você publica a partir do Visual Studio Code, você pode aproveitar a tecnologia de implantação Zip.

1. Na paleta de comandos, insira e selecione Azure Functions: Deploy to Function App.

2. Selecione o aplicativo de função que você acabou de criar. Quando solicitado sobre a substituição de implantações anteriores, selecione Implantar para implantar seu código de função no novo recurso de aplicativo de função.

3. Quando a implantação estiver concluída, selecione Exibir Saída para exibir os resultados da criação e da implantação, incluindo os recursos do Azure que você criou. Se você perder a notificação, selecione o ícone de sino no canto inferior direito para vê-lo novamente.

   

Obter a URL de uma função acionada por HTTP no Azure

Para chamar uma função acionada por HTTP de um cliente, você precisa da URL da função, que está disponível após a implantação em seu aplicativo de função. Este URL inclui todas as teclas de função necessárias. Você pode usar a extensão para obter essas URLs para suas funções implantadas. Se você quiser apenas executar a função remota no Azure, use a funcionalidade Executar função agora da extensão.

1. Selecione F1 para abrir a paleta de comandos e, em seguida, localize e execute o comando Azure Functions: Copiar URL da Função.

2. Siga os prompts para selecionar seu aplicativo de função no Azure e, em seguida, o gatilho HTTP específico que você deseja invocar.

O URL da função é copiado para a área de transferência, juntamente com todas as chaves necessárias passadas code pelo parâmetro de consulta. Use uma ferramenta HTTP para enviar solicitações POST ou um navegador para enviar solicitações GET para a função remota.

Quando a extensão obtém a URL de uma função no Azure, a extensão usa sua conta do Azure para recuperar automaticamente as chaves necessárias para iniciar a função. Saiba mais sobre as teclas de acesso de função. Iniciar funções acionadas não HTTP requer o uso da chave admin.

Executar funções

A extensão Azure Functions permite executar funções individuais. Você pode executar funções em seu projeto em seu computador de desenvolvimento local ou em sua assinatura do Azure.

Para funções de gatilho HTTP, a extensão chama o ponto de extremidade HTTP. Para outros tipos de gatilhos, a extensão chama APIs de administrador para iniciar a função. O corpo da mensagem da solicitação enviada para a função depende do tipo de gatilho. Quando um gatilho requer dados de teste, você é solicitado a inserir dados em um formato JSON específico.

Executar funções no Azure

Para executar uma função no Azure a partir do Visual Studio Code, siga estes passos:

1. Na paleta de comandos, insira Azure Functions: Execute function now e selecione sua assinatura do Azure.

2. Na lista, escolha seu aplicativo de função no Azure. Se não vir a sua aplicação funcional, certifique-se de que tem sessão iniciada na subscrição correta.

3. Na lista, escolha a função que deseja executar. Em Inserir corpo da solicitação, digite o corpo da mensagem da solicitação e pressione Enter para enviar essa mensagem de solicitação para sua função.

   O texto padrão em Enter request body indica o formato do corpo. Se o seu aplicativo de função não tiver funções, um erro de notificação será exibido com esse erro.

   Quando a função é executada no Azure e retorna uma resposta, o Visual Studio Code mostra uma notificação.

Também pode executar a sua função a partir da área Azure: Funções abrindo o menu de atalho para a função que pretende executar a partir da sua aplicação de função na sua subscrição do Azure e, em seguida, selecionando Executar Função Agora....

Quando você executa suas funções no Azure a partir do Visual Studio Code, a extensão usa sua conta do Azure para recuperar automaticamente as chaves necessárias para iniciar a função. Saiba mais sobre as teclas de acesso de função. Iniciar funções acionadas não HTTP requer o uso da chave admin.

Executar funções localmente

O tempo de execução local é o mesmo tempo de execução que hospeda seu aplicativo de função no Azure. As configurações locais são lidas a partir do arquivo local.settings.json. Para executar seu projeto do Functions localmente, você deve atender a mais requisitos.

Configurar o projeto para ser executado localmente

O tempo de execução do Functions usa uma conta de Armazenamento do Azure internamente para todos os tipos de gatilho diferentes de HTTP e webhooks. Portanto, você precisa definir a chave Values.AzureWebJobsStorage para uma cadeia de conexão válida da conta de Armazenamento do Azure.

Esta seção usa a extensão de Armazenamento do Azure para Visual Studio Code com o Gerenciador de Armazenamento do Azure para se conectar e recuperar a cadeia de conexão de armazenamento.

Para definir a cadeia de conexão da conta de armazenamento:

1. No Visual Studio, abra o Cloud Explorer, expanda Conta>de Armazenamento Sua Conta de Armazenamento e selecione Propriedades e copie o valor da Cadeia de Conexão Primária.

2. Em seu projeto, abra o arquivo de local.settings.json e defina o valor da chave AzureWebJobsStorage para a cadeia de conexão que você copiou.

3. Repita a etapa anterior para adicionar chaves exclusivas à matriz Values para quaisquer outras conexões exigidas por suas funções.

Para obter mais informações, consulte Arquivo de configurações locais.

Depurar funções localmente

Para depurar suas funções, selecione F5. Se as Ferramentas Principais não estiverem disponíveis, você será solicitado a instalá-las. Quando o Core Tools está instalado e em execução, a saída é mostrada no Terminal. Esta etapa é a mesma que executar o func start comando Core Tools a partir do Terminal, mas com tarefas de compilação extras e um depurador anexado.

Quando o projeto está em execução, você pode usar o recurso Executar Função Agora... da extensão para acionar suas funções como faria quando o projeto é implantado no Azure. Com o projeto em execução no modo de depuração, os pontos de interrupção são atingidos no Visual Studio Code como seria de esperar.

1. Na paleta de comandos, insira Azure Functions: Execute function now e escolha Local project.

2. Escolha a função que deseja executar em seu projeto e digite o corpo da mensagem da solicitação em Inserir corpo da solicitação. Prima Enter para enviar esta mensagem de pedido para a sua função. O texto padrão em Enter request body deve indicar o formato do corpo. Se o seu aplicativo de função não tiver funções, um erro de notificação será exibido com esse erro.

3. Quando a função é executada localmente e depois que a resposta é recebida, uma notificação é gerada no Visual Studio Code. As informações sobre a execução da função são mostradas no painel Terminal .

As chaves não são necessárias quando executadas localmente, o que se aplica às teclas de função e às teclas de nível de administrador.

Trabalhar com as configurações do aplicativo localmente

Quando executado em um aplicativo de função no Azure, as configurações exigidas por suas funções são armazenadas com segurança 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 local.

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

Por padrão, essas configurações não são migradas automaticamente quando o projeto é publicado no Azure. Após a conclusão da publicação, você terá a opção de publicar as configurações do local.settings.json para seu aplicativo de função no Azure. Para saber mais, consulte Publicar configurações do aplicativo.

Os valores em ConnectionStrings nunca são publicados.

Configurações do aplicativo no Azure

As configurações no arquivo local.settings.json em seu projeto devem ser as mesmas que as configurações do aplicativo no aplicativo de função no Azure. Todas as configurações adicionadas ao local.settings.json você também deve adicionar ao aplicativo de função no Azure. Essas configurações não são carregadas automaticamente quando você publica o projeto. Da mesma forma, todas as configurações que você criar em seu aplicativo de função no portal devem ser baixadas para seu projeto local.

Publicar configurações do aplicativo

A maneira mais fácil de publicar as configurações necessárias em seu aplicativo de função no Azure é usar o link Configurações de carregamento que aparece depois que você publica seu projeto:

Você também pode publicar configurações usando o comando Azure Functions: Carregar Configuração Local na paleta de comandos. Você pode adicionar configurações individuais às configurações do aplicativo no Azure usando o comando Azure Functions: Add New Setting .

Se o ficheiro local estiver encriptado, é desencriptado, publicado e encriptado novamente. Se houver configurações com valores conflitantes nos dois locais, você será solicitado a escolher como proceder.

Exiba as configurações existentes do aplicativo na área Azure: Funções expandindo sua assinatura, seu aplicativo de função e Configurações do Aplicativo.

Baixar configurações do Azure

Se você criou configurações de aplicativo no Azure, pode baixá-las em seu arquivo de local.settings.json usando o comando Azure Functions: Baixar Configurações Remotas .

Tal como acontece com o carregamento, se o ficheiro local estiver encriptado, é desencriptado, atualizado e encriptado novamente. Se houver configurações com valores conflitantes nos dois locais, você será solicitado a escolher como proceder.

Instalar as extensões de enlace

Exceto para gatilhos HTTP e timer, as ligações são implementadas em pacotes de extensão.

dotnet add package Microsoft.Azure.Functions.Worker.Extensions.<BINDING_TYPE_NAME> --version <TARGET_VERSION>

dotnet add package Microsoft.Azure.WebJobs.Extensions.<BINDING_TYPE_NAME> --version <TARGET_VERSION>

{
    "version": "2.0",
    "extensionBundle": {
        "id": "Microsoft.Azure.Functions.ExtensionBundle",
        "version": "[3.*, 4.0.0)"
    }
}

Funções de monitorização

Quando você executa funções localmente, os dados de log são transmitidos para o console do Terminal. Você também pode obter dados de log quando seu projeto do Functions estiver em execução em um aplicativo de função no Azure. Você pode se conectar a logs de streaming no Azure para ver dados de log quase em tempo real. Você deve habilitar o Application Insights para uma compreensão mais completa de como seu aplicativo de função está se comportando.

Application Insights

Você deve monitorar a execução de suas funções integrando seu aplicativo de função com o Application Insights. Quando você cria um aplicativo de função no portal do Azure, essa integração ocorre por padrão. Ao criar seu aplicativo de função durante a publicação do Visual Studio, você mesmo precisa integrar o Application Insights. Para saber como, consulte Habilitar a integração do Application Insights.

Para saber mais sobre o monitoramento usando o Application Insights, consulte Monitorar o Azure Functions.

Referência da paleta de comandos

A extensão do Azure Functions fornece uma interface gráfica útil na área para interagir com seus aplicativos de função no Azure. A mesma funcionalidade também está disponível como comandos na paleta de comandos (F1). Estes comandos do Azure Functions estão disponíveis:

Próximos passos

Para saber mais sobre as Ferramentas Principais do Azure Functions, consulte Trabalhar com as Ferramentas Principais do Azure Functions.

Para saber mais sobre como desenvolver funções como bibliotecas de classes .NET, consulte Referência do desenvolvedor do Azure Functions C#. Este artigo também fornece links para exemplos de como usar atributos para declarar os vários tipos de associações suportadas pelo Azure Functions.