Criar e provisionar um IoT Edge para Linux em dispositivo Windows usando chaves simétricas

Aplica-se a: IoT Edge 1.5 IoT Edge 1.4

Importante

IoT Edge 1.5 LTS e IoT Edge 1.4 LTS são versões suportadas. O IoT Edge 1.4 LTS termina a vida útil em 12 de novembro de 2024. Se tiver uma versão anterior, consulte Atualizar IoT Edge.

Este artigo fornece instruções completas para registrar e provisionar um IoT Edge para Linux no dispositivo Windows.

Cada dispositivo que se conecta a um hub IoT tem um ID de dispositivo que é usado para rastrear comunicações de nuvem para dispositivo ou de dispositivo para nuvem. Você configura um dispositivo com suas informações de conexão, que incluem o nome do host do hub IoT, o ID do dispositivo e as informações que o dispositivo usa para autenticar no Hub IoT.

As etapas neste artigo percorrem um processo chamado provisionamento manual, em que você conecta um único dispositivo ao seu hub IoT. Para provisionamento manual, você tem duas opções para autenticar dispositivos IoT Edge:

• Chaves simétricas: quando você cria uma nova identidade de dispositivo no Hub IoT, o serviço cria duas chaves. Você coloca uma das chaves no dispositivo e ela apresenta a chave para o Hub IoT ao autenticar.

  Este método de autenticação é mais rápido para começar, mas não tão seguro.

• X.509 autoassinado: você cria dois certificados de identidade X.509 e os coloca no dispositivo. Ao criar uma nova identidade de dispositivo no Hub IoT, você fornece impressões digitais de ambos os certificados. Quando o dispositivo se autentica no Hub IoT, ele apresenta um certificado e o Hub IoT verifica se o certificado corresponde à sua impressão digital.

  Esse método de autenticação é mais seguro e recomendado para cenários de produção.

Este artigo aborda o uso de chaves simétricas como método de autenticação. Se você quiser usar certificados X.509, consulte Criar e provisionar um IoT Edge para Linux em dispositivos Windows usando certificados X.509.

Nota

Se você tiver muitos dispositivos para configurar e não quiser provisionar manualmente cada um, use um dos seguintes artigos para saber como o IoT Edge funciona com o serviço de provisionamento de dispositivos do Hub IoT:

• Crie e provisione dispositivos IoT Edge em escala usando certificados X.509
• Crie e provisione dispositivos IoT Edge em escala com um TPM
• Crie e provisione dispositivos IoT Edge em escala usando chaves simétricas

Pré-requisitos

Este artigo aborda o registro do dispositivo IoT Edge e a instalação do IoT Edge para Linux no Windows. Essas tarefas têm diferentes pré-requisitos e utilitários usados para realizá-las. Certifique-se de ter todos os pré-requisitos cobertos antes de prosseguir.

Ferramentas de gestão de dispositivos

Você pode usar o portal do Azure, o Visual Studio Code ou a CLI do Azure para as etapas de registro do dispositivo. Cada utilitário tem seus próprios pré-requisitos ou pode precisar ser instalado:

Portal

Um hub IoT gratuito ou padrão em sua assinatura do Azure.

Visual Studio Code

• Um hub IoT gratuito ou padrão em sua assinatura do Azure
• Visual Studio Code
• Extensão do Azure IoT Edge . A extensão de código das ferramentas do Azure IoT Edge para Visual Studio está no modo de manutenção.
• Extensão do Hub IoT do Azure

CLI do Azure

• Um hub IoT gratuito ou padrão em sua assinatura do Azure

• CLI do Azure em seu ambiente

  No mínimo, sua versão da CLI do Azure deve ser 2.0.70 ou mais recente. Utilize az --version para validar. Esta versão suporta az comandos de extensão e introduz a estrutura de comandos Knack.

Requisitos do dispositivo

Um dispositivo Windows com os seguintes requisitos mínimos:

