Partager via

az iot hub message-endpoint update

  • Préversion
  • Référence

Remarque

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

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

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

Commandes

Nom Description Type État
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 de stockage existant pour un hub IoT.

 Extension Aperçu

az iot hub message-endpoint update cosmosdb-container

Préversion

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

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

Si vous mettez à jour le type d’authentification d’une clé vers un point de terminaison de conteneur Cosmos DB basé sur l’identité, vous devez fournir l’identité (via --identity) et l’URI du point de terminaison (via --endpoint-uri). L’ancienne clé primaire et la clé secondaire sont supprimées.

Si vous mettez à jour le type d’authentification d’un point de terminaison de conteneur Cosmos DB basé sur une identité, vous devez fournir le chaîne de connexion (via --connection-string), la clé primaire (via --primary-key) ou la clé secondaire (via --secondary-key).

Impossible de modifier le nom du conteneur pour le point de terminaison. Les noms de compte ne peuvent être modifiés que si les conteneurs portant le même nom existent dans les deux comptes.

az iot hub message-endpoint update cosmosdb-container --en
                                                      --hub-name
                                                      [--connection-string]
                                                      [--database-name]
                                                      [--endpoint-resource-group]
                                                      [--endpoint-subscription-id]
                                                      [--endpoint-uri]
                                                      [--identity]
                                                      [--partition-key-name]
                                                      [--partition-key-template]
                                                      [--pk]
                                                      [--resource-group]
                                                      [--secondary-key]

Exemples

Mettez à jour un point de terminaison de conteneur Cosmos DB basé sur une clé ou une identité pour un Hub IoT afin d’utiliser une nouvelle chaîne de connexion spécifiée.

az iot hub message-endpoint update cosmosdb-container -n {iothub_name} --en {endpoint_name} --connection-string {connection_string}

Mettez à jour un point de terminaison de conteneur Cosmos DB pour qu’un hub IoT utilise une clé primaire et une clé secondaire spécifiées.

az iot hub message-endpoint update cosmosdb-container -n {iothub_name} --en {endpoint_name} --pk {primary_key} --sk {secondary_key}

Mettez à jour un point de terminaison de conteneur Cosmos DB pour qu’un IoT Hub utilise l’identité affectée par le système et un nom de clé de partition. Le modèle de clé de partition sera la valeur par défaut.

az iot hub message-endpoint update cosmosdb-container -n {iothub_name} --en {endpoint_name} --pkn {partition_key_name} --identity [system]

Mettez à jour un point de terminaison de conteneur Cosmos DB basé sur une clé pour un Hub IoT afin d’utiliser l’identité affectée par l’utilisateur (vous pouvez omettre --endpoint-uri si le point de terminaison est déjà basé sur l’identité).

az iot hub message-endpoint update cosmosdb-container -n {iothub_name} --en {endpoint_name} --identity {user_identity_resource_id} --endpoint-uri {endpoint_uri}

Paramètres obligatoires

--en --endpoint --endpoint-name

Nom du point de terminaison de routage.

--hub-name -n

Nom d’IoT Hub.

Paramètres facultatifs

--connection-string -c

Chaîne de connexion du point de terminaison de routage.

--database-name --db

Nom de la base de données cosmos DB dans le compte cosmos DB.

--endpoint-resource-group --erg -r

Groupe de ressources de la ressource du point de terminaison. S’il n’est pas fourni, le groupe de ressources d’IoT Hub sera utilisé.

--endpoint-subscription-id -s

ID d’abonnement de la ressource de point de terminaison. S’il n’est pas fourni, l’abonnement d’IoT Hub est utilisé.

--endpoint-uri

URI de la ressource de point de terminaison.

--identity

Utilisez une identité managée affectée par le système ou affectée par l’utilisateur pour l’authentification de point de terminaison. Utilisez « [système] » pour faire référence à l’identité affectée par le système ou à un ID de ressource pour faire référence à une identité affectée par l’utilisateur.

--partition-key-name --pkn

Nom de la clé de partition associée à ce conteneur SQL Cosmos DB s’il en existe un. Pour effacer cette propriété, affectez la valeur « ».

--partition-key-template --pkt

Modèle de génération d’une valeur de clé de partition synthétique à utiliser avec ce conteneur SQL Cosmos DB. Le modèle doit inclure au moins l’un des espaces réservés suivants : {iothub}, {deviceid}, {DD}, {MM}et {AAAA}. Tous les espaces réservés peuvent être spécifiés au maximum une fois, mais les composants de commande et non-espace réservé sont arbitraires. Si le nom de clé de partition est fourni, le modèle de clé de partition est défini par défaut sur {deviceid}-{AAAA}-{MM}. Pour effacer cette propriété, affectez la valeur « ».

