Criar e excluir rotas e pontos de extremidade usando o Azure PowerShell
Este artigo mostra como criar uma rota e um ponto de extremidade no Hub IoT do Azure e, em seguida, como exclui-los. Saiba como usar o Azure PowerShell para criar rotas e pontos de extremidade para Hubs de Eventos do Azure, filas e tópicos do Barramento de Serviço do Azure e Armazenamento do Azure.
Para saber mais sobre como funciona o encaminhamento no Hub IoT, confira Usar encaminhamento de mensagens do Hub IoT para enviar mensagens do dispositivo para a nuvem para diferentes pontos de extremidade. Para explicar a configuração de uma rota que envia mensagens para armazenar e testar em um dispositivo simulado, confira Tutorial: enviar dados do dispositivo para o Armazenamento do Azure usando o roteamento de mensagens do Hub IoT.
Observação
Atualmente, o PowerShell não dá suporte a tipos de autenticação de identidade gerenciada para criar pontos de extremidade. Se você não puder usar a autenticação SAS em seu cenário, use uma das outras ferramentas de gerenciamento para criar pontos de extremidade.
Além disso, o PowerShell atualmente não dá suporte à criação de pontos de extremidade do Cosmos DB.
Pré-requisitos
Examine os pré-requisitos deste artigo com base no tipo de ponto de extremidade para o qual você deseja rotear as mensagens.
Uma assinatura do Azure. Caso você não tenha uma assinatura do Azure, crie uma conta gratuita do Azure antes de começar.
Um hub IoT. Caso você não tenha um hub, siga as etapas para Criar um hub IoT.
Azure PowerShell. Para usar o Azure PowerShell localmente, instale o módulo do Azure PowerShell em seu computador. Como alternativa, para usar o Azure PowerShell em um navegador da Web, habilite o Azure Cloud Shell.
Um recurso dos Hubs de Eventos (com contêiner). Se você precisar criar um novo recurso dos Hubs de Eventos, confira Início Rápido: criar um hub de eventos.
(Recomendado) Uma identidade gerenciada com permissões de controle de acesso baseado em função para o namespace dos Hubs de Eventos. Para obter mais informações, confira Autenticar uma identidade gerenciada com o Microsoft Entra ID para acessar os recursos dos Hubs de Eventos.
Criar pontos de extremidade
No Hub IoT, você pode criar uma rota para enviar mensagens ou capturar eventos. Cada rota tem uma fonte de dados e um ponto de extremidade. A fonte de dados é a origem das mensagens ou dos logs de eventos. O ponto de extremidade é o destino das mensagens ou dos logs de eventos. Você escolhe locais para a fonte de dados e o ponto de extremidade ao criar uma nova rota no Hub IoT. Em seguida, use consultas de roteamento para filtrar mensagens ou eventos, antes delas irem para o ponto de extremidade.
O serviço que você usa para criar seu ponto de extremidade deve existir primeiro em sua conta do Azure.
Observação
Se você usar uma versão local do Azure PowerShell, entre no Azure PowerShell antes de começar.
Os comandos nos procedimentos a seguir usam estas referências:
Obter a cadeia de conexão primária do hub de eventos. Copie a cadeia de conexão para usar mais tarde.
Get-AzEventHubKey -ResourceGroupName MyResourceGroup -NamespaceName MyNamespace -EventHubName MyEventHub -Name MyAuthRule
Crie um novo ponto de extremidade do Hub IoT para os Hubs de Eventos. Use a cadeia de conexão primária da etapa anterior. O valor para
EndpointType
deve serEventHub
. Para todos os outros parâmetros, use os valores para seu cenário.Add-AzIotHubRoutingEndpoint -ResourceGroupName MyResourceGroup -Name MyIotHub -EndpointName MyEndpoint -EndpointType EventHub -EndpointResourceGroup MyResourceGroup -EndpointSubscriptionId xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx -ConnectionString "Endpoint=<my connection string>"
Para ver todas as opções de ponto de extremidade de encaminhamento, confira Add-AzIotHubRoutingEndpoint.
Criar uma rota do Hub IoT
Com o novo ponto de extremidade no hub IoT, você pode criar uma nova rota.
A rota de fallback padrão no Hub IoT coleta mensagens de DeviceMessages
. Escolha uma opção diferente para sua rota personalizada, como DeviceConnectionStateEvents
. Para obter mais informações sobre opções de origem, confira Add-AzIotHubRoute. O parâmetro Enabled
é uma opção, portanto, você não precisa usar um valor com o parâmetro.
Add-AzIotHubRoute -ResourceGroupName MyResourceGroup -Name MyIotHub -RouteName MyRoute -Source DeviceLifecycleEvents -EndpointName MyEndpoint -Enabled
O PowerShell exibe uma confirmação semelhante a este exemplo:
RouteName : MyIotHub
DataSource : DeviceLifecycleEvents
EndpointNames : MyEndpoint
Condition : true
IsEnabled : True
Atualizar uma rota do Hub IoT
Para fazer alterações em uma rota existente, use o comando a seguir. Por exemplo, tente alterar o nome da rota usando o comando.
Set-AzIotHubRoute -ResourceGroupName MyResourceGroup -Name MyIotHub -RouteName MyRoute
Use o comando Get-AzIotHubRoute
para confirmar a alteração na rota:
Get-AzIotHubRoute -ResourceGroupName MyResourceGroup -Name MyIotHub
Excluir um ponto de extremidade
Para excluir um ponto de extremidade:
Remove-AzIotHubRoutingEndpoint -ResourceGroupName MyResourceGroup -Name MyIotHub -EndpointName MyEndpoint -PassThru
Excluir uma rota do Hub IoT
Para excluir uma rota do Hub IoT:
Remove-AzIotHubRoute -ResourceGroupName MyResourceGroup -Name MyIotHub -RouteName MyRoute -PassThru
Dica
Excluir uma rota não exclui nenhum ponto de extremidade na conta do Azure. Você deve excluir um ponto de extremidade separadamente da exclusão de uma rota.
Próximas etapas
Neste artigo de instruções, você aprendeu como criar uma rota e um ponto de extremidade para Hubs de Eventos, filas ou tópicos do Barramento de Serviço e Armazenamento do Azure.
Para saber mais sobre o roteamento de mensagens, confira Tutorial: enviar dados do dispositivo para o armazenamento do Azure usando o roteamento de mensagens do Hub IoT. No tutorial, você cria uma rota de armazenamento e a testa com um dispositivo no hub IoT.