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

Aplica-se a: IoT Edge 1.5 IoT Edge 1.4

Importante

O IoT Edge 1.5 LTS e o IoT Edge 1.4 LTS são versões com suporte. O IoT Edge 1.4 LTS chegará ao fim da vida útil em 12 de novembro de 2024. Se você estiver em uma versão anterior, confira Atualizar o IoT Edge.

Este artigo fornece instruções de ponta a ponta para registrar e provisionar um dispositivo do IoT Edge para Linux no Windows dispositivo.

Cada dispositivo que se conecta a um hub IoT tem uma identidade do dispositivo que é usada para controlar as comunicações da nuvem para dispositivo ou do dispositivo para nuvem. Você configura um dispositivo com suas informações de conexão, o que inclui o nome do host do hub IoT, a identidade 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, no qual você conecta um único dispositivo ao seu hub IoT. No provisionamento manual, você tem duas opções para autenticar dispositivos do IoT Edge:

• Chaves simétricas: quando você cria uma identidade do dispositivo no Hub IoT, o serviço cria duas chaves. Você coloca uma das chaves no dispositivo e apresenta a chave para o Hub IoT durante a autenticação.

  Esse método de autenticação é mais rápido para começar a usar, 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 do dispositivo no Hub IoT, você fornece impressões digitais de ambos os certificados. Quando o dispositivo é autenticado 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 seu método de autenticação. Se você quiser usar certificados X.509, consulte Criar e provisionar um IoT Edge para Linux em um dispositivo Windows usando certificados X.509.

Observação

Se você tiver muitos dispositivos a serem configurados e não quiser provisionar manualmente cada um deles, use um dos artigos a seguir para saber como IoT Edge funciona com o Serviço de Provisionamento de Dispositivos no Hub IoT:

• Criar e provisionar dispositivos de Azure IoT Edge em escala usando certificados X.509
• Criar e provisionar dispositivos do IoT Edge em escala com um TPM
• Criar e provisionar dispositivos de Azure IoT Edge em escala usando chaves simétricas

Pré-requisitos

Este artigo aborda o registro do dispositivo do 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 que você tenha todos os pré-requisitos listados antes de continuar.

Ferramentas de gerenciamento de dispositivo

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

Portal

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

Visual Studio Code

• Um hub IoT gratuito ou padrão na assinatura do Azure
• Visual Studio Code
• Extensão do Azure IoT Edge. A extensão das Ferramentas de Azure IoT Edge para Visual Studio Code está em modo de manutenção.
• Extensão do Hub IoT do Azure

CLI do Azure

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

• CLI do Azure em seu ambiente

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

Requisitos do dispositivo

Um dispositivo Windows com os seguintes requisitos mínimos:

• Requisitos do Sistema

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

• Requisitos de hardware

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

• Suporte à virtualização

  • No Windows 10, habilite o Hyper-V. Para obter mais informações, confira 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 mais informações, confira 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, confira: virtualização aninhada.

• Suporte à rede

  • O não Windows Server vem com um comutador padrão. Para implantar o EFLOW em um dispositivo Windows Server, crie um comutador virtual. Para obter mais informações, confira Criar um comutador virtual para Linux no Windows.
  • As versões do Windows Desktop vêm com um comutador padrão que pode ser usado para a instalação do EFLOW. Se necessário, você pode criar o seu comutador virtual personalizado.

Dica

Se você quer usar os módulos do Linux acelerados por GPU na 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 precisará de acesso a um build do Programa Windows Insider. Para determinar suas necessidades de configuração e atender a esses pré-requisitos, confira Aceleração de GPU do Azure IoT Edge para Linux no Windows.

Reserve tempo para atender aos pré-requisitos de aceleração de GPU agora. Será necessário reiniciar o processo de instalação se você decidir que deseja a aceleração de GPU durante a instalação.

Ferramentas para desenvolvedores

Prepare o dispositivo de destino para a instalação do Azure IoT Edge para Linux no Windows e a implantação da máquina virtual do 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 local machine não for AllSigned, você poderá definir a política de execução usando:

   Set-ExecutionPolicy -ExecutionPolicy AllSigned -Force
   

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

