Partilhar via

Tutorial: Implantar o Azure Functions como módulos do IoT Edge

Aplica-se a:Marca de verificação IoT Edge 1.5 IoT Edge 1.5

Importante

O IoT Edge 1.5 LTS é a versão suportada. O IoT Edge 1.4 LTS está em fim de vida útil a partir de 12 de novembro de 2024. Se você estiver em uma versão anterior, consulte Atualizar o IoT Edge.

Use o Azure Functions para implantar código que executa sua lógica de negócios diretamente em seus dispositivos Azure IoT Edge. Este tutorial mostra como criar e implantar uma Função do Azure que filtra dados do sensor em um dispositivo IoT Edge simulado. Use o dispositivo IoT Edge simulado que você criou nos inícios rápidos. Neste tutorial, irá aprender a:

  • Utilize o Visual Studio Code para criar uma função do Azure
  • Usar o Visual Studio Code e o Docker para criar uma imagem do Docker e publicá-la em um registro de contêiner
  • Implantar o módulo do registro de contêiner em seu dispositivo IoT Edge
  • Ver dados filtrados

Diagrama que mostra a arquitetura da função, incluindo como preparar e implantar um módulo de função.

A Função do Azure que você cria neste tutorial filtra os dados de temperatura gerados pelo seu dispositivo. A função só envia mensagens upstream para o Hub IoT do Azure quando a temperatura está acima de um limite especificado.

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

Pré-requisitos

Antes de iniciar este tutorial, siga o tutorial para configurar seu ambiente de desenvolvimento para desenvolvimento de contêineres Linux: Desenvolver módulos do Azure IoT Edge usando o Visual Studio Code. Quando terminar, você terá os seguintes pré-requisitos em vigor:

Para desenvolver um módulo IoT Edge com o Azure Functions, instale estes pré-requisitos adicionais em sua máquina de desenvolvimento:

Criar um projeto de função

O Azure IoT Edge para Visual Studio Code oferece recursos de gerenciamento e modelos de código. Nesta seção, você usa o Visual Studio Code para criar uma solução IoT Edge com uma Função do Azure.

Criar um novo projeto

Siga estas etapas para criar um modelo de solução de função C# personalizável.

  1. Abra o Visual Studio Code no computador de desenvolvimento.

  2. Abra a Paleta de Comandos do Visual Studio Code selecionando Exibir>Paleta de Comandos.

  3. Na paleta de comandos, adicione e execute o comando Azure IoT Edge: Nova solução IoT Edge. Siga estes prompts na paleta de comandos para criar sua solução:

    • Selecione uma pasta: escolha o local em sua máquina de desenvolvimento para o Visual Studio Code para criar os arquivos de solução.
    • Forneça um nome de solução: adicione um nome descritivo para sua solução, como FunctionSolution, ou aceite o padrão.|
    • Selecione um modelo de módulo: escolha Azure Functions - C#.
    • Forneça um nome de módulo | Nomeie seu módulo CSharpFunction.
    • Forneça um repositório de imagens do Docker para o módulo. Os repositórios de imagens incluem o nome do seu registo de contentor e o nome da sua imagem de contentor. Sua imagem de contêiner é pré-preenchida a partir da última etapa. Substitua localhost:5000 pelo valor do servidor de Logon do seu registro de contêiner do Azure. Você pode recuperar o servidor de Logon na página Visão geral do seu registro de contêiner no portal do Azure. A cadeia final é semelhante a <nome do registo>.azurecr.io/csharpfunction.

    Captura de tela mostrando onde adicionar o nome do repositório de imagens do Docker no Visual Studio Code.

Adicionar as credenciais do registo

O arquivo de ambiente em sua solução armazena as credenciais para seu registro de contêiner e as compartilha com o tempo de execução do IoT Edge. O tempo de execução precisa dessas credenciais para extrair suas imagens privadas para o dispositivo IoT Edge.

A extensão IoT Edge no Visual Studio Code tenta extrair suas credenciais de registro de contêiner do Azure e preenchê-las no arquivo de ambiente. Verifique se as suas credenciais já estão no ficheiro. Se não, adicione-os agora:

  1. No explorador de código do Visual Studio, abra o .env arquivo.
  2. Atualize os campos com os valores de nome de usuário e senha copiados do Registro de contêiner do Azure. Para encontrá-los novamente, vá para seu registro de contêiner no Azure e procure na página Configurações>de chaves de acesso .
  3. Guarde este ficheiro.

Nota

Este tutorial usa credenciais de logon de administrador para o Registro de Contêiner do Azure, que são convenientes para cenários de desenvolvimento e teste. Para produção, use uma opção de autenticação de privilégios mínimos, como entidades de serviço. Para obter mais informações, consulte Gerenciar o acesso ao registro de contêiner.

