Créer et supprimer des itinéraires et des points de terminaison à l’aide de Azure PowerShell

Cet article vous montre comment créer un itinéraire et un point de terminaison dans votre hub IoT, puis supprimer votre itinéraire et votre point de terminaison. Découvrez comment utiliser Azure PowerShell pour créer des itinéraires et des points de terminaison pour Azure Event Hubs, des files d’attente et des rubriques Azure Service Bus, et stockage Azure.

Pour en savoir plus sur le fonctionnement du routage dans IoT Hub, consultez Utiliser le routage des messages IoT Hub pour envoyer des messages appareil-à-cloud à différents points de terminaison. Pour vous guider dans la configuration d’un itinéraire qui envoie des messages au stockage et le test sur un appareil simulé, consultez Tutoriel : Envoyer des données d’appareil à stockage Azure à l’aide du routage des messages IoT Hub.

Remarque

Actuellement, PowerShell ne prend pas en charge les types d’authentification d’identité managée pour la création de points de terminaison. Si vous ne pouvez pas utiliser l’authentification par signature d’accès partagé (SAP) dans votre scénario, utilisez un des autres outils de gestion pour créer des points de terminaison.

En outre, PowerShell ne prend actuellement pas en charge la création de points de terminaison Cosmos DB.

Prérequis

Passez en revue les prérequis pour cet article en fonction du type de point de terminaison vers lequel vous voulez router les messages.

Hubs d'événements

• Un abonnement Azure. Si vous n’avez pas d’abonnement Azure, créez un compte Azure gratuit avant de commencer.

• Un hub IoT. Si vous n’avez pas encore de hub, vous pouvez suivre les étapes pour créer un hub IoT.

• Azure PowerShell. Pour utiliser Azure PowerShell localement, installez le module Azure PowerShell sur votre ordinateur. Vous pouvez également utiliser Azure PowerShell dans un navigateur en activant Azure Cloud Shell.

• Une ressource Event Hubs (avec conteneur). Si vous devez créer une ressource Event Hubs, consultez Démarrage rapide : Créer un Event Hub.

• (Recommandé) Une identité managée avec des autorisations de contrôle d’accès en fonction du rôle pour l’espace de noms Event Hubs. Pour plus d’informations, consultez Authentifier une identité managée avec Microsoft Entra ID pour accéder à des ressources Event Hubs.

File d’attente Service Bus

• Un abonnement Azure. Si vous n’avez pas d’abonnement Azure, créez un compte Azure gratuit avant de commencer.

• Un hub IoT. Si vous n’avez pas encore de hub, vous pouvez suivre les étapes pour créer un hub IoT.

• Azure PowerShell. Pour utiliser Azure PowerShell localement, installez le module Azure PowerShell sur votre ordinateur. Vous pouvez également utiliser Azure PowerShell dans un navigateur en activant Azure Cloud Shell.

• Une ressource de file d’attente Service Bus. Si vous devez créer une file d’attente Service Bus, consultez Démarrage rapide : Créer un espace de noms et une file d’attente Service Bus .

• (Recommandé) Une identité managée avec des autorisations de contrôle d’accès en fonction du rôle pour l’espace de noms et la file d’attente Service Bus. Pour plus d’informations, consultez Authentifier une identité managée avec Microsoft Entra ID pour accéder à des ressources Azure Service Bus.

Rubrique Service Bus

• Un abonnement Azure. Si vous n’avez pas d’abonnement Azure, créez un compte Azure gratuit avant de commencer.

• Un hub IoT. Si vous n’avez pas encore de hub, vous pouvez suivre les étapes pour créer un hub IoT.

• Azure PowerShell. Pour utiliser Azure PowerShell localement, installez le module Azure PowerShell sur votre ordinateur. Vous pouvez également utiliser Azure PowerShell dans un navigateur en activant Azure Cloud Shell.

• Une ressource de rubrique Service Bus. Si vous devez créer une rubrique Service Bus, consultez Démarrage rapide : Créer un espace de noms Service Bus avec rubrique et abonnement à l’aide d’un modèle Resource Manager.

• (Recommandé) Une identité managée avec des autorisations de contrôle d’accès en fonction du rôle pour l’espace de noms ou la rubrique Service Bus. Pour plus d’informations, consultez Authentifier une identité managée avec Microsoft Entra ID pour accéder à des ressources Azure Service Bus.

Stockage Azure

• Un abonnement Azure. Si vous n’avez pas d’abonnement Azure, créez un compte Azure gratuit avant de commencer.

• Un hub IoT. Si vous n’avez pas encore de hub, vous pouvez suivre les étapes pour créer un hub IoT.

• Azure PowerShell. Pour utiliser Azure PowerShell localement, installez le module Azure PowerShell sur votre ordinateur. Vous pouvez également utiliser Azure PowerShell dans un navigateur en activant Azure Cloud Shell.