Registre seu dispositivo

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

Portal

No hub IoT do portal do Azure, os dispositivos do IoT Edge são criados e gerenciados separadamente dos dispositivos de IoT que não são habilitados para a borda.

1. Entre no Portal do Azure e navegue até o Hub IoT.

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

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

   • Crie um ID de dispositivo descritivo, por exemplo my-edge-device-1 (tudo em letras minúsculas). Copie este ID do dispositivo, pois você o usará mais tarde.
   • Marque a caixa de seleção Dispositivo do 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 Salvar.

Você deverá ver seu novo dispositivo listado em seu hub IoT.

Visual Studio Code

Entrar no Azure

É possível usar as extensões do Azure IoT para Visual Studio Code para executar operações com o Hub IoT. Certifique-se de ter instalado os pré-requisitos da extensão Azure IoT.

Uma vez instaladas as extensões Azure IoT Edge e Hub IoT do Azure, nota-se que um ícone Azure é adicionado ao menu de ícones esquerdo. Você pode entrar em sua conta do Azure por meio do Visual Studio Code selecionando o ícone do Azure e, em seguida, selecionando Entrar no Azure.

Registrar um novo dispositivo com o Visual Studio Code

Registar um novo dispositivo é semelhante a criar um dispositivo IoT Edge no portal do Microsoft Azure. Esse 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 cabeçalho da seção Hub IoT do Azure. Se você não vir as reticências, selecione ou passe o mouse sobre o cabeçalho.
3. Selecione Criar dispositivo IoT Edge.
4. Na caixa de texto que é aberta, forneça um ID ao seu dispositivo, por exemplo my-edge-device-1 (tudo em letras minúsculas) e pressione 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 pode ser usado para conectar seu dispositivo físico ao Hub IoT do Azure. 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 Hub IoT do Azure>Dispositivos do menu Explorer.

Observação

Se o seu dispositivo não estiver listado, escolha o seu Hub IoT a partir do link Selecionar Hub IoT fornecido em Hub IoT do Azure e depois siga as instruções. Os prompts solicitarão que você escolha primeiro sua assinatura e depois seu Hub IoT. Esse processo permite que o Visual Studio Code conheça seu Hub IoT (e todos os dispositivos nele contidos). Atualize o Visual Studio Code e seu dispositivo deverá aparecer.

CLI do Azure

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

Este comando inclui três parâmetros:

• --device-id ou -d: fornece um nome descritivo exclusivo no hub IoT.

• --hub-name ou -n: fornece o nome do hub IoT.

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

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

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

Agora que tem um dispositivo registado no Hub IoT do Azure, pode recuperar informações de provisionamento utilizadas para concluir a instalação e o provisionamento do runtime do IoT Edge no próximo passo.

Exibir dispositivos registrados e recuperar informações de provisionamento

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

Portal

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

Quando estiver pronto para configurar o dispositivo, você precisará da cadeia de conexão que vincula o dispositivo físico à identidade no hub IoT. As cadeias de conexão dos dispositivos que se autenticam com chaves simétricas estã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 da Cadeia de conexão primária ou Cadeia de conexão secundária. Qualquer tecla funciona.

Visual Studio Code

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

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

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

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

   A cadeia de conexão é copiada à sua área de transferência.

Você também pode selecionar Pegar Informação do Dispositivo do menu de botão direito 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 no seu Hub IoT do Azure, utilize o comando az iot hub device-identity list. Substitua hub_name_here pelo seu próprio nome de Hub IoT do Azure.

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

Qualquer dispositivo registrado como um dispositivo do 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 seu dispositivo.

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 do Azure. Utilize o seguinte comando az iot hub device-identity connection-string show para devolver a cadeia de ligação para um único dispositivo. Substitua [device_id] e [hub_name] pelos seus próprios valores. O valor para o parâmetro device-identity diferencia maiúsculas de minúsculas.

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

Você deverá ver a saída JSON no console, semelhante a essa:

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

Dica

