Partager via

az iot hub message-endpoint

  • Préversion

Note

Cette référence fait partie de l’extension azure-iot pour Azure CLI (version 2.67.0 ou ultérieure). L’extension installe automatiquement la première fois que vous exécutez une az iot hub message-endpoint commande. Apprenez-en davantage sur les extensions.

Ce groupe de commandes est en préversion et en cours de développement. Niveaux de référence et de support : https://aka.ms/CLI_refstatus

Gérer les points de terminaison personnalisés d’un IoT Hub.

Commandes

Nom Description Type État
az iot hub message-endpoint create

Ajoutez un point de terminaison à un hub IoT.

 Extension Preview
az iot hub message-endpoint create cosmosdb-container

Ajoutez un point de terminaison de conteneur Cosmos DB pour un hub IoT.

 Extension Preview
az iot hub message-endpoint create eventhub

Ajoutez un point de terminaison Event Hub pour un hub IoT.

 Extension Preview
az iot hub message-endpoint create servicebus-queue

Ajoutez un point de terminaison de file d’attente Service Bus pour un hub IoT.

 Extension Preview
az iot hub message-endpoint create servicebus-topic

Ajoutez un point de terminaison de rubrique Service Bus pour un hub IoT.

 Extension Preview
az iot hub message-endpoint create storage-container

Ajoutez un point de terminaison de conteneur de stockage pour un hub IoT.

 Extension Preview
az iot hub message-endpoint delete

Supprimez tout ou un point de terminaison spécifique pour un hub IoT.

 Extension Preview
az iot hub message-endpoint list

Obtenez des informations sur tous les points de terminaison d’un Hub IoT.

 Extension Preview
az iot hub message-endpoint show

Obtenez des informations sur le point de terminaison mentionné pour un Hub IoT.

 Extension Preview
az iot hub message-endpoint update

Mettez à jour les propriétés d’un point de terminaison existant pour un Hub IoT.

 Extension Preview
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 Preview
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 Preview
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 Preview
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 Preview
az iot hub message-endpoint update storage-container

Mettez à jour les propriétés d’un point de terminaison de conteneur de stockage existant pour un hub IoT.

 Extension Preview

az iot hub message-endpoint delete

Préversion

Le groupe de commandes « iot hub message-endpoint » est en préversion et en cours de développement. Niveaux de référence et de support : https://aka.ms/CLI_refstatus

Supprimez tout ou un point de terminaison spécifique pour un hub IoT.

Vous devez supprimer tous les itinéraires et enrichissements de messages vers le point de terminaison, avant de supprimer le point de terminaison.

az iot hub message-endpoint delete [--en --endpoint --endpoint-name]
                                   [--endpoint-type --type {cosmosdb-container, eventhub, servicebus-queue, servicebus-topic, storage-container}]
                                   [--force]
                                   [--hub-name]
                                   [--ids]
                                   [--resource-group]
                                   [--subscription]
                                   [--yes {false, true}]

Exemples

Supprimez un point de terminaison d’un hub IoT.

az iot hub message-endpoint delete -n {iothub_name} --endpoint-name {endpoint_name}

Supprimez tous les points de terminaison de type « EventHub » d’un Hub IoT.

az iot hub message-endpoint delete -n {iothub_name} --endpoint-type eventhub

Supprimez tous les points de terminaison d’un Hub IoT.

az iot hub message-endpoint delete -n {iothub_name}

Forcez la suppression d’un point de terminaison à partir d’un hub IoT. Cela supprime tous les itinéraires et enrichissements de messages associés à ce point de terminaison.

az iot hub message-endpoint delete -n {iothub_name} --endpoint-name {endpoint_name} -f

Forcez la suppression de tous les points de terminaison de type « EventHub » d’un Hub IoT. Cela supprime tous les itinéraires et enrichissements de messages associés à ce point de terminaison.

az iot hub message-endpoint delete -n {iothub_name} --endpoint-type eventhub -f

Paramètres facultatifs

Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.

--en --endpoint --endpoint-name

Nom du point de terminaison de routage.

--endpoint-type --type -t

Type du point de terminaison de routage.

Propriété Valeur
Valeurs acceptées: cosmosdb-container, eventhub, servicebus-queue, servicebus-topic, storage-container
--force -f

Forcez la suppression des points de terminaison et des itinéraires et enrichissements de messages associés.

Propriété Valeur
Valeur par défaut: False
--hub-name -n

Nom d’IoT Hub.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--ids

Un ou plusieurs ID de ressource (délimités par l’espace). 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 ».

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut à l’aide de az account set -s NAME_OR_ID.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--yes -y

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.

Propriété Valeur
Valeurs acceptées: false, true
Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--verbose

Augmentez le niveau de verbosité de la journalisation. Utilisez --debug pour les journaux de débogage complets.

Propriété Valeur
Valeur par défaut: False

az iot hub message-endpoint list

Préversion

Le groupe de commandes « iot hub message-endpoint » est en préversion et en cours de développement. Niveaux de référence et de support : https://aka.ms/CLI_refstatus

Obtenez des informations sur tous les points de terminaison d’un Hub IoT.

Vous pouvez également spécifier le type de point de terminaison sur lequel vous souhaitez obtenir des informations.

az iot hub message-endpoint list [--endpoint-type --type {cosmosdb-container, eventhub, servicebus-queue, servicebus-topic, storage-container}]
                                 [--hub-name]
                                 [--ids]
                                 [--resource-group]
                                 [--subscription]

Exemples

Obtenez tous les points de terminaison à partir d’un Hub IoT.

az iot hub message-endpoint list -n {iothub_name}

Obtenez tous les points de terminaison de type « EventHub » à partir d’un Hub IoT.

az iot hub message-endpoint list -n {iothub_name} --endpoint-type eventhub

Paramètres facultatifs

Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.

--endpoint-type --type -t

Type du point de terminaison de routage.

Propriété Valeur
Valeurs acceptées: cosmosdb-container, eventhub, servicebus-queue, servicebus-topic, storage-container
--hub-name -n

Nom d’IoT Hub.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--ids

Un ou plusieurs ID de ressource (délimités par l’espace). 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 ».

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut à l’aide de az account set -s NAME_OR_ID.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--verbose

Augmentez le niveau de verbosité de la journalisation. Utilisez --debug pour les journaux de débogage complets.

Propriété Valeur
Valeur par défaut: False

az iot hub message-endpoint show

Préversion

Le groupe de commandes « iot hub message-endpoint » est en préversion et en cours de développement. Niveaux de référence et de support : https://aka.ms/CLI_refstatus

Obtenez des informations sur le point de terminaison mentionné pour un Hub IoT.

az iot hub message-endpoint show --en --endpoint --endpoint-name
                                 [--hub-name]
                                 [--ids]
                                 [--resource-group]
                                 [--subscription]

Exemples

Obtenez des informations de point de terminaison à partir d’un hub IoT.

az iot hub message-endpoint show -n {iothub_name} --endpoint-name {endpoint_name}

Paramètres obligatoires

--en --endpoint --endpoint-name

Nom du point de terminaison de routage.

Paramètres facultatifs

Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.

--hub-name -n

Nom d’IoT Hub.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--ids

Un ou plusieurs ID de ressource (délimités par l’espace). 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 ».

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut à l’aide de az account set -s NAME_OR_ID.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--verbose

Augmentez le niveau de verbosité de la journalisation. Utilisez --debug pour les journaux de débogage complets.

Propriété Valeur
Valeur par défaut: False