• Requisitos de Sistema

  • Windows 10¹/11 (Pro, Enterprise, IoT Enterprise)
  • Windows Server 2019¹/2022
    _{1 Windows 10 e Windows Server 2019 compilação mínima 17763 com todas as atualizações cumulativas atuais instaladas.}

• Requisitos de Hardware

  • Memória livre mínima: 1 GB
  • Espaço livre mínimo em disco: 10 GB

• Suporte à virtualização

  • No Windows 10, habilite o Hyper-V. Para obter mais informações, consulte Instalar o Hyper-V no Windows 10.
  • No Windows Server, instale a função Hyper-V e crie um comutador de rede padrão. Para obter mais informações, consulte Virtualização aninhada para Azure IoT Edge para Linux no Windows.
  • Em uma máquina virtual, configure a virtualização aninhada. Para obter mais informações, consulte Virtualização aninhada.

• Suporte em rede

  • O Windows Server não vem com uma opção padrão. Antes de implantar o EFLOW em um dispositivo Windows Server, você precisa criar um comutador virtual. Para obter mais informações, consulte Criar comutador virtual para Linux no Windows.
  • As versões da área de trabalho do Windows vêm com uma opção padrão que pode ser usada para a instalação do EFLOW. Se necessário, você pode criar seu próprio comutador virtual personalizado.

Gorjeta

Se você quiser usar módulos Linux acelerados por GPU em sua implantação do Azure IoT Edge para Linux no Windows, há várias opções de configuração a serem consideradas.

Você precisará instalar os drivers corretos, dependendo da arquitetura da GPU, e talvez precise acessar uma compilação do Programa Windows Insider. Para determinar suas necessidades de configuração e satisfazer esses pré-requisitos, consulte Aceleração de GPU para Azure IoT Edge para Linux no Windows.

Certifique-se de dedicar um tempo para satisfazer os pré-requisitos para a aceleração da GPU agora. Você precisará reiniciar o processo de instalação se decidir que deseja a aceleração da GPU durante a instalação.

Ferramentas de programação

Prepare seu dispositivo de destino para a instalação do Azure IoT Edge para Linux no Windows e a implantação da máquina virtual Linux:

1. Defina a política de execução no dispositivo de destino como AllSigned. Você pode verificar a política de execução atual em um prompt do PowerShell com privilégios elevados usando o seguinte comando:

   Get-ExecutionPolicy -List
   

   Se a política de execução do não AllSignedfor , você poderá definir a política de local machine execução usando:

   Set-ExecutionPolicy -ExecutionPolicy AllSigned -Force
   

Para obter mais informações sobre o módulo Azure IoT Edge para Linux no Windows PowerShell, consulte a referência de funções do PowerShell.

Registar o seu dispositivo

Você pode usar o portal do Azure, o Visual Studio Code ou a CLI do Azure para registrar seu dispositivo, dependendo de sua preferência.

Portal

Em seu hub IoT no portal do Azure, os dispositivos IoT Edge são criados e gerenciados separadamente dos dispositivos IoT que não estão habilitados para borda.

1. Entre no portal do Azure e navegue até seu hub IoT.

2. No painel esquerdo, selecione Dispositivos no menu e, em seguida, selecione Adicionar dispositivo.

3. Na página Criar um dispositivo, forneça as seguintes informações:

   • Crie uma ID de dispositivo descritiva, por exemplo my-edge-device-1 (todas minúsculas). Copie este ID do dispositivo, pois você o usará mais tarde.
   • Marque a caixa de seleção Dispositivo IoT Edge.
   • Selecione Chave simétrica como o tipo de autenticação.
   • Use as configurações padrão para gerar automaticamente chaves de autenticação, que conectam o novo dispositivo ao seu hub.

4. Selecione Guardar.

Você deve ver seu novo dispositivo listado em seu hub IoT.

Visual Studio Code

Iniciar sessão no Azure

Você pode usar as extensões do Azure IoT para Visual Studio Code para executar operações com seu hub IoT. Certifique-se de ter instalado os pré-requisitos da extensão do Azure IoT.