--pk --primary-key

Clé primaire du compte Cosmos DB.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

--secondary-key --sk

Clé secondaire du compte Cosmos DB.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

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

Chaîne de requêtes 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 en utilisant az account set -s NAME_OR_ID.

--verbose

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

az iot hub message-endpoint update eventhub

Préversion

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

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

Si vous mettez à jour le type d’authentification à partir d’une clé vers un point de terminaison Event Hub basé sur l’identité, vous devez fournir l’identité (via --identity), l’URI du point de terminaison (via --endpoint-uri) et le chemin d’entité (via --entity-path). L’ancienne chaîne de connexion sera supprimée.

Si vous mettez à jour le type d’authentification à partir d’une identité basée sur un point de terminaison Event Hub basé sur des clés, vous devez fournir le chaîne de connexion (via --connection-string). L’ancien uri de point de terminaison et le chemin d’accès d’entité sont supprimés.

az iot hub message-endpoint update eventhub --en
                                            --hub-name
                                            [--connection-string]
                                            [--endpoint-resource-group]
                                            [--endpoint-subscription-id]
                                            [--endpoint-uri]
                                            [--entity-path]
                                            [--identity]
                                            [--resource-group]

Exemples

Mettez à jour un point de terminaison Event Hub basé sur une clé ou une identité pour qu’un Hub IoT utilise une nouvelle chaîne de connexion spécifiée.

az iot hub message-endpoint update eventhub -n {iothub_name} --en {endpoint_name} -c {connection_string}

Mettez à jour un point de terminaison Event Hub pour qu’un IoT Hub utilise l’identité affectée par le système et un autre chemin d’entité.

az iot hub message-endpoint update eventhub -n {iothub_name} --en {endpoint_name} --entity-path {entity_path} --identity [system]

Mettez à jour un point de terminaison Event Hub basé sur des clés pour qu’un Hub IoT utilise l’identité affectée par l’utilisateur (vous pouvez omettre --endpoint-uri si le point de terminaison est déjà basé sur l’identité).

az iot hub message-endpoint update eventhub -n {iothub_name} --en {endpoint_name} --identity {user_identity_resource_id} --endpoint-uri {endpoint_uri} --entity-path {entity_path}

Paramètres obligatoires

--en --endpoint --endpoint-name

Nom du point de terminaison de routage.

--hub-name -n

Nom d’IoT Hub.

Paramètres facultatifs

--connection-string -c

Chaîne de connexion du point de terminaison de routage.

--endpoint-resource-group --erg -r

Groupe de ressources de la ressource du point de terminaison. S’il n’est pas fourni, le groupe de ressources d’IoT Hub sera utilisé.

--endpoint-subscription-id -s

ID d’abonnement de la ressource de point de terminaison. S’il n’est pas fourni, l’abonnement d’IoT Hub est utilisé.

--endpoint-uri

URI de la ressource de point de terminaison.

--entity-path

Chemin d’accès d’entité de la ressource de point de terminaison.

--identity

Utilisez une identité managée affectée par le système ou affectée par l’utilisateur pour l’authentification de point de terminaison. Utilisez « [système] » pour faire référence à l’identité affectée par le système ou à un ID de ressource pour faire référence à une identité affectée par l’utilisateur.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

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

Chaîne de requêtes 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 en utilisant az account set -s NAME_OR_ID.

--verbose

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

az iot hub message-endpoint update servicebus-queue

Préversion

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

Mettez à jour les propriétés d’un point de terminaison de file d’attente Service Bus existant pour un hub IoT.

Si vous mettez à jour le type d’authentification d’une clé vers un point de terminaison de file d’attente Service Bus basé sur l’identité, vous devez fournir l’identité (via --identity), l’URI du point de terminaison (via --endpoint-uri) et le chemin d’entité (via --entity-path). L’ancienne chaîne de connexion sera supprimée.

Si vous mettez à jour le type d’authentification à partir d’une identité basée sur un point de terminaison de file d’attente Service Bus basé sur des clés, vous devez fournir le chaîne de connexion (via --connection-string). L’ancien uri de point de terminaison et le chemin d’accès d’entité sont supprimés.

az iot hub message-endpoint update servicebus-queue --en
                                                    --hub-name
                                                    [--connection-string]
                                                    [--endpoint-resource-group]
                                                    [--endpoint-subscription-id]
                                                    [--endpoint-uri]
                                                    [--entity-path]
                                                    [--identity]
                                                    [--resource-group]

Exemples

Mettez à jour un point de terminaison de file d’attente Service Bus basé sur des clés ou des identités pour qu’un hub IoT utilise une nouvelle chaîne de connexion spécifiée.