Definir arquitetura de destino como AMD64

Os módulos do Azure Functions no IoT Edge são suportados apenas em contêineres baseados em Linux AMD64. A arquitetura de destino padrão para o Visual Studio Code é Linux AMD64, mas você a define explicitamente como Linux AMD64 aqui.

  1. Abra a paleta de comandos e procure Azure IoT Edge: Definir Plataforma Alvo Padrão para Solução Edge.

  2. Na paleta de comandos, selecione a arquitetura de destino AMD64 na lista de opções.

Atualizar o módulo com o código personalizado

Adicione algum código para que seu módulo CSharpFunction processe mensagens na borda antes de encaminhá-las para o Hub IoT.

  1. No explorador de código do Visual Studio, abra os módulos>CSharpFunction>CSharpFunction.cs.

  2. Substitua o conteúdo do arquivo CSharpFunction.cs pelo código a seguir. Esse código recebe telemetria sobre temperatura ambiente e da máquina e encaminha a mensagem para o Hub IoT somente se a temperatura da máquina estiver acima de um limite definido.

    using System;
using System.Collections.Generic;
using System.IO;
using System.Text;
using System.Threading.Tasks;
using Microsoft.Azure.Devices.Client;
using Microsoft.Azure.WebJobs;
using Microsoft.Azure.WebJobs.Extensions.EdgeHub;
using Microsoft.Azure.WebJobs.Host;
using Microsoft.Extensions.Logging;
using Newtonsoft.Json;

namespace Functions.Samples
{
    public static class CSharpFunction
    {
        [FunctionName("CSharpFunction")]
        public static async Task FilterMessageAndSendMessage(
            [EdgeHubTrigger("input1")] Message messageReceived,
            [EdgeHub(OutputName = "output1")] IAsyncCollector<Message> output,
            ILogger logger)
        {
            const int temperatureThreshold = 20;
            byte[] messageBytes = messageReceived.GetBytes();
            var messageString = System.Text.Encoding.UTF8.GetString(messageBytes);

            if (!string.IsNullOrEmpty(messageString))
            {
                logger.LogInformation("Info: Received one non-empty message");
                // Get the body of the message and deserialize it.
                var messageBody = JsonConvert.DeserializeObject<MessageBody>(messageString);

                if (messageBody != null && messageBody.machine.temperature > temperatureThreshold)
                {
                    // Send the message to the output as the temperature value is greater than the threshold.
                    using (var filteredMessage = new Message(messageBytes))
                    {
                         // Copy the properties of the original message into the new Message object.
                         foreach (KeyValuePair<string, string> prop in messageReceived.Properties)
                         {filteredMessage.Properties.Add(prop.Key, prop.Value);}
                         // Add a new property to the message to indicate it is an alert.
                         filteredMessage.Properties.Add("MessageType", "Alert");
                         // Send the message.
                         await output.AddAsync(filteredMessage);
                         logger.LogInformation("Info: Received and transferred a message with temperature above the threshold");
                    }
                }
            }
        }
    }
    //Define the expected schema for the body of incoming messages.
    class MessageBody
    {
        public Machine machine {get; set;}
        public Ambient ambient {get; set;}
        public string timeCreated {get; set;}
    }
    class Machine
    {
        public double temperature {get; set;}
        public double pressure {get; set;}
    }
    class Ambient
    {
        public double temperature {get; set;}
        public int humidity {get; set;}
    }
}

  3. Guarde o ficheiro.

Crie e envie sua solução IoT Edge

Na seção anterior, você criou uma solução IoT Edge e alterou o CSharpFunction para filtrar mensagens com temperaturas de máquina relatadas abaixo do limite aceitável. Agora, crie a solução como uma imagem de contentor e envie-a para o seu registo de contentores.

  1. Abra o terminal integrado do Visual Studio Code. Selecione Visualizar>Terminal.

  2. Faça login no Docker no terminal. Use o nome de usuário, a senha e o servidor de logon do seu registro de contêiner do Azure. Obtenha esses valores na seção Chaves de acesso do seu registro no portal do Azure.

    docker login -u <ACR username> -p <ACR password> <ACR login server>

    Você pode receber um aviso de segurança recomendando o uso do --password-stdin. Embora essa prática recomendada seja recomendada para cenários de produção, ela está fora do escopo deste tutorial. Para obter mais informações, consulte a referência docker login.

  3. No explorador de códigos do Visual Studio, clique com o botão direito do mouse no arquivo dedeployment.template.json e selecione Criar e Enviar Solução IoT Edge.

    O comando build e push inicia três operações. Primeiro, ele cria uma nova pasta na solução chamada config que tem o manifesto de implantação completo, que é criado a partir do modelo de implantação e outros arquivos de solução. Em segundo lugar, ele é executado docker build para criar a imagem do contêiner com base no Dockerfile apropriado para sua arquitetura de destino. Em seguida, ele é executado docker push para enviar o repositório de imagens para o registro do contêiner.

    Esse processo pode levar vários minutos na primeira vez, mas é mais rápido na próxima vez que você executar os comandos.