Depois que as extensões do Azure IoT Edge e do Hub IoT do Azure são instaladas, você percebe que um ícone do Azure é adicionado ao menu de ícones à esquerda. Pode iniciar sessão na sua conta do Azure através do Visual Studio Code selecionando o ícone do Azure e, em seguida, selecione Iniciar sessão no Azure.

Registrar um novo dispositivo com o Visual Studio Code

Registrar um novo dispositivo é semelhante a criar um dispositivo IoT Edge no portal do Azure. Este dispositivo virtual é um dos gêmeos, enquanto o dispositivo do mundo real é o outro gêmeo. O Visual Studio Code pode configurar isso para você por meio das etapas a seguir.

1. No menu Visual Studio Code Explorer, expanda a seção Hub IoT do Azure.
2. Selecione no ... no cabeçalho da seção Hub IoT do Azure. Se não vir as reticências, selecione ou passe o cursor sobre o cabeçalho.
3. Selecione Criar dispositivo IoT Edge.
4. Na caixa de texto que se abre, forneça um ID ao seu dispositivo, por exemplo my-edge-device-1 (todas em minúsculas) e, em seguida, prima enter.

No console de saída do Visual Studio Code, você vê o resultado do comando: uma impressão JSON. As informações do dispositivo incluem o deviceId que você forneceu e gera um connectionString que você pode usar para conectar seu dispositivo físico ao seu hub IoT. O console de saída também mostra suas chaves e outras informações de identificação do dispositivo.

Agora você pode ver seu dispositivo listado na seção Dispositivos do Hub>IoT do Azure do menu Explorer.

Nota

Se o seu dispositivo não estiver listado, talvez seja necessário escolher seu Hub IoT no link Selecionar Hub IoT fornecido no Hub IoT do Azure e seguir as instruções. Os prompts solicitarão que você escolha sua assinatura primeiro e, em seguida, seu Hub IoT. Esse processo permite que o Visual Studio Code saiba sobre seu Hub IoT (e todos os dispositivos nele). Atualize o código do Visual Studio e seu dispositivo deve ser exibido.

CLI do Azure

Use o comando az iot hub device-identity create para criar uma nova identidade de dispositivo em seu hub IoT. Substitua device_id_here pelo seu próprio ID de dispositivo novo e exclusivo, por exemplo my-edge-device-1 (todas em minúsculas). Substitua hub_name_here pelo seu hub IoT existente.

Este comando inclui três parâmetros:

• --device-id ou -d: Forneça um nome descritivo exclusivo dentro do seu hub IoT.

• --hub-name ou -n: Forneça o nome do seu hub IoT.

• --edge-enabled ou --ee: Declare que o dispositivo é um dispositivo IoT Edge.

  az iot hub device-identity create --device-id device_id_here --hub-name hub_name_here --edge-enabled
  

Se sua CLI diz O comando requer a extensão azure-iot. Deseja instalá-lo agora?, em seguida, digite Y e pressione Enter para iniciar o download para criar seu dispositivo.

Agora que você tem um dispositivo registrado no Hub IoT, pode recuperar as informações de provisionamento usadas para concluir a instalação e o provisionamento do tempo de execução do IoT Edge na próxima etapa.

Exibir dispositivos registrados e recuperar informações de provisionamento

Os dispositivos que usam autenticação de chave simétrica precisam de suas cadeias de conexão para concluir a instalação e o provisionamento do tempo de execução do IoT Edge. A cadeia de conexão é gerada para seu dispositivo IoT Edge quando você cria o dispositivo. Para Visual Studio Code e CLI do Azure, a cadeia de conexão está na saída JSON. Se você usar o portal do Azure para criar seu dispositivo, poderá encontrar a cadeia de conexão do próprio dispositivo. Quando você seleciona seu dispositivo no hub IoT, ele é listado como Primary connection string na página do dispositivo.

Portal