az iot hub message-endpoint update servicebus-queue -n {iothub_name} --en {endpoint_name} -c {connection_string}

Mettez à jour un point de terminaison de file d’attente Service Bus pour qu’un Hub IoT utilise l’identité affectée par le système et un chemin d’accès d’entité différent.

az iot hub message-endpoint update servicebus-queue -n {iothub_name} --en {endpoint_name} --entity-path {entity_path} --identity [system]

Mettez à jour un point de terminaison de file d’attente Service Bus basé sur une clé pour un Hub IoT afin d’utiliser l’identité affectée par l’utilisateur (vous pouvez omettre --endpoint-uri si le point de terminaison est déjà basé sur l’identité).

az iot hub message-endpoint update servicebus-queue -n {iothub_name} --en {endpoint_name} --identity {user_identity_resource_id} --endpoint-uri {endpoint_uri} --entity-path {entity_path}

Paramètres obligatoires

--en --endpoint --endpoint-name

Nom du point de terminaison de routage.

--hub-name -n

Nom d’IoT Hub.

Paramètres facultatifs

--connection-string -c

Chaîne de connexion du point de terminaison de routage.

--endpoint-resource-group --erg -r

Groupe de ressources de la ressource du point de terminaison. S’il n’est pas fourni, le groupe de ressources d’IoT Hub sera utilisé.

--endpoint-subscription-id -s

ID d’abonnement de la ressource de point de terminaison. S’il n’est pas fourni, l’abonnement d’IoT Hub est utilisé.

--endpoint-uri

URI de la ressource de point de terminaison.

--entity-path

Chemin d’accès d’entité de la ressource de point de terminaison.

--identity

Utilisez une identité managée affectée par le système ou affectée par l’utilisateur pour l’authentification de point de terminaison. Utilisez « [système] » pour faire référence à l’identité affectée par le système ou à un ID de ressource pour faire référence à une identité affectée par l’utilisateur.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

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

Chaîne de requêtes 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 en utilisant az account set -s NAME_OR_ID.

--verbose

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

az iot hub message-endpoint update servicebus-topic

Préversion

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

Mettez à jour les propriétés d’un point de terminaison de rubrique Service Bus existant pour un hub IoT.

Si vous mettez à jour le type d’authentification d’un point de terminaison de rubrique Service Bus basé sur une clé, vous devez fournir l’identité (via --identity), l’URI du point de terminaison (via --endpoint-uri) et le chemin d’entité (via --entity-path). L’ancienne chaîne de connexion sera supprimée.

Si vous mettez à jour le type d’authentification à partir d’une identité basée sur un point de terminaison de rubrique Service Bus basé sur des clés, vous devez fournir le chaîne de connexion (via --connection-string). L’ancien uri de point de terminaison et le chemin d’accès d’entité sont supprimés.

az iot hub message-endpoint update servicebus-topic --en
                                                    --hub-name
                                                    [--connection-string]
                                                    [--endpoint-resource-group]
                                                    [--endpoint-subscription-id]
                                                    [--endpoint-uri]
                                                    [--entity-path]
                                                    [--identity]
                                                    [--resource-group]

Exemples

Mettez à jour un point de terminaison de rubrique Service Bus basé sur des clés ou des identités pour qu’un Hub IoT utilise une nouvelle chaîne de connexion spécifiée.

az iot hub message-endpoint update servicebus-topic -n {iothub_name} --en {endpoint_name} -c {connection_string}

Mettez à jour un point de terminaison de rubrique Service Bus pour qu’un Hub IoT utilise l’identité affectée par le système et un autre chemin d’entité.

az iot hub message-endpoint update servicebus-topic -n {iothub_name} --en {endpoint_name} --entity-path {entity_path} --identity [system]

Mettez à jour un point de terminaison de rubrique Service Bus basé sur des clés pour qu’un Hub IoT utilise l’identité affectée par l’utilisateur (vous pouvez omettre --endpoint-uri si le point de terminaison est déjà basé sur l’identité).

az iot hub message-endpoint update servicebus-topic -n {iothub_name} --en {endpoint_name}  --identity {user_identity_resource_id} --endpoint-uri {endpoint_uri} --entity-path {entity_path}

Paramètres obligatoires

--en --endpoint --endpoint-name

Nom du point de terminaison de routage.

--hub-name -n

Nom d’IoT Hub.

Paramètres facultatifs

--connection-string -c

Chaîne de connexion du point de terminaison de routage.

--endpoint-resource-group --erg -r

Groupe de ressources de la ressource du point de terminaison. S’il n’est pas fourni, le groupe de ressources d’IoT Hub sera utilisé.

