Partager via

az iot hub message-enrichment

Note

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. Apprenez-en davantage sur les extensions.

Gérer les enrichissements de message pour les points de terminaison d’un IoT Hub.

Commandes

Nom Description Type État
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 create (azure-iot extension)

Créez un enrichissement de messages pour les points de terminaison choisis dans votre IoT Hub.

 Extension 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 delete (azure-iot extension)

Supprimez un enrichissement de message dans votre hub IoT (par clé).

 Extension 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 list (azure-iot extension)

Obtenez des informations sur tous les enrichissements de messages pour votre IoT Hub.

 Extension 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-enrichment update (azure-iot extension)

Mettez à jour un enrichissement des messages dans votre hub IoT (par clé).

 Extension GA

az iot hub message-enrichment create

Modifier

Créez un enrichissement de messages pour les points de terminaison choisis dans votre IoT Hub.

az iot hub message-enrichment create --endpoints
                                     --key
                                     --name
                                     --value
                                     [--resource-group]

Exemples

Créer un enrichissement de message de {"key » :"value"} pour le point de terminaison « événements » dans votre IoT Hub

az iot hub message-enrichment create --key key --value value --endpoints events -n {iothub_name}

Paramètres obligatoires

--endpoints -e

Points de terminaison pour appliquer des enrichissements. Utilisez une liste séparée par un espace pour plusieurs points de terminaison.

--key -k

Clé de l’enrichissement.

--name -n

Nom d’IoT Hub.

--value -v

Valeur de l’enrichissement.

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.

--resource-group -g

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

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/.

--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.

--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-enrichment create (azure-iot extension)

Créez un enrichissement de messages pour les points de terminaison choisis dans votre IoT Hub.

az iot hub message-enrichment create --endpoints
                                     --key
                                     --name
                                     --value
                                     [--resource-group]

Exemples

Créer un enrichissement de message de {"key » :"value"} pour le point de terminaison « événements » dans votre IoT Hub

az iot hub message-enrichment create --key key --value value --endpoints events -n {iothub_name}

Paramètres obligatoires

--endpoints -e

Points de terminaison pour appliquer des enrichissements. Utilisez une liste séparée par un espace pour plusieurs points de terminaison.

--key -k

Clé de l’enrichissement.

--name -n

Nom d’IoT Hub.

--value -v

Valeur de l’enrichissement.

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.

--resource-group -g

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

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/.

--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.

--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-enrichment delete

Modifier

Supprimez un enrichissement de message dans votre hub IoT (par clé).

az iot hub message-enrichment delete --key
                                     [--ids]
                                     [--name]
                                     [--resource-group]
                                     [--subscription]

Exemples

Supprimer un enrichissement de message avec la clé « test » de votre IoT Hub

az iot hub message-enrichment delete --key test -n {iothub_name}

Paramètres obligatoires

--key -k

Clé de l’enrichissement.

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.

--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
--name -n

Nom d’IoT Hub.

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-enrichment delete (azure-iot extension)

Supprimez un enrichissement de message dans votre hub IoT (par clé).

az iot hub message-enrichment delete --key
                                     [--ids]
                                     [--name]
                                     [--resource-group]
                                     [--subscription]

Exemples

Supprimer un enrichissement de message avec la clé « test » de votre IoT Hub

az iot hub message-enrichment delete --key test -n {iothub_name}

Paramètres obligatoires

--key -k

Clé de l’enrichissement.

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.

--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
--name -n

Nom d’IoT Hub.

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-enrichment list

Modifier

Obtenez des informations sur tous les enrichissements de messages pour votre IoT Hub.

az iot hub message-enrichment list [--ids]
                                   [--name]
                                   [--resource-group]
                                   [--subscription]

Exemples

Répertorier tous les enrichissements de messages pour votre IoT Hub

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

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.

--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
--name -n

Nom d’IoT Hub.

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-enrichment list (azure-iot extension)

Obtenez des informations sur tous les enrichissements de messages pour votre IoT Hub.

az iot hub message-enrichment list [--ids]
                                   [--name]
                                   [--resource-group]
                                   [--subscription]

Exemples

Répertorier tous les enrichissements de messages pour votre IoT Hub

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

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.

--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
--name -n

Nom d’IoT Hub.

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-enrichment update

Modifier

Mettez à jour un enrichissement des messages dans votre hub IoT (par clé).

az iot hub message-enrichment update --endpoints
                                     --key
                                     --value
                                     [--ids]
                                     [--name]
                                     [--resource-group]
                                     [--subscription]

Exemples

Mettre à jour un enrichissement des messages dans votre hub IoT pour s’appliquer à un nouvel ensemble de points de terminaison

az iot hub message-enrichment update --key {key} --value {value} --endpoints NewEndpoint1 NewEndpoint2 -n {iothub_name}

Paramètres obligatoires

--endpoints -e

Points de terminaison pour appliquer des enrichissements. Utilisez une liste séparée par un espace pour plusieurs points de terminaison.

--key -k

Clé de l’enrichissement.

--value -v

Valeur de l’enrichissement.

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.

--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
--name -n

Nom d’IoT Hub.

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-enrichment update (azure-iot extension)

Mettez à jour un enrichissement des messages dans votre hub IoT (par clé).

az iot hub message-enrichment update --endpoints
                                     --key
                                     --value
                                     [--ids]
                                     [--name]
                                     [--resource-group]
                                     [--subscription]

Exemples

Mettre à jour un enrichissement des messages dans votre hub IoT pour s’appliquer à un nouvel ensemble de points de terminaison

az iot hub message-enrichment update --key {key} --value {value} --endpoints NewEndpoint1 NewEndpoint2 -n {iothub_name}

Paramètres obligatoires

--endpoints -e

Points de terminaison pour appliquer des enrichissements. Utilisez une liste séparée par un espace pour plusieurs points de terminaison.

--key -k

Clé de l’enrichissement.

--value -v

Valeur de l’enrichissement.

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.

--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
--name -n

Nom d’IoT Hub.

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