Os dispositivos habilitados para borda que se conectam ao seu hub IoT estão listados na página Dispositivos do seu hub IoT. Se você tiver vários dispositivos, poderá filtrar a lista selecionando o tipo Dispositivos Iot Edge e, em seguida, selecionando Aplicar.

Quando estiver pronto para configurar seu dispositivo, você precisará da cadeia de conexão que vincula seu dispositivo físico à sua identidade no hub IoT. Os dispositivos que se autenticam com chaves simétricas têm suas cadeias de conexão disponíveis para cópia no portal. Para encontrar sua cadeia de conexão no portal:

1. Na página Dispositivos, selecione o ID do dispositivo IoT Edge na lista.
2. Copie o valor de Cadeia de Conexão Primária ou Cadeia de Conexão Secundária. Qualquer uma das chaves funciona.

Visual Studio Code

Todos os dispositivos que se conectam ao seu hub IoT estão listados na seção Hub IoT do Visual Studio Code Explorer. Os dispositivos IoT Edge são distinguíveis dos dispositivos que não são Edge porque têm um ícone diferente e você vê os módulos $edgeAgent e $edgeHub são implantados em cada dispositivo IoT Edge.

Quando estiver pronto para configurar seu dispositivo, você precisará da cadeia de conexão que vincula seu dispositivo físico à sua identidade no hub IoT. Veja como obter sua cadeia de conexão do Visual Studio Code.

1. Clique com o botão direito do mouse na ID (nome) do seu dispositivo na seção Hub IoT do Azure.

2. Selecione Copiar cadeia de conexão do dispositivo.

   A cadeia de conexão é copiada para a área de transferência.

Você também pode selecionar Obter informações do dispositivo no menu do botão direito do mouse para ver todas as informações do dispositivo, incluindo a cadeia de conexão, na janela de saída.

CLI do Azure

Para ver todos os dispositivos em seu hub IoT, use o comando az iot hub device-identity list . Substitua hub_name_here pelo seu próprio nome de hub IoT.

az iot hub device-identity list --hub-name hub_name_here

Qualquer dispositivo registrado como um dispositivo IoT Edge tem a propriedade capabilities.iotEdge definida como true. Você também vê muitos outros metadados como saída JSON, incluindo os IDs do dispositivo.

Quando estiver pronto para configurar seu dispositivo, você precisará de sua cadeia de conexão que vincule seu dispositivo físico com sua identidade no hub IoT. Use o seguinte comando az iot hub device-identity connection-string show para retornar a cadeia de conexão de um único dispositivo. Substitua [device_id] e [hub_name] com os seus próprios valores. O valor do parâmetro diferencia maiúsculas device-identity de minúsculas.

az iot hub device-identity connection-string show --device-id [device_id] --hub-name [hub_name]

Você deve ver a saída JSON no console, semelhante à seguinte:

{
  "connectionString": "HostName=[hub_name].azure-devices.net;DeviceId=[device_id];SharedAccessKey=[device_key]"
}

Gorjeta

O connection-string show comando foi introduzido na versão 0.9.8 da extensão do Azure IoT, substituindo o comando preterido show-connection-string . Se você receber um erro ao executar esse comando, verifique se a versão da extensão está atualizada para 0.9.8 ou posterior. Para obter mais informações e as atualizações mais recentes, consulte Extensão do Microsoft Azure IoT para CLI do Azure.

Ao copiar a cadeia de conexão para usar em um dispositivo, não inclua as aspas ao redor da cadeia de conexão.

Instalar o IoT Edge

Implante o Azure IoT Edge para Linux no Windows em seu dispositivo de destino.

Nota

O processo PowerShell a seguir descreve como implantar o IoT Edge para Linux no Windows no dispositivo local. Para implantar em um dispositivo de destino remoto usando o PowerShell, você pode usar o PowerShell Remoto para estabelecer uma conexão com um dispositivo remoto e executar esses comandos remotamente nesse dispositivo.