• Une ressource de stockage Azure. Si vous devez créer un compte de stockage Azure, consultez Créer un compte de stockage.

• (Recommandé) Une identité managée avec des autorisations de contrôle d’accès en fonction du rôle pour le compte de stockage. Pour plus d’informations, consultez Attribuer un rôle Azure pour l’accès aux données d’objet blob.

Créer des points de terminaison

Dans IoT Hub, vous pouvez créer un itinéraire pour envoyer des messages ou capturer des événements. Chaque itinéraire a une source de données et un point de terminaison. La source de données est l’origine des messages ou des journaux des événements. Le point de terminaison est l’endroit où se terminent les messages ou les journaux d’événements. Vous choisissez des emplacements pour la source de données et le point de terminaison lorsque vous créez un itinéraire dans votre hub IoT. Ensuite, vous utilisez les requêtes de routage pour filtrer les messages ou les événements avant qu’ils accèdent au point de terminaison.

Le service que vous utilisez pour créer votre point de terminaison doit d’abord exister dans votre compte Azure.

Notes

Si vous utilisez une version locale de Azure PowerShell, connectez-vous à Azure PowerShell avant de commencer.

Hubs d'événements

Les commandes des procédures suivantes utilisent ces références :

• Az.IotHub
• Az.EventHub

1. Obtenez la chaîne de connexion principale à partir de votre Event Hub. Copiez la chaîne de connexion à utiliser plus tard.

   Get-AzEventHubKey -ResourceGroupName MyResourceGroup -NamespaceName MyNamespace -EventHubName MyEventHub -Name MyAuthRule
   

2. Créez un nouveau point de terminaison IoT Hub pour Event Hubs. Utilisez votre chaîne de connexion principale de l’étape précédente. La valeur de EndpointType doit être EventHub. Pour tous les autres paramètres, utilisez les valeurs de votre scénario.

   Add-AzIotHubRoutingEndpoint -ResourceGroupName MyResourceGroup -Name MyIotHub -EndpointName MyEndpoint -EndpointType EventHub -EndpointResourceGroup MyResourceGroup -EndpointSubscriptionId xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx -ConnectionString "Endpoint=<my connection string>"
   

   Pour afficher toutes les options de point de terminaison de routage, consultez Add-AzIotHubRoutingEndpoint.

File d’attente Service Bus

Les commandes des procédures suivantes utilisent ces références :

• Az.IotHub
• Az.ServiceBus

Pour créer un point de terminaison de file d’attente Service Bus :

1. Récupérez la chaîne de connexion principale depuis votre espace de noms Service Bus. Copiez la chaîne de connexion à utiliser plus tard.

   Get-AzServiceBusKey -ResourceGroupName MyResourceGroup -Namespace MyNamespace -Name RootManageSharedAccessKey
   

2. Créez un nouveau point de terminaison IoT Hub dans votre file d’attente Service Bus. Utilisez votre chaîne de connexion principale de l’étape précédente en ajoutant ;EntityPath=MyServiceBusQueue à la fin. La valeur de EndpointType doit être ServiceBusQueue. Pour tous les autres paramètres, utilisez les valeurs de votre scénario. Pour EndpointName, utilisez une valeur unique.

   Add-AzIotHubRoutingEndpoint -ResourceGroupName MyResourceGroup -Name MyIotHub -EndpointName MyEndpoint -EndpointType EventHub -EndpointResourceGroup MyResourceGroup -EndpointSubscriptionId xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx -ConnectionString "Endpoint=my-connection-string;EntityPath=MyServiceBusQueue"
   

   Pour obtenir la liste de toutes les options de point de terminaison de routage, consultez Add-AzIotHubRoutingEndpoint.

Rubrique Service Bus

Les commandes des procédures suivantes utilisent ces références :

• Az.IotHub
• Az.ServiceBus

1. Récupérez la chaîne de connexion principale depuis votre espace de noms Service Bus. Copiez la chaîne de connexion à utiliser plus tard.

   Get-AzServiceBusKey -ResourceGroupName MyResourceGroup -Namespace MyNamespace -Name RootManageSharedAccessKey
   

2. Créez un nouveau point de terminaison IoT Hub dans votre rubrique Service Bus. Utilisez votre chaîne de connexion principale de l’étape précédente en ajoutant ;EntityPath=MyServiceBusTopic à la fin. La valeur de EndpointType doit être ServiceBusTopic. Pour tous les autres paramètres, utilisez les valeurs de votre scénario. Pour EndpointName, utilisez une valeur unique.

   Add-AzIotHubRoutingEndpoint -ResourceGroupName MyResourceGroup -Name MyIotHub -EndpointName MyEndpoint -EndpointType ServiceBusTopic -EndpointResourceGroup MyResourceGroup -EndpointSubscriptionId xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx -ConnectionString "Endpoint=<my connection string>;EntityPath=MyServiceBusTopic"
   

   Pour obtenir la liste de toutes les options de point de terminaison de routage, consultez Add-AzIotHubRoutingEndpoint.