Ver a imagem de contentor

O Visual Studio Code mostra uma mensagem de sucesso quando a imagem do container é transferida para o registo do container. Para confirmar a operação, visualize a imagem no registro.

  1. No portal do Azure, vá para o registro do contêiner do Azure.
  2. Selecione Serviços>Repositórios.
  3. Você vê o repositório csharpfunction na lista. Selecione este repositório para ver mais detalhes.
  4. Na seção Tags , você verá a tag 0.0.1-amd64 . Esta tag mostra a versão e a plataforma da imagem que você criou. Esses valores são definidos no arquivo module.json na pasta CSharpFunction .

Implementar e executar a solução

Use o portal do Azure para implantar seu módulo de função em um dispositivo IoT Edge como no início rápido. Você também pode implantar e monitorar módulos do Visual Studio Code. As seções a seguir usam as extensões Azure IoT Edge e IoT Hub for Visual Studio Code listadas nos pré-requisitos. Instale as extensões agora, se ainda não o fez.

  1. No explorador de códigos do Visual Studio, na seção Hub IoT do Azure , expanda Dispositivos para ver a lista de dispositivos IoT.

  2. Clique com o botão direito do mouse no nome do seu dispositivo IoT Edge e selecione Criar implantação para um único dispositivo.

  3. Vá para a pasta de solução que tem o CSharpFunction. Abra a pasta config, selecione o arquivo dedeployment.amd64.json e escolha Select Edge Deployment Manifest.

  4. No dispositivo, expanda Módulos para ver uma lista de módulos implantados e em execução. Selecione o botão Atualizar. Você pode ver o novo CSharpFunction em execução junto com o módulo SimulatedTemperatureSensor , $edgeAgent e $edgeHub.

    Pode levar alguns momentos para que os novos módulos apareçam. O dispositivo IoT Edge recupera suas novas informações de implantação do Hub IoT, inicia os novos contêineres e, em seguida, relata o status de volta para o Hub IoT.

    Captura de tela mostrando como exibir módulos implantados no Visual Studio Code.

Ver os dados gerados

Veja todas as mensagens que chegam ao seu hub IoT a partir dos seus dispositivos executando o Hub IoT do Azure: Comece a Monitorizar o Ponto de Extremidade de Eventos Incorporado na paleta de comandos. Para parar a monitorização de mensagens, execute Azure IoT Hub: Parar a monitorização do ponto de extremidade de evento interno na paleta de comandos.

Para filtrar a exibição e ver mensagens de um dispositivo específico, clique com o botão direito do mouse no dispositivo na seção Dispositivos do > no explorador do Visual Studio Code e selecione Iniciar a monitorização do ponto de extremidade de eventos incorporado.

Clean up resources (Limpar recursos)

Se você planeja continuar para o próximo artigo recomendado, mantenha os recursos e configurações criados e reutilize-os. Também pode continuar a utilizar o mesmo dispositivo IoT Edge como um dispositivo de teste.

Caso contrário, exclua as configurações locais e os recursos do Azure criados neste artigo para evitar cobranças.

Eliminar recursos do Azure

A eliminação de recursos e grupos de recursos do Azure é irreversível. Confirme que não elimina acidentalmente o grupo de recursos ou recursos errados. Se você criou o Hub IoT dentro de um grupo de recursos existente que tem recursos que deseja manter, exclua apenas o recurso do Hub IoT em si, não o grupo de recursos.

Para eliminar os recursos:

  1. Entre no portal do Azure e selecione Grupos de recursos.
  2. Selecione o nome do grupo de recursos que contém os recursos de teste do IoT Edge.
  3. Reveja a lista de recursos que o seu grupo de recursos contém. Se quiser excluir todos eles, selecione Excluir grupo de recursos. Se você quiser excluir apenas alguns deles, você pode selecionar cada recurso para excluí-los individualmente.

Próximos passos

Neste tutorial, você criou um módulo Azure Function com código para filtrar dados brutos gerados pelo seu dispositivo IoT Edge.

Continue para os próximos tutoriais para saber mais sobre outras formas em que o Azure IoT Edge o pode ajudar a transformar os dados em informações empresariais na periferia.

Localizar médias usando uma janela flutuante no Azure Stream Analytics

  • Last updated on