az iot hub
Remarque
Ce groupe de commandes a des commandes définies dans Azure CLI et au moins une extension. Installez chaque extension pour bénéficier de ses fonctionnalités étendues. En savoir plus sur les extensions.
Gérer les hubs Azure IoT.
Commandes
Nom | Description | Type | État |
---|---|---|---|
az iot hub certificate |
Gérer les certificats d’IoT Hub. |
Cœur et extension | GA |
az iot hub certificate create |
Créez/chargez un certificat Azure IoT Hub. |
Core | GA |
az iot hub certificate delete |
Supprime un certificat Azure IoT Hub. |
Core | GA |
az iot hub certificate generate-verification-code |
Génère un code de vérification pour un certificat Azure IoT Hub. |
Core | GA |
az iot hub certificate list |
Répertorie tous les certificats contenus dans un hub Azure IoT. |
Core | GA |
az iot hub certificate root-authority |
Gérez l’autorité racine du certificat pour une instance IoT Hub. |
Extension | Déprécié |
az iot hub certificate root-authority set |
Définissez l’autorité racine du certificat pour une instance IoT Hub sur une version spécifique. |
Extension | Déprécié |
az iot hub certificate root-authority show |
Afficher l’autorité racine de certificat actuelle pour une instance IoT Hub. |
Extension | Déprécié |
az iot hub certificate show |
Affiche des informations sur un certificat Azure IoT Hub particulier. |
Core | GA |
az iot hub certificate update |
Mettez à jour un certificat Azure IoT Hub. |
Core | GA |
az iot hub certificate verify |
Vérifie un certificat Azure IoT Hub. |
Core | GA |
az iot hub configuration |
Gérer la configuration de la gestion automatique des appareils IoT à grande échelle. |
Extension | GA |
az iot hub configuration create |
Créez une configuration de gestion automatique des appareils IoT dans un hub IoT cible. |
Extension | GA |
az iot hub configuration delete |
Supprimez une configuration d’appareil IoT. |
Extension | GA |
az iot hub configuration list |
Répertoriez les configurations de gestion automatique des appareils IoT dans un IoT Hub. |
Extension | GA |
az iot hub configuration show |
Obtenez les détails d’une configuration de gestion automatique des appareils IoT. |
Extension | GA |
az iot hub configuration show-metric |
Évaluez une métrique système ou utilisateur cible définie dans une configuration d’appareil IoT. |
Extension | GA |
az iot hub configuration update |
Mettez à jour les propriétés spécifiées d’une configuration de gestion automatique des appareils IoT. |
Extension | GA |
az iot hub connection-string |
Gérer les chaîne de connexion IoT Hub. |
Extension | GA |
az iot hub connection-string show |
Affichez les chaîne de connexion pour les hubs IoT spécifiés à l’aide du nom et de la clé de stratégie donnés. |
Extension | GA |
az iot hub consumer-group |
Gérez les groupes de consommateurs event hub d’un hub IoT. |
Core | GA |
az iot hub consumer-group create |
Créez un groupe de consommateurs Event Hub. |
Core | GA |
az iot hub consumer-group delete |
Supprimez un groupe de consommateurs Event Hub. |
Core | GA |
az iot hub consumer-group list |
Répertorier les groupes de consommateurs event Hub. |
Core | GA |
az iot hub consumer-group show |
Obtenez les détails d’un groupe de consommateurs Event Hub. |
Core | GA |
az iot hub create |
Créez un hub Azure IoT. |
Core | GA |
az iot hub delete |
Supprimez un hub IoT. |
Core | GA |
az iot hub device-identity |
Gérer les appareils IoT. |
Extension | GA |
az iot hub device-identity children |
Gérez les relations des appareils enfants pour les appareils IoT Edge. |
Extension | GA |
az iot hub device-identity children add |
Ajoutez des appareils en tant qu’enfants à un appareil de périphérie cible. |
Extension | GA |
az iot hub device-identity children list |
Génère la collection d’appareils enfants affectés. |
Extension | GA |
az iot hub device-identity children remove |
Supprimez les appareils enfants d’un appareil de périphérie cible. |
Extension | GA |
az iot hub device-identity connection-string |
Gérez les chaîne de connexion de l’appareil IoT. |
Extension | GA |
az iot hub device-identity connection-string show |
Afficher un appareil IoT Hub donné chaîne de connexion. |
Extension | GA |
az iot hub device-identity create |
Créez un appareil dans un hub IoT. |
Extension | GA |
az iot hub device-identity delete |
Supprimez un appareil IoT Hub. |
Extension | GA |
az iot hub device-identity export |
Exportez toutes les identités d’appareil à partir d’un Hub IoT vers un conteneur d’objets blob Stockage Azure. |
Extension | GA |
az iot hub device-identity import |
Importez des identités d’appareil dans un hub IoT à partir d’un objet blob de conteneur de stockage. |
Extension | GA |
az iot hub device-identity list |
Répertorier les appareils dans un IoT Hub. |
Extension | GA |
az iot hub device-identity parent |
Gérer les relations des appareils parents pour les appareils IoT. |
Extension | GA |
az iot hub device-identity parent set |
Définissez l’appareil parent d’un appareil cible. |
Extension | GA |
az iot hub device-identity parent show |
Obtenir l’appareil parent d’un appareil cible. |
Extension | GA |
az iot hub device-identity renew-key |
Renouvelez les clés cibles d’un appareil IoT Hub avec l’authentification sas. |
Extension | GA |
az iot hub device-identity show |
Obtenez les détails d’un appareil IoT Hub. |
Extension | GA |
az iot hub device-identity update |
Mettez à jour un appareil IoT Hub. |
Extension | GA |
az iot hub device-twin |
Gérer la configuration du jumeau d'appareil IoT. |
Extension | GA |
az iot hub device-twin list |
Répertorier les jumeaux d’appareil dans un Hub IoT. |
Extension | GA |
az iot hub device-twin replace |
Remplacez la définition de jumeau d’appareil par le json cible. |
Extension | GA |
az iot hub device-twin show |
Obtenir une définition de jumeau d’appareil. |
Extension | GA |
az iot hub device-twin update |
Mettez à jour les propriétés et balises souhaitées du jumeau d’appareil. |
Extension | GA |
az iot hub devicestream |
Gérer les flux d’appareils d’un hub IoT. |
Core | Aperçu |
az iot hub devicestream show |
Obtenez les points de terminaison de flux d’appareils d’IoT Hub. |
Core | Aperçu |
az iot hub digital-twin |
Manipuler et interagir avec le jumeau numérique d’un appareil IoT Hub. |
Extension | GA |
az iot hub digital-twin invoke-command |
Appelez une commande de niveau racine ou composant d’un appareil de jumeau numérique. |
Extension | GA |
az iot hub digital-twin show |
Afficher le jumeau numérique d’un appareil IoT Hub. |
Extension | GA |
az iot hub digital-twin update |
Mettez à jour les propriétés en lecture-écriture d’un appareil de jumeau numérique via la spécification de correctif JSON. |
Extension | GA |
az iot hub distributed-tracing |
Gérer les paramètres distribués par appareil. |
Extension | Aperçu |
az iot hub distributed-tracing show |
Obtenez les paramètres de suivi distribué pour un appareil. |
Extension | Aperçu |
az iot hub distributed-tracing update |
Mettez à jour les options de suivi distribué pour un appareil. |
Extension | Aperçu |
az iot hub generate-sas-token |
Générez un jeton SAP pour un ioT Hub, un appareil ou un module cible. |
Extension | GA |
az iot hub identity |
Gérez les identités d’un hub Azure IoT. |
Core | GA |
az iot hub identity assign |
Affectez des identités managées à un Hub IoT. |
Core | GA |
az iot hub identity remove |
Supprimez les identités managées d’un Hub IoT. |
Core | GA |
az iot hub identity show |
Afficher les propriétés d’identité d’un Hub IoT. |
Core | GA |
az iot hub invoke-device-method |
Appeler une méthode d’appareil. |
Extension | GA |
az iot hub invoke-module-method |
Appeler une méthode de module. |
Extension | GA |
az iot hub job |
Gérer les travaux IoT Hub (v2). |
Extension | GA |
az iot hub job cancel |
Annulez un travail IoT Hub. |
Extension | GA |
az iot hub job create |
Créez et planifiez un travail IoT Hub pour l’exécution. |
Extension | GA |
az iot hub job list |
Répertoriez les travaux historiques d’un Hub IoT. |
Extension | GA |
az iot hub job show |
Afficher les détails d’un travail IoT Hub existant. |
Extension | GA |
az iot hub list |
Répertorier les hubs IoT. |
Core | GA |
az iot hub list-skus |
Répertorier les niveaux tarifaires disponibles. |
Core | GA |
az iot hub manual-failover |
Initier un basculement manuel pour l’IoT Hub vers la région de récupération d’urgence couplée géographiquement. |
Core | GA |
az iot hub message-endpoint |
Gérer les points de terminaison personnalisés d’un IoT Hub. |
Extension | Aperçu |
az iot hub message-endpoint create |
Ajoutez un point de terminaison à un hub IoT. |
Extension | Aperçu |
az iot hub message-endpoint create cosmosdb-container |
Ajoutez un point de terminaison de conteneur Cosmos DB pour un hub IoT. |
Extension | Aperçu |
az iot hub message-endpoint create eventhub |
Ajoutez un point de terminaison Event Hub pour un hub IoT. |
Extension | Aperçu |
az iot hub message-endpoint create servicebus-queue |
Ajoutez un point de terminaison de file d’attente Service Bus pour un hub IoT. |
Extension | Aperçu |
az iot hub message-endpoint create servicebus-topic |
Ajoutez un point de terminaison de rubrique Service Bus pour un hub IoT. |
Extension | Aperçu |
az iot hub message-endpoint create storage-container |
Ajoutez un point de terminaison de conteneur Stockage pour un hub IoT. |
Extension | Aperçu |
az iot hub message-endpoint delete |
Supprimez tout ou un point de terminaison spécifique pour un hub IoT. |
Extension | Aperçu |
az iot hub message-endpoint list |
Obtenez des informations sur tous les points de terminaison d’un Hub IoT. |
Extension | Aperçu |
az iot hub message-endpoint show |
Obtenez des informations sur le point de terminaison mentionné pour un Hub IoT. |
Extension | Aperçu |
az iot hub message-endpoint update |
Mettez à jour les propriétés d’un point de terminaison existant pour un Hub IoT. |
Extension | Aperçu |
az iot hub message-endpoint update cosmosdb-container |
Mettez à jour les propriétés d’un point de terminaison de conteneur Cosmos DB existant pour un hub IoT. |
Extension | Aperçu |
az iot hub message-endpoint update eventhub |
Mettez à jour les propriétés d’un point de terminaison Event Hub existant pour un hub IoT. |
Extension | Aperçu |
az iot hub message-endpoint update servicebus-queue |
Mettez à jour les propriétés d’un point de terminaison de file d’attente Service Bus existant pour un hub IoT. |
Extension | Aperçu |
az iot hub message-endpoint update servicebus-topic |
Mettez à jour les propriétés d’un point de terminaison de rubrique Service Bus existant pour un hub IoT. |
Extension | Aperçu |
az iot hub message-endpoint update storage-container |
Mettez à jour les propriétés d’un point de terminaison de conteneur Stockage existant pour un hub IoT. |
Extension | Aperçu |
az iot hub message-enrichment |
Gérer les enrichissements de message pour les points de terminaison d’un IoT Hub. |
Core | GA |
az iot hub message-enrichment create |
Créez un enrichissement de messages pour les points de terminaison choisis dans votre IoT Hub. |
Core | GA |
az iot hub message-enrichment delete |
Supprimez un enrichissement de message dans votre hub IoT (par clé). |
Core | GA |
az iot hub message-enrichment list |
Obtenez des informations sur tous les enrichissements de messages pour votre IoT Hub. |
Core | GA |
az iot hub message-enrichment update |
Mettez à jour un enrichissement des messages dans votre hub IoT (par clé). |
Core | GA |
az iot hub message-route |
Gérer les itinéraires d’un IoT Hub. |
Extension | Aperçu |
az iot hub message-route create |
Ajoutez un itinéraire pour un IoT Hub. |
Extension | Aperçu |
az iot hub message-route delete |
Supprimez tous les itinéraires ou un itinéraire mentionné dans un Hub IoT. |
Extension | Aperçu |
az iot hub message-route fallback |
Gérez l’itinéraire de secours d’un hub IoT. |
Extension | Aperçu |
az iot hub message-route fallback set |
Activez ou désactivez l’itinéraire de secours dans un Hub IoT. |
Extension | Aperçu |
az iot hub message-route fallback show |
Affichez l’itinéraire de secours d’un IoT Hub. |
Extension | Aperçu |
az iot hub message-route list |
Obtenez tous les itinéraires dans un Hub IoT. |
Extension | Aperçu |
az iot hub message-route show |
Obtenez des informations sur l’itinéraire dans un Hub IoT. |
Extension | Aperçu |
az iot hub message-route test |
Testez tous les itinéraires ou un itinéraire mentionné dans un Hub IoT. |
Extension | Aperçu |
az iot hub message-route update |
Mettez à jour un itinéraire pour un hub IoT. |
Extension | Aperçu |
az iot hub module-identity |
Gérer les modules d’appareils IoT. |
Extension | GA |
az iot hub module-identity connection-string |
Gérez les chaîne de connexion du module d’appareil IoT. |
Extension | GA |
az iot hub module-identity connection-string show |
Afficher un module d’appareil IoT cible chaîne de connexion. |
Extension | GA |
az iot hub module-identity create |
Créez un module sur un appareil IoT cible dans un hub IoT. |
Extension | GA |
az iot hub module-identity delete |
Supprimez un appareil dans un hub IoT. |
Extension | GA |
az iot hub module-identity list |
Répertorier les modules situés sur un appareil IoT dans un Hub IoT. |
Extension | GA |
az iot hub module-identity renew-key |
Renouvelez les clés cibles d’un module d’appareil IoT Hub avec l’authentification sas. |
Extension | GA |
az iot hub module-identity show |
Obtenez les détails d’un module d’appareil IoT dans un Hub IoT. |
Extension | GA |
az iot hub module-identity update |
Mettez à jour un module d’appareil IoT Hub. |
Extension | GA |
az iot hub module-twin |
Gérer la configuration du jumeau de module d'appareil IoT. |
Extension | GA |
az iot hub module-twin replace |
Remplacez une définition de jumeau de module par json cible. |
Extension | GA |
az iot hub module-twin show |
Afficher une définition de jumeau de module. |
Extension | GA |
az iot hub module-twin update |
Mettez à jour les propriétés et balises souhaitées du jumeau de module. |
Extension | GA |
az iot hub monitor-events |
Surveillez la télémétrie de l’appareil et les messages envoyés à un hub IoT. |
Extension | GA |
az iot hub monitor-feedback |
Surveiller les commentaires envoyés par les appareils pour accuser réception des messages cloud-à-appareil (C2D). |
Extension | GA |
az iot hub policy |
Gérer les stratégies d’accès partagé d’un IoT Hub. |
Core | GA |
az iot hub policy create |
Créez une stratégie d’accès partagé dans un hub IoT. |
Core | GA |
az iot hub policy delete |
Supprimez une stratégie d’accès partagé à partir d’un hub IoT. |
Core | GA |
az iot hub policy list |
Répertorier les stratégies d’accès partagé d’un hub IoT. |
Core | GA |
az iot hub policy renew-key |
Régénérer les clés d’une stratégie d’accès partagé d’un hub IoT. |
Core | GA |
az iot hub policy show |
Obtenez les détails d’une stratégie d’accès partagé d’un hub IoT. |
Core | GA |
az iot hub query |
Interroger un IoT Hub à l’aide d’un puissant langage semblable à SQL. |
Extension | GA |
az iot hub route |
Gérer les itinéraires d’un IoT Hub. |
Core | Déprécié |
az iot hub route create |
Créez un itinéraire dans IoT Hub. |
Core | Déprécié |
az iot hub route delete |
Supprimez tout ou itinéraire mentionné pour votre IoT Hub. |
Core | Déprécié |
az iot hub route list |
Obtenez tous les itinéraires dans IoT Hub. |
Core | Déprécié |
az iot hub route show |
Obtenez des informations sur l’itinéraire dans IoT Hub. |
Core | Déprécié |
az iot hub route test |
Testez tous les itinéraires ou itinéraires mentionnés dans IoT Hub. |
Core | Déprécié |
az iot hub route update |
Mettez à jour un itinéraire dans IoT Hub. |
Core | Déprécié |
az iot hub routing-endpoint |
Gérer les points de terminaison personnalisés d’un IoT Hub. |
Core | Déprécié |
az iot hub routing-endpoint create |
Ajoutez un point de terminaison à votre IoT Hub. |
Core | Déprécié |
az iot hub routing-endpoint delete |
Supprimez tout ou point de terminaison mentionné pour votre IoT Hub. |
Core | Déprécié |
az iot hub routing-endpoint list |
Obtenez des informations sur tous les points de terminaison de votre IoT Hub. |
Core | Déprécié |
az iot hub routing-endpoint show |
Obtenez des informations sur le point de terminaison mentionné pour votre IoT Hub. |
Core | Déprécié |
az iot hub show |
Obtenez les détails d’un hub IoT. |
Core | GA |
az iot hub show-connection-string |
Affichez les chaîne de connexion pour un hub IoT. |
Core | Déprécié |
az iot hub show-quota-metrics |
Obtenez les métriques de quota pour un hub IoT. |
Core | GA |
az iot hub show-stats |
Obtenez les statistiques d’un hub IoT. |
Core | GA |
az iot hub state |
Gérez l’état d’un Hub IoT. |
Extension | Expérimental |
az iot hub state export |
Exportez l’état d’un Hub IoT vers un fichier. |
Extension | Expérimental |
az iot hub state import |
Importez un état hub à partir d’un fichier vers un hub IoT. |
Extension | Expérimental |
az iot hub state migrate |
Migrez l’état d’un hub vers un autre hub sans enregistrer dans un fichier. |
Extension | Expérimental |
az iot hub update |
Mettez à jour les métadonnées d’un hub IoT. |
Core | GA |
az iot hub wait |
Attendez qu’une opération sur une instance IoT Hub soit terminée. |
Core | GA |
az iot hub create
Créez un hub Azure IoT.
Pour une présentation d’Azure IoT Hub, consultez https://docs.microsoft.com/azure/iot-hub/.
az iot hub create --name
--resource-group
[--c2d-max-delivery-count]
[--c2d-ttl]
[--dds {false, true}]
[--disable-local-auth {false, true}]
[--disable-module-sas {false, true}]
[--edr {false, true}]
[--fc]
[--fcs]
[--fd]
[--feedback-lock-duration]
[--feedback-ttl]
[--fileupload-notification-lock-duration]
[--fileupload-notification-max-delivery-count]
[--fileupload-notification-ttl]
[--fileupload-notifications {false, true}]
[--fileupload-sas-ttl]
[--fileupload-storage-auth-type {identityBased, keyBased}]
[--fileupload-storage-identity]
[--location]
[--mi-system-assigned {false, true}]
[--mi-user-assigned]
[--min-tls-version]
[--no-wait]
[--partition-count]
[--rd]
[--role]
[--scopes]
[--sku {B1, B2, B3, F1, S1, S2, S3}]
[--tags]
[--unit]
Exemples
Créez un Hub IoT avec le niveau tarifaire gratuit F1, dans la région du groupe de ressources.
az iot hub create --resource-group MyResourceGroup --name MyIotHub --sku F1 --partition-count 2
Créez un IoT Hub avec le niveau tarifaire standard S1 et 4 partitions, dans la région « westus », avec des balises.
az iot hub create --resource-group MyResourceGroup --name MyIotHub --location westus --tags a=b c=d
Créez un Hub IoT avec une identité managée affectée par le système, puis attribuez un rôle et une étendue à un compte de stockage pour l’identité créée.
az iot hub create --resource-group MyResourceGroup --name MyIotHub --location westus --mi-system-assigned --role "Storage Blob Data Contributor" --scopes {resourceId}
Créer un Hub IoT avec l’authentification locale, les clés SAP d’appareil et les clés SAP du module désactivées
az iot hub create --resource-group MyResourceGroup --name MyIotHub --location westus --disable-local-auth --disable-device-sas --disable-module-sas
Créez un IoT Hub avec résidence des données appliquée. Cela désactive la récupération d’urgence inter-régions.
az iot hub create --resource-group MyResourceGroup --name MyIoTHub --edr
Paramètres obligatoires
Nom d’IoT Hub.
Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>
.
Paramètres facultatifs
Nombre de tentatives de remise d’un message cloud-à-appareil à un appareil, entre 1 et 100.
Durée pendant laquelle un message est disponible pour que l’appareil soit consommé avant son expiration par IoT Hub, entre 1 et 48 heures.
Valeur booléenne indiquant s’il faut désactiver ou non tous les appareils (y compris les appareils Edge, mais à l’exclusion des modules) des clés SAP étendues pour l’authentification.
Valeur booléenne indiquant s’il faut désactiver ou non les clés SAP délimitées par IoT Hub pour l’authentification.
Valeur booléenne indiquant s’il faut désactiver ou non les clés SAP étendues au module pour l’authentification.
Appliquez la résidence des données pour ce hub IoT en désactivant la récupération d’urgence inter-régions. Cette propriété est immuable une fois définie sur la ressource. Disponible uniquement dans certaines régions. Pour en savoir plus, rendez-vous sur https://aka.ms/iothubdisabledr.
Nom du conteneur racine dans lequel vous chargez des fichiers. Le conteneur n’a pas besoin d’exister, mais doit être créatable à l’aide de connectionString spécifié.
Chaîne de connexion pour le compte Stockage Azure dans lequel les fichiers sont chargés.
Nombre de tentatives de remise d’un message sur la file d’attente de commentaires, entre 1 et 100.
Durée de verrouillage de la file d’attente de commentaires, comprise entre 5 et 300 secondes.
Période pendant laquelle le hub IoT conserve les commentaires relatifs à l’expiration ou à la remise des messages cloud-à-appareil, entre 1 et 48 heures.
Durée de verrouillage de la file d’attente de notifications de chargement de fichiers, comprise entre 5 et 300 secondes.
Nombre de fois où le hub IoT tente de remettre un message de notification de fichier compris entre 1 et 100.
La durée pendant laquelle une notification de chargement de fichier est disponible pour que le service soit consommé avant son expiration par IoT Hub, entre 1 et 48 heures.
Valeur booléenne indiquant s’il faut consigner des informations sur les fichiers chargés vers le point de terminaison IoT Hub des messages/servicebound/filenotifications.
Durée pendant laquelle un URI SAP généré par IoT Hub est valide avant son expiration, entre 1 et 24 heures.
Type d’authentification pour le compte Stockage Azure dans lequel les fichiers sont chargés.
Identité managée à utiliser pour l’authentification de chargement de fichiers. Utilisez « [système] » pour faire référence à l’identité managée affectée par le système ou à un ID de ressource pour faire référence à une identité managée affectée par l’utilisateur.
Emplacement de votre IoT Hub. La valeur par défaut correspond à la localisation du groupe de ressources cible.
Activez l’identité managée affectée par le système pour ce hub.
Activez les identités managées affectées par l’utilisateur pour ce hub. Acceptez la liste séparée par l’espace des ID de ressource d’identité.
Spécifiez la version TLS minimale à prendre en charge pour ce hub. Peut être défini sur « 1.2 » pour que les clients qui utilisent une version TLS inférieure à la version 1.2 soient rejetés.
Ne pas attendre la fin de l’opération de longue durée.
Nombre de partitions du hub d’événements de stockage pour les messages appareil-à-cloud.
Spécifie la durée pendant laquelle ce hub IoT conserve les événements appareil-à-cloud, entre 1 et 7 jours.
Rôle à attribuer à l’identité managée affectée par le système du hub.
Liste d’étendues séparées par l’espace pour affecter le rôle (--role) pour l’identité managée affectée par le système.
Niveau tarifaire pour Azure IoT Hub. Notez qu’une seule instance IoT Hub gratuite (F1) est autorisée dans chaque abonnement. L’exception est levée si les instances gratuites dépassent une.
Balises séparées par l’espace : key[=value] [key[=value] ...]. Utilisez « » pour effacer les balises existantes.
Unités dans votre IoT Hub.
Paramètres globaux
Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.
Affichez ce message d’aide et quittez.
Afficher uniquement les erreurs, en supprimant les avertissements.
Format de sortie.
Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.
Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID
.
Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.
az iot hub delete
Supprimez un hub IoT.
az iot hub delete [--ids]
[--name]
[--no-wait]
[--resource-group]
[--subscription]
Exemples
Supprimez un hub IoT. (généré automatiquement)
az iot hub delete --name MyIoTHub --resource-group MyResourceGroup
Paramètres facultatifs
Un ou plusieurs ID de ressource (délimités par des espaces). Il doit s’agir d’un ID de ressource complet contenant toutes les informations des arguments « ID de ressource ». Vous devez fournir des arguments --id ou d’autres arguments « ID de ressource ».
Nom d’IoT Hub.
Ne pas attendre la fin de l’opération de longue durée.
Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>
.
Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID
.
Paramètres globaux
Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.
Affichez ce message d’aide et quittez.
Afficher uniquement les erreurs, en supprimant les avertissements.
Format de sortie.
Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.
Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID
.
Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.
az iot hub generate-sas-token
Générez un jeton SAP pour un ioT Hub, un appareil ou un module cible.
Pour les jetons SAS d’appareil, le paramètre de stratégie est utilisé pour accéder au registre d’appareils uniquement. Par conséquent, la stratégie doit avoir un accès en lecture au Registre. Pour les jetons IoT Hub, la stratégie fait partie de la SAP.
az iot hub generate-sas-token [--auth-type {key, login}]
[--connection-string]
[--device-id]
[--du]
[--hub-name]
[--key-type {primary, secondary}]
[--login]
[--module-id]
[--pn]
[--resource-group]
Exemples
Générez un jeton SAS IoT Hub à l’aide de la stratégie iothubowner et de la clé primaire.
az iot hub generate-sas-token -n {iothub_name}
Générez un jeton SAS IoT Hub à l’aide de la stratégie registryRead et de la clé secondaire.
az iot hub generate-sas-token -n {iothub_name} --policy registryRead --key-type secondary
Générez un jeton SAP d’appareil à l’aide de la stratégie iothubowner pour accéder au registre d’appareils {iothub_name}.
az iot hub generate-sas-token -d {device_id} -n {iothub_name}
Générer un jeton SAP d’appareil à l’aide d’un chaîne de connexion IoT Hub (avec accès au Registre)
az iot hub generate-sas-token -d {device_id} --login 'HostName=myhub.azure-devices.net;SharedAccessKeyName=iothubowner;SharedAccessKey=12345'
Générer un jeton SAS Iot Hub à l’aide d’un chaîne de connexion IoT Hub
az iot hub generate-sas-token --connection-string 'HostName=myhub.azure-devices.net;SharedAccessKeyName=iothubowner;SharedAccessKey=12345'
Générer un jeton SAP d’appareil à l’aide d’un chaîne de connexion d’appareil
az iot hub generate-sas-token --connection-string 'HostName=myhub.azure-devices.net;DeviceId=mydevice;SharedAccessKeyName=iothubowner;SharedAccessKey=12345'
Générer un jeton SAP de module à l’aide d’un chaîne de connexion de module
az iot hub generate-sas-token --connection-string 'HostName=myhub.azure-devices.net;DeviceId=mydevice;ModuleId=mymodule;SharedAccessKeyName=iothubowner;SharedAccessKey=12345'
Paramètres facultatifs
Indique si l’opération doit dériver automatiquement une clé de stratégie ou utiliser la session Azure AD actuelle. Si le type d’authentification est login et que le nom d’hôte de ressource est fourni, la recherche de ressources est ignorée, sauf si nécessaire. Vous pouvez configurer la valeur par défaut à l’aide az configure --defaults iothub-data-auth-type=<auth-type-value>
de .
Chaîne de connexion cible. Cela contourne le registre IoT Hub et génère le jeton SAP directement à partir de la clé symétrique fournie sans validation supplémentaire. Tous les autres paramètres de commande en dehors de la durée sont ignorés. Types de chaîne de connexion pris en charge : Iot Hub, Device, Module.
ID d’appareil cible.
Durée du jeton valide en secondes.
Nom ou nom d’hôte IoT Hub. Obligatoire si --login n’est pas fourni.
Type de clé de stratégie d’accès partagé pour l’authentification.
Cette commande prend en charge une entité chaîne de connexion avec des droits d’exécution d’action. Permet d’éviter la connexion de session via « az login ». Si une entité chaîne de connexion et un nom sont fournis, le chaîne de connexion a la priorité. Obligatoire si --hub-name n’est pas fourni.
ID du module cible.
Stratégie d’accès partagé avec autorisations d’opération pour l’entité IoT Hub cible.
Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>
.
Paramètres globaux
Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.
Affichez ce message d’aide et quittez.
Afficher uniquement les erreurs, en supprimant les avertissements.
Format de sortie.
Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.
Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID
.
Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.
az iot hub invoke-device-method
Appeler une méthode d’appareil.
az iot hub invoke-device-method --device-id
--method-name
[--auth-type {key, login}]
[--hub-name]
[--login]
[--method-payload]
[--resource-group]
[--timeout]
Exemples
Appelez une méthode directe sur un appareil.
az iot hub invoke-device-method --hub-name {iothub_name} --device-id {device_id} --method-name Reboot --method-payload '{"version":"1.0"}'
Paramètres obligatoires
ID d’appareil cible.
Méthode cible pour l’appel.
Paramètres facultatifs
Indique si l’opération doit dériver automatiquement une clé de stratégie ou utiliser la session Azure AD actuelle. Si le type d’authentification est login et que le nom d’hôte de ressource est fourni, la recherche de ressources est ignorée, sauf si nécessaire. Vous pouvez configurer la valeur par défaut à l’aide az configure --defaults iothub-data-auth-type=<auth-type-value>
de .
Nom ou nom d’hôte IoT Hub. Obligatoire si --login n’est pas fourni.
Cette commande prend en charge une entité chaîne de connexion avec des droits d’exécution d’action. Permet d’éviter la connexion de session via « az login ». Si une entité chaîne de connexion et un nom sont fournis, le chaîne de connexion a la priorité. Obligatoire si --hub-name n’est pas fourni.
Charge utile Json à passer à la méthode. Doit être le chemin d’accès au fichier ou json brut.
Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>
.
Nombre maximal de secondes à attendre pour le résultat de la méthode de l’appareil.
Paramètres globaux
Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.
Affichez ce message d’aide et quittez.
Afficher uniquement les erreurs, en supprimant les avertissements.
Format de sortie.
Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.
Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID
.
Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.
az iot hub invoke-module-method
Appeler une méthode de module.
Cette commande prend en charge les modules périphériques et non périphériques.
az iot hub invoke-module-method --device-id
--method-name
--module-id
[--auth-type {key, login}]
[--hub-name]
[--login]
[--method-payload]
[--resource-group]
[--timeout]
Exemples
Appelez une méthode directe sur un module d’appareil edge.
az iot hub invoke-module-method -n {iothub_name} -d {device_id} -m '$edgeAgent' --method-name 'RestartModule' --method-payload '{"schemaVersion": "1.0"}'
Paramètres obligatoires
ID d’appareil cible.
Méthode cible pour l’appel.
ID du module cible.
Paramètres facultatifs
Indique si l’opération doit dériver automatiquement une clé de stratégie ou utiliser la session Azure AD actuelle. Si le type d’authentification est login et que le nom d’hôte de ressource est fourni, la recherche de ressources est ignorée, sauf si nécessaire. Vous pouvez configurer la valeur par défaut à l’aide az configure --defaults iothub-data-auth-type=<auth-type-value>
de .
Nom ou nom d’hôte IoT Hub. Obligatoire si --login n’est pas fourni.
Cette commande prend en charge une entité chaîne de connexion avec des droits d’exécution d’action. Permet d’éviter la connexion de session via « az login ». Si une entité chaîne de connexion et un nom sont fournis, le chaîne de connexion a la priorité. Obligatoire si --hub-name n’est pas fourni.
Charge utile Json à passer à la méthode. Doit être le chemin d’accès au fichier ou json brut.
Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>
.
Nombre maximal de secondes à attendre pour le résultat de la méthode du module.
Paramètres globaux
Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.
Affichez ce message d’aide et quittez.
Afficher uniquement les erreurs, en supprimant les avertissements.
Format de sortie.
Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.
Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID
.
Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.
az iot hub list
Répertorier les hubs IoT.
az iot hub list [--resource-group]
Exemples
Répertoriez tous les hubs IoT dans un abonnement.
az iot hub list
Répertorier tous les hubs IoT dans le groupe de ressources « MyGroup »
az iot hub list --resource-group MyGroup
Paramètres facultatifs
Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>
.
Paramètres globaux
Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.
Affichez ce message d’aide et quittez.
Afficher uniquement les erreurs, en supprimant les avertissements.
Format de sortie.
Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.
Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID
.
Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.
az iot hub list-skus
Répertorier les niveaux tarifaires disponibles.
az iot hub list-skus [--ids]
[--name]
[--resource-group]
[--subscription]
Exemples
Répertorier les niveaux tarifaires disponibles. (généré automatiquement)
az iot hub list-skus --name MyIoTHub
Paramètres facultatifs
Un ou plusieurs ID de ressource (délimités par des espaces). Il doit s’agir d’un ID de ressource complet contenant toutes les informations des arguments « ID de ressource ». Vous devez fournir des arguments --id ou d’autres arguments « ID de ressource ».
Nom d’IoT Hub.
Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>
.
Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID
.
Paramètres globaux
Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.
Affichez ce message d’aide et quittez.
Afficher uniquement les erreurs, en supprimant les avertissements.
Format de sortie.
Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.
Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID
.
Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.
az iot hub manual-failover
Initier un basculement manuel pour l’IoT Hub vers la région de récupération d’urgence couplée géographiquement.
az iot hub manual-failover [--ids]
[--name]
[--no-wait]
[--resource-group]
[--subscription]
Exemples
Lancez le basculement « myhub » de la région primaire vers la région secondaire.
az iot hub manual-failover -n myhub
Paramètres facultatifs
Un ou plusieurs ID de ressource (délimités par des espaces). Il doit s’agir d’un ID de ressource complet contenant toutes les informations des arguments « ID de ressource ». Vous devez fournir des arguments --id ou d’autres arguments « ID de ressource ».
Nom d’IoT Hub.
Ne pas attendre la fin de l’opération de longue durée.
Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>
.
Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID
.
Paramètres globaux
Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.
Affichez ce message d’aide et quittez.
Afficher uniquement les erreurs, en supprimant les avertissements.
Format de sortie.
Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.
Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID
.
Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.
az iot hub monitor-events
Surveillez la télémétrie de l’appareil et les messages envoyés à un hub IoT.
Cette commande s’appuie et peut installer le package Cython dépendant (uamqp) lors de la première exécution. https://github.com/Azure/azure-uamqp-python
Remarque : L’événement s’affiche même si le corps du message n’est pas décodable unicode, dans ce cas, la partie charge utile de l’événement s’affiche en tant que {{charge utile non décodable}} avec le reste des propriétés d’événement disponibles.
az iot hub monitor-events [--cg]
[--content-type]
[--device-id]
[--device-query]
[--enqueued-time]
[--hub-name]
[--interface]
[--login]
[--mc]
[--module-id]
[--properties {all, anno, app, sys}]
[--repair {false, true}]
[--resource-group]
[--timeout]
[--yes {false, true}]
Exemples
Utilisation de base
az iot hub monitor-events -n {iothub_name}
Utilisation de base avec un chaîne de connexion IoT Hub
az iot hub monitor-events -n {iothub_name} --login 'HostName=myhub.azure-devices.net;SharedAccessKeyName=iothubowner;SharedAccessKey=12345'
Utilisation de base lors du filtrage sur l’appareil cible
az iot hub monitor-events -n {iothub_name} -d {device_id}
Utilisation de base lors du filtrage des appareils ciblés avec un caractère générique carte dans l’ID
az iot hub monitor-events -n {iothub_name} -d Device*
Filtrer les appareils à l’aide du langage de requête IoT Hub
az iot hub monitor-events -n {iothub_name} -q "select * from devices where tags.location.region = 'US'"
Filtrez l’appareil et spécifiez un groupe de consommateurs Event Hub à lier.
az iot hub monitor-events -n {iothub_name} -d {device_id} --cg {consumer_group_name}
Recevoir des annotations de message (en-têtes de message)
az iot hub monitor-events -n {iothub_name} -d {device_id} --properties anno
Recevoir des annotations de message + propriétés système. Ne jamais expirer.
az iot hub monitor-events -n {iothub_name} -d {device_id} --properties anno sys --timeout 0
Recevoir tous les attributs de message de tous les messages de l’appareil
az iot hub monitor-events -n {iothub_name} --props all
Recevoir tous les messages et analyser la charge utile des messages en tant que JSON
az iot hub monitor-events -n {iothub_name} --content-type application/json
Recevez le nombre spécifié de messages du hub, puis arrêtez.
az iot hub monitor-events -n {iothub_name} --message-count {message_count}
Paramètres facultatifs
Spécifiez le groupe de consommateurs à utiliser lors de la connexion au point de terminaison event Hub.
Spécifiez le type de contenu de la charge utile du message pour mettre automatiquement en forme la sortie sur ce type.
ID d’appareil cible.
Spécifiez une requête personnalisée pour filtrer les appareils.
Indique l’heure à utiliser comme point de départ pour lire les messages à partir des partitions. Les unités sont des millisecondes depuis l’époque unix. Si aucun temps n’est indiqué « maintenant » est utilisé.
Nom ou nom d’hôte IoT Hub. Obligatoire si --login n’est pas fourni.
Identificateur d’interface cible sur lequel filtrer. Par exemple : dtmi :com :example :TemperatureController ;1.
Cette commande prend en charge une entité chaîne de connexion avec des droits d’exécution d’action. Permet d’éviter la connexion de session via « az login ». Si une entité chaîne de connexion et un nom sont fournis, le chaîne de connexion a la priorité. Obligatoire si --hub-name n’est pas fourni.
Nombre de messages de télémétrie à capturer avant la fin du moniteur. S’il n’est pas spécifié, le moniteur continue à s’exécuter jusqu’à ce que le seuil de délai d’expiration ne soit pas atteint pour ne pas recevoir de messages à partir du hub.
ID du module cible.
Indiquez les propriétés de message clé à générer. sys = propriétés système, application = propriétés de l’application, anno = annotations.
Réinstallez la dépendance uamqp compatible avec la version de l’extension. Valeur par défaut : false.
Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>
.
Nombre maximal de secondes pour maintenir la connexion sans recevoir de message. Utilisez 0 pour l’infini.
Ignorez les invites de l’utilisateur. Indique l’acceptation de l’action. Utilisé principalement pour les scénarios d’automatisation. Valeur par défaut : false.
Paramètres globaux
Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.
Affichez ce message d’aide et quittez.
Afficher uniquement les erreurs, en supprimant les avertissements.
Format de sortie.
Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.
Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID
.
Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.
az iot hub monitor-feedback
Surveiller les commentaires envoyés par les appareils pour accuser réception des messages cloud-à-appareil (C2D).
Cette commande s’appuie et peut installer le package Cython dépendant (uamqp) lors de la première exécution. https://github.com/Azure/azure-uamqp-python.
az iot hub monitor-feedback [--auth-type {key, login}]
[--device-id]
[--hub-name]
[--login]
[--repair {false, true}]
[--resource-group]
[--wait-on-msg]
[--yes {false, true}]
Exemples
Utilisation de base
az iot hub monitor-feedback -n {iothub_name}
Utilisation de base avec un chaîne de connexion IoT Hub
az iot hub monitor-feedback -n {iothub_name} --login 'HostName=myhub.azure-devices.net;SharedAccessKeyName=iothubowner;SharedAccessKey=12345'
Utilisation de base lors du filtrage sur l’appareil cible
az iot hub monitor-feedback -n {iothub_name} -d {device_id}
Quitter le moniteur de commentaires lors de la réception d’un message avec un ID spécifique (uuid)
az iot hub monitor-feedback -n {iothub_name} -d {device_id} -w {message_id}
Paramètres facultatifs
Indique si l’opération doit dériver automatiquement une clé de stratégie ou utiliser la session Azure AD actuelle. Si le type d’authentification est login et que le nom d’hôte de ressource est fourni, la recherche de ressources est ignorée, sauf si nécessaire. Vous pouvez configurer la valeur par défaut à l’aide az configure --defaults iothub-data-auth-type=<auth-type-value>
de .
ID d’appareil cible.
Nom ou nom d’hôte IoT Hub. Obligatoire si --login n’est pas fourni.
Cette commande prend en charge une entité chaîne de connexion avec des droits d’exécution d’action. Permet d’éviter la connexion de session via « az login ». Si une entité chaîne de connexion et un nom sont fournis, le chaîne de connexion a la priorité. Obligatoire si --hub-name n’est pas fourni.
Réinstallez la dépendance uamqp compatible avec la version de l’extension. Valeur par défaut : false.
Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>
.
Le moniteur de commentaires bloque jusqu’à ce qu’un message avec un ID spécifique (uuid) soit reçu.
Ignorez les invites de l’utilisateur. Indique l’acceptation de l’action. Utilisé principalement pour les scénarios d’automatisation. Valeur par défaut : false.
Paramètres globaux
Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.
Affichez ce message d’aide et quittez.
Afficher uniquement les erreurs, en supprimant les avertissements.
Format de sortie.
Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.
Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID
.
Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.
az iot hub query
Interroger un IoT Hub à l’aide d’un puissant langage semblable à SQL.
Récupérez des informations sur les jumeaux d’appareil et de module, les travaux et le routage des messages. Consultez la rubrique https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language (éventuellement en anglais) pour plus d’informations.
az iot hub query --query-command
[--auth-type {key, login}]
[--hub-name]
[--login]
[--resource-group]
[--top]
Exemples
Interrogez toutes les données de jumeau d’appareil dans azure IoT Hub.
az iot hub query -n {iothub_name} -q "select * from devices"
Interrogez toutes les données de jumeau de module sur l’appareil cible.
az iot hub query -n {iothub_name} -q "select * from devices.modules where devices.deviceId = '{device_id}'"
Paramètres obligatoires
Requête utilisateur à exécuter.
Paramètres facultatifs
Indique si l’opération doit dériver automatiquement une clé de stratégie ou utiliser la session Azure AD actuelle. Si le type d’authentification est login et que le nom d’hôte de ressource est fourni, la recherche de ressources est ignorée, sauf si nécessaire. Vous pouvez configurer la valeur par défaut à l’aide az configure --defaults iothub-data-auth-type=<auth-type-value>
de .
Nom ou nom d’hôte IoT Hub. Obligatoire si --login n’est pas fourni.
Cette commande prend en charge une entité chaîne de connexion avec des droits d’exécution d’action. Permet d’éviter la connexion de session via « az login ». Si une entité chaîne de connexion et un nom sont fournis, le chaîne de connexion a la priorité. Obligatoire si --hub-name n’est pas fourni.
Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>
.
Nombre maximal d’éléments à retourner. Par défaut, la requête n’a pas de limite.
Paramètres globaux
Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.
Affichez ce message d’aide et quittez.
Afficher uniquement les erreurs, en supprimant les avertissements.
Format de sortie.
Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.
Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID
.
Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.
az iot hub show
Obtenez les détails d’un hub IoT.
az iot hub show [--ids]
[--name]
[--resource-group]
[--subscription]
Exemples
Obtenez les détails d’un hub IoT. (généré automatiquement)
az iot hub show --name MyIoTHub
Paramètres facultatifs
Un ou plusieurs ID de ressource (délimités par des espaces). Il doit s’agir d’un ID de ressource complet contenant toutes les informations des arguments « ID de ressource ». Vous devez fournir des arguments --id ou d’autres arguments « ID de ressource ».
Nom d’IoT Hub.
Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>
.
Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID
.
Paramètres globaux
Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.
Affichez ce message d’aide et quittez.
Afficher uniquement les erreurs, en supprimant les avertissements.
Format de sortie.
Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.
Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID
.
Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.
az iot hub show-connection-string
Cette commande a été déconseillée et sera supprimée dans une prochaine version. Utilisez la commande de chaîne de connexion « IoT Extension (azure-iot) (az iot hub connection-string show) » à la place.
Affichez les chaîne de connexion pour un hub IoT.
az iot hub show-connection-string [--all]
[--hub-name]
[--ids]
[--key {primary, secondary}]
[--policy-name]
[--resource-group]
[--subscription]
Exemples
Affichez la chaîne de connexion d’un hub IoT à l’aide de la stratégie par défaut et de la clé primaire.
az iot hub show-connection-string --name MyIotHub
Affichez la chaîne de connexion d’un Hub IoT à l’aide de la stratégie « service » et de la clé secondaire.
az iot hub show-connection-string --name MyIotHub --policy-name service --key secondary
Affichez les chaîne de connexion pour tous les hubs IoT dans un groupe de ressources.
az iot hub show-connection-string --resource-group MyResourceGroup
Affichez les chaîne de connexion pour tous les hubs IoT dans un abonnement.
az iot hub show-connection-string
Affichez les chaîne de connexion pour un hub IoT. (généré automatiquement)
az iot hub show-connection-string --key primary --policy-name MyPolicy
Paramètres facultatifs
Autoriser à afficher toutes les stratégies d’accès partagé.
Nom d’IoT Hub.
Un ou plusieurs ID de ressource (délimités par des espaces). Il doit s’agir d’un ID de ressource complet contenant toutes les informations des arguments « ID de ressource ». Vous devez fournir des arguments --id ou d’autres arguments « ID de ressource ».
Clé à utiliser.
Stratégie d’accès partagé à utiliser.
Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>
.
Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID
.
Paramètres globaux
Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.
Affichez ce message d’aide et quittez.
Afficher uniquement les erreurs, en supprimant les avertissements.
Format de sortie.
Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.
Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID
.
Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.
az iot hub show-quota-metrics
Obtenez les métriques de quota pour un hub IoT.
az iot hub show-quota-metrics [--ids]
[--name]
[--resource-group]
[--subscription]
Exemples
Obtenez les métriques de quota pour un hub IoT. (généré automatiquement)
az iot hub show-quota-metrics --ids {ids}
Obtenez les métriques de quota pour un hub IoT. (généré automatiquement)
az iot hub show-quota-metrics --name MyIoTHub
Paramètres facultatifs
Un ou plusieurs ID de ressource (délimités par des espaces). Il doit s’agir d’un ID de ressource complet contenant toutes les informations des arguments « ID de ressource ». Vous devez fournir des arguments --id ou d’autres arguments « ID de ressource ».
Nom d’IoT Hub.
Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>
.
Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID
.
Paramètres globaux
Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.
Affichez ce message d’aide et quittez.
Afficher uniquement les erreurs, en supprimant les avertissements.
Format de sortie.
Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.
Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID
.
Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.
az iot hub show-stats
Obtenez les statistiques d’un hub IoT.
az iot hub show-stats [--ids]
[--name]
[--resource-group]
[--subscription]
Exemples
Obtenez les statistiques d’un hub IoT. (généré automatiquement)
az iot hub show-stats --name MyIoTHub
Paramètres facultatifs
Un ou plusieurs ID de ressource (délimités par des espaces). Il doit s’agir d’un ID de ressource complet contenant toutes les informations des arguments « ID de ressource ». Vous devez fournir des arguments --id ou d’autres arguments « ID de ressource ».
Nom d’IoT Hub.
Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>
.
Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID
.
Paramètres globaux
Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.
Affichez ce message d’aide et quittez.
Afficher uniquement les erreurs, en supprimant les avertissements.
Format de sortie.
Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.
Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID
.
Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.
az iot hub update
Mettez à jour les métadonnées d’un hub IoT.
az iot hub update [--add]
[--c2d-max-delivery-count]
[--c2d-ttl]
[--dds {false, true}]
[--disable-local-auth {false, true}]
[--disable-module-sas {false, true}]
[--fc]
[--fcs]
[--fd]
[--feedback-lock-duration]
[--feedback-ttl]
[--fileupload-notification-lock-duration]
[--fileupload-notification-max-delivery-count]
[--fileupload-notification-ttl]
[--fileupload-notifications {false, true}]
[--fileupload-sas-ttl]
[--fileupload-storage-auth-type {identityBased, keyBased}]
[--fileupload-storage-identity]
[--force-string]
[--ids]
[--name]
[--rd]
[--remove]
[--resource-group]
[--set]
[--sku {B1, B2, B3, F1, S1, S2, S3}]
[--subscription]
[--tags]
[--unit]
Exemples
Ajouter des paramètres de conteneur de stockage au chargement de fichiers
az iot hub update --name MyIotHub --fileupload-storage-connectionstring "connection-string" \ --fileupload-storage-container-name "container_name"
Ajoutez une règle de filtre de pare-feu pour accepter le trafic à partir du masque IP 127.0.0.0/31.
az iot hub update --name MyIotHub --add properties.ipFilterRules filter_name=test-rule action=Accept ip_mask=127.0.0.0/31
Mettez à jour les métadonnées d’un hub IoT. (généré automatiquement)
az iot hub update --name MyIotHub --set properties.allocationPolicy="GeoLatency"
Mettre à jour les unités d’un IoT Hub sur 2 et ajouter des balises
az iot hub update -n MyIotHub --unit 2 --tags a=b c=d
Mettre à jour le niveau tarifaire d’un hub IoT en tant que S2
az iot hub update -n MyIotHub --sku S2
Mettre à jour les jours de rétention des événements appareil-à-cloud IoT Hub sous la forme de 3 jours
az iot hub update -n MyIotHub --retention-day 3
Mettre à jour les paramètres de messagerie cloud à appareil IoT Hub
az iot hub update --name MyIotHub --c2d-max-delivery-count 30 --c2d-ttl 5
Mettre à jour les paramètres de la file d’attente de commentaires IoT Hub
az iot hub update --name MyIoTHub --feedback-max-delivery-count 20 --feedback-lock-duration 100 --feedback-ttl 4
Mettez à jour les paramètres de chargement de fichiers IoT Hub et attribuez une identité managée à l’utilisateur pour le chargement de fichiers
az iot hub update -n MyIoTHub --fileupload-sas-ttl 5 --fileupload-storage-auth-type identityBased --fileupload-storage-identity [system]
Mettre à jour les paramètres de notification de chargement de fichiers IoT Hub et la durée du verrouillage de file d’attente
az iot hub update -n MyIoTHub --fileupload-notification-max-delivery-count 50 --fileupload-notification-ttl 48 --fileupload-notifications --fileupload-notification-lock-duration 10
Mettre à jour les paramètres SAS de module et d’authentification locale IoT Hub
az iot hub update -n MyIoTHub --disable-local-auth --disable-device-sas false --disable-module-sas true
Paramètres facultatifs
Ajoutez un objet à une liste d’objets en spécifiant un chemin d’accès et des paires clé-valeur. Exemple : --add property.listProperty <key=value, string or JSON string>
.
Nombre de tentatives de remise d’un message cloud-à-appareil à un appareil, entre 1 et 100.
Durée pendant laquelle un message est disponible pour que l’appareil soit consommé avant son expiration par IoT Hub, entre 1 et 48 heures.
Valeur booléenne indiquant s’il faut désactiver ou non tous les appareils (y compris les appareils Edge, mais à l’exclusion des modules) des clés SAP étendues pour l’authentification.
Valeur booléenne indiquant s’il faut désactiver ou non les clés SAP délimitées par IoT Hub pour l’authentification.
Valeur booléenne indiquant s’il faut désactiver ou non les clés SAP étendues au module pour l’authentification.
Nom du conteneur racine dans lequel vous chargez des fichiers. Le conteneur n’a pas besoin d’exister, mais doit être créatable à l’aide de connectionString spécifié.
Chaîne de connexion pour le compte Stockage Azure dans lequel les fichiers sont chargés.
Nombre de tentatives de remise d’un message sur la file d’attente de commentaires, entre 1 et 100.
Durée de verrouillage de la file d’attente de commentaires, comprise entre 5 et 300 secondes.
Période pendant laquelle le hub IoT conserve les commentaires relatifs à l’expiration ou à la remise des messages cloud-à-appareil, entre 1 et 48 heures.
Durée de verrouillage de la file d’attente de notifications de chargement de fichiers, comprise entre 5 et 300 secondes.
Nombre de fois où le hub IoT tente de remettre un message de notification de fichier compris entre 1 et 100.
La durée pendant laquelle une notification de chargement de fichier est disponible pour que le service soit consommé avant son expiration par IoT Hub, entre 1 et 48 heures.
Valeur booléenne indiquant s’il faut consigner des informations sur les fichiers chargés vers le point de terminaison IoT Hub des messages/servicebound/filenotifications.
Durée pendant laquelle un URI SAP généré par IoT Hub est valide avant son expiration, entre 1 et 24 heures.
Type d’authentification pour le compte Stockage Azure dans lequel les fichiers sont chargés.
Identité managée à utiliser pour l’authentification de chargement de fichiers. Utilisez « [système] » pour faire référence à l’identité managée affectée par le système ou à un ID de ressource pour faire référence à une identité managée affectée par l’utilisateur.
Lorsque vous utilisez « set » ou « add », conservez les littéraux de chaîne au lieu de tenter de convertir en JSON.
Un ou plusieurs ID de ressource (délimités par des espaces). Il doit s’agir d’un ID de ressource complet contenant toutes les informations des arguments « ID de ressource ». Vous devez fournir des arguments --id ou d’autres arguments « ID de ressource ».
Nom d’IoT Hub.
Spécifie la durée pendant laquelle ce hub IoT conserve les événements appareil-à-cloud, entre 1 et 7 jours.
Supprimez une propriété ou un élément d’une liste. Exemple : --remove property.list <indexToRemove>
OR --remove propertyToRemove
.
Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>
.
Mettez à jour un objet en spécifiant un chemin d’accès et une valeur de propriété à définir. Exemple : --set property1.property2=<value>
.
Niveau tarifaire pour Azure IoT Hub. Notez qu’une seule instance IoT Hub gratuite (F1) est autorisée dans chaque abonnement. L’exception est levée si les instances gratuites dépassent une.
Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID
.
Balises séparées par l’espace : key[=value] [key[=value] ...]. Utilisez « » pour effacer les balises existantes.
Unités dans votre IoT Hub.
Paramètres globaux
Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.
Affichez ce message d’aide et quittez.
Afficher uniquement les erreurs, en supprimant les avertissements.
Format de sortie.
Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.
Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID
.
Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.
az iot hub wait
Attendez qu’une opération sur une instance IoT Hub soit terminée.
az iot hub wait [--created]
[--custom]
[--deleted]
[--exists]
[--ids]
[--interval]
[--name]
[--resource-group]
[--subscription]
[--timeout]
[--updated]
Exemples
Patientez jusqu’à ce qu’une instance IoT Hub existante soit créée
az iot hub wait -n MyIoTHub --created
Patientez jusqu’à ce qu’une instance IoT Hub soit supprimée
az iot hub wait -n MyIoTHub --deleted
Patientez jusqu’à ce qu’une instance IoT Hub existante ait un état actif
az iot hub wait -n MyIoTHub --custom "properties.state=='Active'"
Paramètres facultatifs
Attendez la création avec « provisioningState » sur « Succeeded ».
Attendez que la condition réponde à une requête JMESPath personnalisée. Par exemple, provisioningState !='InProgress', instanceView.statuses[ ?code=='PowerState/running'].
Attendez la suppression.
Attendez que la ressource existe.
Un ou plusieurs ID de ressource (délimités par des espaces). Il doit s’agir d’un ID de ressource complet contenant toutes les informations des arguments « ID de ressource ». Vous devez fournir des arguments --id ou d’autres arguments « ID de ressource ».
Intervalle d’interrogation en secondes.
Nom d’IoT Hub.
Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>
.
Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID
.
Délai maximal d’attente en secondes.
Attendez la mise à jour avec provisioningState sur « Réussi ».
Paramètres globaux
Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.
Affichez ce message d’aide et quittez.
Afficher uniquement les erreurs, en supprimant les avertissements.
Format de sortie.
Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.
Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID
.
Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.