--endpoint-subscription-id -s

ID d’abonnement de la ressource de point de terminaison. S’il n’est pas fourni, l’abonnement d’IoT Hub est utilisé.

--endpoint-uri

URI de la ressource de point de terminaison.

--entity-path

Chemin d’accès d’entité de la ressource de point de terminaison.

--identity

Utilisez une identité managée affectée par le système ou affectée par l’utilisateur pour l’authentification de point de terminaison. Utilisez « [système] » pour faire référence à l’identité affectée par le système ou à un ID de ressource pour faire référence à une identité affectée par l’utilisateur.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

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

Chaîne de requêtes 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 en utilisant az account set -s NAME_OR_ID.

--verbose

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

az iot hub message-endpoint update storage-container

Préversion

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

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

Si vous mettez à jour le type d’authentification d’une clé vers un point de terminaison de conteneur de stockage basé sur l’identité, vous devez fournir l’identité (via --identity) et l’URI du point de terminaison (via --endpoint-uri). L’ancienne chaîne de connexion sera supprimée.

Si vous mettez à jour le type d’authentification à partir d’une identité basée sur un point de terminaison de conteneur de stockage basé sur des clés, vous devez fournir le chaîne de connexion (via --connection-string).

Le nom et l’encodage du conteneur pour le point de terminaison ne peuvent pas être modifiés. Les noms de compte ne peuvent être modifiés que si les conteneurs portant le même nom existent dans les deux comptes.

az iot hub message-endpoint update storage-container --en
                                                     --hub-name
                                                     [--batch-frequency]
                                                     [--chunk-size]
                                                     [--connection-string]
                                                     [--endpoint-resource-group]
                                                     [--endpoint-subscription-id]
                                                     [--endpoint-uri]
                                                     [--ff]
                                                     [--identity]
                                                     [--resource-group]

Exemples

Mettez à jour un point de terminaison de conteneur de stockage basé sur une clé ou une identité pour qu’un hub IoT utilise une nouvelle chaîne de connexion spécifiée.

az iot hub message-endpoint update storage-container -n {iothub_name} --en {endpoint_name} -c {connection_string}

Mettez à jour un point de terminaison de conteneur de stockage pour qu’un Hub IoT utilise l’identité affectée par le système avec la fréquence de lot, la taille de bloc et le format de nom de fichier donnés.

az iot hub message-endpoint update storage-container -n {iothub_name} --en {endpoint_name}  -b {batch_frequency} -w {chunk_size} --ff {file_format} --identity [system]

Mettez à jour un point de terminaison de conteneur de stockage basé sur des clés pour qu’un hub IoT utilise l’identité affectée par l’utilisateur (vous pouvez omettre --endpoint-uri si le point de terminaison est déjà basé sur l’identité).

az iot hub message-endpoint update storage-container -n {iothub_name} --en {endpoint_name} --identity {user_identity_resource_id} --endpoint-uri {endpoint_uri}

Paramètres obligatoires

--en --endpoint --endpoint-name

Nom du point de terminaison de routage.

--hub-name -n

Nom d’IoT Hub.

Paramètres facultatifs

--batch-frequency -b

Demander une fréquence de traitement par lots en secondes. Durée maximale qui peut s’écouler avant l’écriture des données dans un objet blob, entre 60 et 720 secondes.

--chunk-size -w

Taille de bloc de requête en mégaoctets(Mo). Taille maximale des objets blob, comprise entre 10 et 500 Mo.

--connection-string -c

Chaîne de connexion du point de terminaison de routage.

--endpoint-resource-group --erg -r

Groupe de ressources de la ressource du point de terminaison. S’il n’est pas fourni, le groupe de ressources d’IoT Hub sera utilisé.

--endpoint-subscription-id -s

ID d’abonnement de la ressource de point de terminaison. S’il n’est pas fourni, l’abonnement d’IoT Hub est utilisé.

--endpoint-uri

URI de la ressource de point de terminaison.

--ff --file-name-format

Format de nom de fichier pour l’objet blob. Le format de nom de fichier doit contenir {iothub}, {partition}, {AAAA}, {MM}, {DD}, {HH} et {mm}. Tous les paramètres sont obligatoires, mais peuvent être réorganisé avec ou sans délimiteurs.

--identity

Utilisez une identité managée affectée par le système ou affectée par l’utilisateur pour l’authentification de point de terminaison. Utilisez « [système] » pour faire référence à l’identité affectée par le système ou à un ID de ressource pour faire référence à une identité affectée par l’utilisateur.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

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

Chaîne de requêtes 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 en utilisant az account set -s NAME_OR_ID.

--verbose

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