Partager via

az tsi event-source iothub

  • Référence

Remarque

Cette référence fait partie de l’extension timeseriesinsights pour Azure CLI (version 2.50.0 ou ultérieure). L’extension installe automatiquement la première fois que vous exécutez une commande iothub source d’événement az tsi. En savoir plus sur les extensions.

Gérer la source d’événement avec timeseriesinsights sous-groupe iot-hub.

Commandes

Nom Description Type Statut
az tsi event-source iothub create

Créez une source d’événement sous l’environnement spécifié.

 Extension GA
az tsi event-source iothub update

Mettez à jour une source d’événement dans l’environnement spécifié.

 Extension GA

az tsi event-source iothub create

Créez une source d’événement sous l’environnement spécifié.

az tsi event-source iothub create --consumer-group-name
                                  --environment-name
                                  --event-source-name
                                  --event-source-resource-id
                                  --iot-hub-name
                                  --key-name
                                  --location
                                  --resource-group
                                  --shared-access-key
                                  [--local-timestamp]
                                  [--tags]
                                  [--timestamp-property-name]

Exemples

CreateIotHubEventSource

az tsi event-source iothub create -g "rg" --environment-name "env1" --name "eventsource" --consumer-group-name "consumer-group" --iot-hub-name "iothub" --location westus --key-name "key-name" --shared-access-key "someSecretvalue" --event-source-resource-id "resource-id"

Paramètres obligatoires

--consumer-group-name

Nom du groupe de consommateurs du hub iot qui contient les partitions à partir desquelles les événements seront lus.

--environment-name

Nom de l’environnement time Series Recommandations associé au groupe de ressources spécifié.

--event-source-name --name -n

Nom de la source d’événement Time Series Recommandations associée à l’environnement spécifié.

--event-source-resource-id --resource-id

ID de ressource de la source d’événement dans Azure Resource Manager.

--iot-hub-name

Nom du hub iot.

--key-name --shared-access-policy-name

Nom de la clé de stratégie d’accès partagé qui accorde au service Time Series Recommandations l’accès au hub iot. Cette clé de stratégie d’accès partagé doit accorder des autorisations « service connect » au hub iot.

--location -l

Emplacement. Valeurs provenant de : az account list-locations. Vous pouvez configurer le lieu par défaut en utilisant az configure --defaults location=<location>.

--resource-group -g

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

--shared-access-key

Valeur de la clé de stratégie d’accès partagé qui accorde au service Time Series Recommandations un accès en lecture au hub iot. Cette propriété n’est pas affichée dans les réponses à la source d’événements.

Paramètres facultatifs

--local-timestamp

Objet qui représente la propriété timestamp locale. Il contient le format d’horodatage local qui doit être utilisé et les informations de décalage de fuseau horaire correspondantes. Si une valeur n’est pas spécifiée pour localTimestamp ou si null, l’horodatage local n’est pas entré avec les événements. Valeur attendue : json-string/@json-file.

--tags

Balises séparées par l’espace : key[=value] [key[=value] ...]. Utilisez « » pour effacer les balises existantes.

--timestamp-property-name --ts-property-name

Propriété de l’événement qui sera utilisée comme horodateur de la source de l’événement. Si aucune valeur n’est spécifiée pour timestampPropertyName, ou si la valeur Null ou une chaîne vide est spécifiée, l’heure de création de l’événement sera utilisée.

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 tsi event-source iothub update

Mettez à jour une source d’événement dans l’environnement spécifié.

az tsi event-source iothub update [--environment-name]
                                  [--event-source-name]
                                  [--ids]
                                  [--local-timestamp]
                                  [--resource-group]
                                  [--shared-access-key]
                                  [--subscription]
                                  [--tags]
                                  [--timestamp-property-name]

Exemples

UpdateIotHubEventSource

az tsi event-source iothub update -g "rg" --environment-name "env1" --name "eventsource"  --timestamp-property-name timestampProp --shared-access-key "someSecretvalue" --tags test=tag

Paramètres facultatifs

--environment-name

Nom de l’environnement time Series Recommandations associé au groupe de ressources spécifié.

--event-source-name --name -n

Nom de la source d’événement Time Series Recommandations associée à l’environnement spécifié.

--ids

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

--local-timestamp

Objet qui représente la propriété timestamp locale. Il contient le format d’horodatage local qui doit être utilisé et les informations de décalage de fuseau horaire correspondantes. Si une valeur n’est pas spécifiée pour localTimestamp ou si null, l’horodatage local n’est pas entré avec les événements. Valeur attendue : json-string/@json-file.

--resource-group -g

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

--shared-access-key

Valeur de la clé de stratégie d’accès partagé qui accorde au service Time Series Recommandations un accès en lecture au hub iot. Cette propriété n’est pas affichée dans les réponses à la source d’événements.

--subscription

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

--tags

Balises séparées par l’espace : key[=value] [key[=value] ...]. Utilisez « » pour effacer les balises existantes.

--timestamp-property-name --ts-property-name

Propriété de l’événement qui sera utilisée comme horodateur de la source de l’événement. Si aucune valeur n’est spécifiée pour timestampPropertyName, ou si la valeur Null ou une chaîne vide est spécifiée, l’heure de création de l’événement sera utilisée.

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.