Stockage Azure

Les commandes des procédures suivantes utilisent ces références :

• Az.IotHub
• Az.Storage

Pour créer un point de terminaison dans Stockage Azure, vous avez besoin de votre clé d’accès pour construire une chaîne de connexion. La chaîne de connexion fait alors partie de la commande IoT Hub pour créer un point de terminaison.

1. Récupérez votre clé d’accès à partir de votre compte de stockage et copiez-la.

   Get-AzStorageAccountKey -ResourceGroupName MyResourceGroup -Name mystorageaccount
   

2. Construisez une chaîne de connexion primaire pour votre compte de stockage en vous basant sur le modèle suivant. Remplacez mystorageaccount (à deux endroits) par le nom de votre compte de stockage. Remplacez mykey par la clé obtenue à l’étape précédente.

   "DefaultEndpointsProtocol=https;BlobEndpoint=https://mystorageaccount.blob.core.windows.net;AccountName=mystorageaccount;AccountKey=mykey"
   

   Cette chaîne de connexion est requise dans l’étape de création du point de terminaison.

3. Créez votre point de terminaison Stockage Azure avec la chaîne de connexion que vous avez construite. EndpointType doit avoir la valeur azurestorage. Pour tous les autres paramètres, utilisez les valeurs de votre scénario. Pour EndpointName, utilisez une valeur unique.

   Add-AzIotHubRoutingEndpoint -ResourceGroupName MyResourceGroup -Name MyIotHub -EndpointName MyEndpoint -EndpointType azurestorage -EndpointResourceGroup MyResourceGroup -EndpointSubscriptionId xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx -ConnectionString "my connection string"
   

4. Lorsque vous êtes invité à entrer le nom de votre conteneur, entrez le nom de votre conteneur, puis sélectionnez Entrée pour créer le point de terminaison.

Créer un itinéraire IoT Hub

Avec votre nouveau point de terminaison dans votre hub IoT, vous pouvez créer un itinéraire.

La route de repli par défaut dans IoT Hub collecte les messages de DeviceMessages. Choisissez une autre option pour votre itinéraire personnalisé, par exemple DeviceConnectionStateEvents. Pour plus d’informations sur les options de la source, consultez Add-AzIotHubRoute. Le paramètre Enabled étant un commutateur, vous n’avez pas besoin d’utiliser une valeur avec le paramètre .

Add-AzIotHubRoute -ResourceGroupName MyResourceGroup -Name MyIotHub -RouteName MyRoute -Source DeviceLifecycleEvents -EndpointName MyEndpoint -Enabled

PowerShell affiche une confirmation qui ressemble à cet exemple :

RouteName     : MyIotHub 
DataSource    : DeviceLifecycleEvents
EndpointNames : MyEndpoint
Condition     : true
IsEnabled     : True

Mettre à jour un itinéraire IoT

Pour apporter des modifications à un itinéraire existant, utilisez la commande suivante. Par exemple, essayez de modifier le nom de votre itinéraire à l’aide de la commande .

Set-AzIotHubRoute -ResourceGroupName MyResourceGroup -Name MyIotHub -RouteName MyRoute

Utilisez la commande Get-AzIotHubRoute pour confirmer la modification de votre itinéraire :

Get-AzIotHubRoute -ResourceGroupName MyResourceGroup -Name MyIotHub

Supprimer un point de terminaison

Pour supprimer un point de terminaison :

Remove-AzIotHubRoutingEndpoint -ResourceGroupName MyResourceGroup -Name MyIotHub -EndpointName MyEndpoint -PassThru

Supprimer un itinéraire IoT

Pour supprimer un itinéraire IoT Hub :

Remove-AzIotHubRoute -ResourceGroupName MyResourceGroup -Name MyIotHub -RouteName MyRoute -PassThru

Conseil

La suppression d’un itinéraire ne supprime pas les points de terminaison de votre compte Azure. Vous devez supprimer un point de terminaison séparément de la suppression d’un itinéraire.

Étapes suivantes

Dans cet article pratique, vous avez appris à créer un itinéraire et un point de terminaison pour votre instance Event Hubs, votre file d’attente ou vos rubriques Service Bus, et le Stockage Azure.

Pour en savoir plus sur le routage des messages, consultez Tutoriel : Envoyer des données d’appareil au Stockage Azure en utilisant le routage des messages IoT Hub. Dans le tutoriel, vous allez créer un itinéraire de stockage et le tester avec un appareil dans votre hub IoT.