O comando connection-string show foi introduzido na versão 0.9.8 da extensão do Azure IoT, substituindo o comando show-connection-string preterido. Se você receber uma mensagem de 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 últimas atualizações, consulte Extensão do Microsoft Azure IoT para a CLI do Azure.

Ao copiar a cadeia de conexão a ser usada em um dispositivo, não inclua aspas na cadeia de conexão.

Instalar o Edge IoT

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

Observação

O processo do PowerShell a seguir descreve como implantar o IoT Edge para Linux no Windows no dispositivo local. Para fazer a implantação em um dispositivo de destino remoto usando o PowerShell, use o PowerShell Remoto para estabelecer uma conexão com um dispositivo remoto e executar esses comandos remotamente no dispositivo.

1. Em uma sessão elevada do PowerShell, execute um dos comandos a seguir, 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 em 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 no Linux e no Windows e do VHDX adicionando os parâmetros INSTALLDIR="<FULLY_QUALIFIED_PATH>" e VHDXDIR="<FULLY_QUALIFIED_PATH>" ao comando de instalação. Por exemplo, se você quiser usar a pasta D:\EFLOW para instalação e a pasta 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 definida. Confira 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 do Linux e instala o runtime do IoT Edge para você.

   Deploy-Eflow
   

   Dica

   Por padrão, o comando Deploy-Eflow cria a 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 necessários para a VM são dependem muito das cargas de trabalho implantadas. Se a VM não tiver memória suficiente para dar suporte às cargas de trabalho, ela não será iniciada.

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

   Por exemplo, o comando abaixo cria uma máquina virtual com 1 núcleo vCPU, 1 GB de RAM (representados 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, confira Funções do PowerShell para o IoT Edge para Linux no Windows.

   Aviso

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

   Você pode atribuir uma GPU à implantação para habilitar os módulos do Linux acelerados por GPU. Para obter acesso a esses recursos, você precisará instalar os pré-requisitos detalhados em Aceleração de GPU do 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, confira Funções do PowerShell para o 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, confira Implantar dispositivos gráficos usando a atribuição discreta de dispositivo.

5. Insira "Y" para aceitar os termos de licença.

6. Insira "O" ou "R" para ativar ou desativar Dados de diagnóstico opcionais, dependendo de sua preferência.

7. Depois que a implantação for concluída, a janela do PowerShell relatará Implantação bem-sucedida.

   

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

Provisionar o dispositivo com a identidade de nuvem dele

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

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

Execute o comando a seguir em uma sessão do PowerShell com privilégios elevados no dispositivo de destino. Substitua o texto do espaço reservado pelos seus valores.

Provision-EflowVm -provisioningType ManualConnectionString -devConnString "PASTE_DEVICE_CONNECTION_STRING_HERE"

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

Verificar configuração bem-sucedida

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

1. Faça logon em sua máquina virtual IoT Edge para Linux no Windows usando o seguinte comando em sua sessão do PowerShell:

   Connect-EflowVm
   

   Observação

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

2. Depois de fazer logon, você poderá 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 de serviço do IoT Edge, use os comandos do Linux a seguir.

   1. Recupere os logs do serviço.

      sudo iotedge system logs
      

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

      sudo iotedge check
      

   Observação

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

   × preparação para produção: o diretório de armazenamento do Hub do Edge é persistente no sistema de arquivos do host – erro

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

   Esse erro é esperado em um dispositivo recém-provisionado, pois o módulo do Hub do IoT Edge 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 Hub do IoT Edge.

Quando você cria um novo dispositivo IoT Edge, ele exibe o código de status 417 -- The device's deployment configuration is not set no portal do Azure. Esse status é normal e significa que o dispositivo está pronto para receber uma implantação do 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 dispositivo, use os comandos a seguir.

1. Abra as Configurações no Windows
2. Selecione Adicionar ou remover programas
3. Selecione o aplicativo Azure IoT Edge
4. Selecionar Desinstalar

Próximas etapas

• Prossiga para implantar módulos do IoT Edge para saber como implantar módulos em seu dispositivo.
• Saiba como gerenciar certificados em sua máquina virtual do 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 comunicar por meio de um servidor proxy.