1. Em uma sessão do PowerShell com privilégios elevados, execute um dos seguintes comandos, dependendo da arquitetura do dispositivo de destino, para baixar o IoT Edge para Linux no Windows.

   • X64/AMD64

     $msiPath = $([io.Path]::Combine($env:TEMP, 'AzureIoTEdge.msi'))
     $ProgressPreference = 'SilentlyContinue'
     Invoke-WebRequest "https://aka.ms/AzEFLOWMSI_1_4_LTS_X64" -OutFile $msiPath
     

   • ARM64

     $msiPath = $([io.Path]::Combine($env:TEMP, 'AzureIoTEdge.msi'))
     $ProgressPreference = 'SilentlyContinue'
     Invoke-WebRequest "https://aka.ms/AzEFLOWMSI_1_4_LTS_ARM64" -OutFile $msiPath
     

2. Instale o IoT Edge para Linux no Windows no seu dispositivo.

   Start-Process -Wait msiexec -ArgumentList "/i","$([io.Path]::Combine($env:TEMP, 'AzureIoTEdge.msi'))","/qn"
   

   Você pode especificar diretórios personalizados de instalação do IoT Edge para Linux no Windows e VHDX adicionando INSTALLDIR="<FULLY_QUALIFIED_PATH>" parâmetros e VHDXDIR="<FULLY_QUALIFIED_PATH>" ao comando install. Por exemplo, se você quiser usar a pasta D:\EFLOW para instalação e D :\EFLOW-VHDX para o VHDX, poderá usar o seguinte cmdlet do PowerShell.

   Start-Process -Wait msiexec -ArgumentList "/i","$([io.Path]::Combine($env:TEMP, 'AzureIoTEdge.msi'))","/qn","INSTALLDIR=D:\EFLOW", "VHDXDIR=D:\EFLOW-VHDX"
   

3. Defina a política de execução no dispositivo de destino como AllSigned se ainda não estiver. Consulte os pré-requisitos do PowerShell para comandos para verificar a política de execução atual e definir a política de execução como AllSigned.

4. Crie a implantação do IoT Edge para Linux no Windows. A implantação cria sua máquina virtual Linux e instala o tempo de execução do IoT Edge para você.

   Deploy-Eflow
   

   Gorjeta

   Por padrão, o Deploy-Eflow comando cria sua máquina virtual Linux com 1 GB de RAM, 1 núcleo vCPU e 16 GB de espaço em disco. No entanto, os recursos de que sua VM precisa dependem muito das cargas de trabalho implantadas. Se sua VM não tiver memória suficiente para suportar suas cargas de trabalho, ela não será iniciada.

   Você pode personalizar os recursos disponíveis da máquina virtual usando os Deploy-Eflow parâmetros opcionais do comando. Isso é necessário para implantar o EFLOW em um dispositivo com os requisitos mínimos de hardware.

   Por exemplo, o comando a seguir cria uma máquina virtual com 1 núcleo de vCPU, 1 GB de RAM (representado em MB) e 2 GB de espaço em disco:

   Deploy-Eflow -cpuCount 1 -memoryInMB 1024 -vmDataSize 2
   

   Para obter informações sobre todos os parâmetros opcionais disponíveis, consulte Funções do PowerShell para IoT Edge para Linux no Windows.

   Aviso

   Por padrão, a máquina virtual EFLOW Linux não tem configuração de DNS. As implantações usando DHCP tentarão obter a configuração DNS propagada pelo servidor DHCP. Verifique a configuração do DNS para garantir a conectividade com a Internet. Para obter mais informações, consulte AzEFLOW-DNS.

   Você pode atribuir uma GPU à sua implantação para habilitar módulos Linux acelerados por GPU. Para obter acesso a esses recursos, você precisa instalar os pré-requisitos detalhados em Aceleração de GPU para o Azure IoT Edge para Linux no Windows.

   Para usar uma passagem de GPU, adicione os parâmetros gpuName, gpuPassthroughType e gpuCount ao comando Deploy-Eflow . Para obter informações sobre todos os parâmetros opcionais disponíveis, consulte Funções do PowerShell para IoT Edge para Linux no Windows.

   Aviso

   Habilitar a passagem de dispositivo de hardware pode aumentar os riscos de segurança. A Microsoft recomenda um driver de mitigação de dispositivo do fornecedor da GPU, quando aplicável. Para obter mais informações, consulte Implantar dispositivos gráficos usando atribuição de dispositivo discreto.

