Compartilhar via

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

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

Importante

O IoT Edge 1.5 LTS é a versão com suporte. O IoT Edge 1.4 LTS chegou ao fim de sua vida útil em 12 de novembro de 2024. Se você estiver em uma versão anterior, confira Atualizar o IoT Edge.

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

  • Usar 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 do IoT Edge
  • Exibir 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 você ainda 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 o desenvolvimento de contêiner do Linux: desenvolver módulos do Azure IoT Edge usando o Visual Studio Code. Ao concluir, você tem os seguintes pré-requisitos disponíveis:

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

Criar um projeto de função

O Azure IoT Edge para Visual Studio Code fornece recursos de gerenciamento e modelos de código. Nesta seção, você usará o Visual Studio Code para criar uma solução do 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 seu computador de desenvolvimento.

  2. No Visual Studio Code, abra a paleta de comandos selecionando Exibir>Paleta de comandos.

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

    • Selecione uma pasta: escolha o local em seu computador de desenvolvimento para o Visual Studio Code criar os arquivos da solução.
    • Forneça um nome de solução: adicione um nome descritivo para a 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 o módulo CSharpFunction.
    • Forneça o repositório de imagem do Docker para o módulo. Um repositório de imagem inclui o nome do registro de contêiner e o nome da imagem de contêiner. Sua imagem de contêiner foi preenchida automaticamente na ú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 da página de Visão geral do seu registro de contêiner no portal do Azure. A cadeia de caracteres final se parece com <nome do registro>.azurecr.io/csharpfunction.

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

Adicionar suas credenciais de registro

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

A extensão do IoT Edge no Visual Studio Code tenta efetuar pull de suas credenciais de Registro de Contêiner do Azure e as popula no arquivo de ambiente. Verifique se suas credenciais já estão no arquivo. Caso contrário, adicione-as agora:

  1. No explorador do Visual Studio Code, abra o arquivo .env.
  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 o registro de contêiner no Azure e examine a página dechaves de acesso de >.
  3. Salve o arquivo.

Observação

Este tutorial usa as credenciais de logon do administrador do 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 com privilégios mínimos, como entidades de serviço. Para obter mais informações, confira Gerenciar o acesso ao registro de contêiner.

Defina a arquitetura de destino como AMD64

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

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

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

Atualizar o módulo com código personalizado

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

  1. No gerenciador do Visual Studio Code, 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 a temperatura ambiente e do computador e encaminha a mensagem para o Hub IoT somente se a temperatura do computador 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. Salve o arquivo.

Compilar sua solução do IoT Edge e efetuar push dela

Na seção anterior, você criou uma solução do IoT Edge e alterou o CSharpFunction para filtrar mensagens com temperaturas de computador relatadas abaixo do limite aceitável. Agora, crie a solução como uma imagem de contêiner e enviá-la por push para seu registro de contêiner.

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

  2. Faça login no Docker pelo terminal. Use o nome de usuário, a senha e o servidor de logon do registro de contêiner do Azure. Obtenha esses valores na seção Access keys do 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 de --password-stdin. Embora essa prática seja recomendada para cenários de produção, ela não serve para este tutorial. Para saber mais, confira a referência de logon do docker.

  3. No gerenciador do Visual Studio Code, clique com o botão direito do mouse no arquivo deployment.template.json e selecione Criar e efetuar push da solução IoT Edge.

    O comando de criação e de envio por push inicia três operações. Primeiro, ele cria uma nova pasta na solução chamada configuração que tem o manifesto de implantação completo, que é criado a partir do modelo de implantação e de outros arquivos de solução. Em segundo lugar, ele executa docker build para criar a imagem de contêiner com base no Dockerfile correto para sua arquitetura de destino. Por fim, ele executa docker push para enviar por push o repositório de imagens para seu registro de 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.

Exibir sua imagem de contêiner

O Visual Studio Code mostra uma mensagem de êxito quando sua imagem de contêiner é enviada para o registro de contêiner. Para confirmar a operação, visualize a imagem no registro.

  1. No portal do Azure, acesse o registro de contêiner do Azure.
  2. Selecione Repositóriosde>.
  3. Você verá o repositório csharpfunction na lista. Selecione este repositório para exibir mais detalhes.
  4. Na seção Marcas , você verá a marca 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 .

Implantar e executar a solução

Use o portal do Azure para implantar seu módulo de funções em um dispositivo do 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 do Azure IoT Edge e do Hub IoT para Visual Studio Code listadas nos pré-requisitos. Instale as extensões agora, se ainda não tiver feito isso.

  1. No explorador do Visual Studio Code, 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 dispositivo do IoT Edge e selecione Criar Implantação para Dispositivo Único.

  3. Vá para a pasta de solução que tem o CSharpFunction. Abra a pasta de configuração, escolha o arquivo deployment.amd64.json e escolha Selecionar Manifesto de Implantação do Edge.

  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 instantes 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 relata o status de volta ao Hub IoT.

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

Exibir os dados gerados

Você pode ver todas as mensagens que chegam em seu hub IoT de todos os seus dispositivos executando Hub IoT do Azure: Iniciar o Monitoramento do Ponto de Extremidade de Evento Interno na paleta de comandos. Para interromper o monitoramento de mensagens, execute o Azure IoT Hub: Stop Monitoring Built-in Event Endpoint 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 > IoT do Azure do explorador do Visual Studio Code e selecione Iniciar Monitoramento do Ponto de Extremidade de Evento Interno.

Limpar os recursos

Se você planeja continuar para o próximo artigo recomendado, mantenha os recursos e configurações criados e reutilize-os. Você também pode continuar usando 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 encargos.

Excluir recursos do Azure

A exclusão de recursos do Azure e dos grupos de recursos é irreversível. Não exclua acidentalmente grupo de recursos ou recursos incorretos. 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 excluir 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. Examine a lista de recursos que seu grupo de recursos contém. Se você deseja excluir todos eles, selecione Excluir grupo de recursos. Se quiser excluir apenas alguns, clique em cada recurso para excluí-los individualmente.

Próximas etapas

Neste tutorial, você criou um módulo de Função do Azure com o código para filtrar os dados brutos gerados pelo seu dispositivo do IoT Edge.

Siga para os próximos tutoriais para conhecer outras formas pelas quais o Azure IoT Edge pode ajudá-lo a transformar dados em informações de negócios na borda.

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

  • Last updated on