5. Digite 'Y' para aceitar os termos da licença.

6. Digite 'O' ou 'R' para ativar ou desativar os dados de diagnóstico opcionais, dependendo da sua preferência.

7. Quando a implantação estiver concluída, a janela do PowerShell relatará a implantação bem-sucedida.

   

   Após uma implantação bem-sucedida, você estará pronto para provisionar seu dispositivo.

Provisionar o dispositivo com sua identidade na nuvem

Você está pronto para configurar seu dispositivo com sua identidade na nuvem e informações de autenticação.

Para provisionar seu dispositivo usando chaves simétricas, você precisa da cadeia de conexão do dispositivo.

Execute o seguinte comando em uma sessão elevada do PowerShell no dispositivo de destino. Substitua o texto do espaço reservado pelos seus próprios valores.

Provision-EflowVm -provisioningType ManualConnectionString -devConnString "PASTE_DEVICE_CONNECTION_STRING_HERE"

Para obter mais informações sobre o Provision-EflowVM comando, consulte Funções do PowerShell para IoT Edge para Linux no Windows.

Verificar a configuração bem-sucedida

Verifique se o IoT Edge para Linux no Windows foi instalado e configurado com êxito no seu dispositivo IoT Edge.

1. Entre no IoT Edge para Linux na máquina virtual Windows usando o seguinte comando em sua sessão do PowerShell:

   Connect-EflowVm
   

   Nota

   A única conta permitida para SSH para a máquina virtual é o usuário que a criou.

2. Depois de fazer login, você pode verificar a lista de módulos do IoT Edge em execução usando o seguinte comando do Linux:

   sudo iotedge list
   

3. Se você precisar solucionar problemas do serviço IoT Edge, use os seguintes comandos do Linux.

   1. Recupere os logs de serviço.

      sudo iotedge system logs
      

   2. Use a ferramenta para verificar a configuração e o check status da conexão do dispositivo.

      sudo iotedge check
      

   Nota

   Em um dispositivo recém-provisionado, você pode ver um erro relacionado ao IoT Edge Hub:

   × prontidão para produção: o diretório de armazenamento do Edge Hub é mantido no sistema de arquivos host - Erro

   Não foi possível verificar o estado atual do contêiner edgeHub

   Esse erro é esperado em um dispositivo recém-provisionado porque o módulo IoT Edge Hub não está em execução. Para resolver o erro, no Hub IoT, defina os módulos para o dispositivo e crie uma implantação. A criação de uma implantação para o dispositivo inicia os módulos no dispositivo, incluindo o módulo IoT Edge Hub.

Quando você cria um novo dispositivo IoT Edge, ele exibe o código 417 -- The device's deployment configuration is not set de status no portal do Azure. Esse status é normal e significa que o dispositivo está pronto para receber uma implantação de módulo.

Desinstalar o IoT Edge para Linux no Windows

Se você quiser remover a instalação do Azure IoT Edge para Linux no Windows do seu dispositivo, use os comandos a seguir.

1. Abrir Definições no Windows
2. Selecione Adicionar ou remover programas
3. Selecione o aplicativo Azure IoT Edge
4. Selecione Desinstalar

Próximos passos

• Continue a implantar módulos do IoT Edge para saber como implantar módulos em seu dispositivo.
• Saiba como gerenciar certificados em sua máquina virtual IoT Edge para Linux no Windows e transferir arquivos do sistema operacional host para sua máquina virtual Linux.
• Saiba como configurar seus dispositivos IoT Edge para se comunicarem por meio de um servidor proxy.