Partager via

Interrogation des données à partir d’Azure Time Series Insights Gen2

  • Article

Remarque

Le service Time Series Insights va être mis hors service le 7 juillet 2024. Prévoyez de migrer les environnements existants vers des solutions alternatives dès que possible. Pour plus d’informations sur la dépréciation et la migration, consultez notre documentation.

Azure Time Series Insights Gen2 permet d’interroger les données sur les événements et les métadonnées stockées dans l’environnement via des API de surface publiques. Ces API sont également utilisées par l’explorateur Azure Time Series Insights TSI.

Trois catégories principales d’API sont disponibles dans Azure Time Series Insights Gen2 :

  • API d’environnement : ces API activent les requêtes sur l’environnement Azure Time Series Insights Gen2 proprement dit. Elles peuvent être utilisées pour recueillir la liste des environnements auxquels l’appelant a accès et les métadonnées de l’environnement.
  • API modèle-requête de série chronologique (TSM-Q) : active des opérations CRUD (créer, lire, mettre à jour et supprimer) sur les métadonnées stockées dans le modèle de série chronologique de l’environnement. Celles-ci peuvent être utilisées pour accéder aux instances, types et hiérarchies, et les modifier.
  • API TSQ (Time Series Query) : permet la récupération des données de télémétrie ou d’événements, au fur et à mesure de leur enregistrement à partir du fournisseur source, tout en permettant des calculs performants et des agrégations sur les données à l’aide de fonctions scalaires et d’agrégation avancées.

Azure Time Series Insights Gen2 utilise un langage d’expression enrichi basé sur des chaînes, Time Series Expression (TSX), pour exprimer des calculs en variables de série chronologique.

Présentation des API d’Azure Time Series Insights Gen2

Les API principales suivantes sont prises en charge.

Vue d'ensemble de la requête de série chronologique

API d’environnement

  • API Obtenir les environnements : retourne la liste des environnements auxquels l’appelant est autorisé à accéder.
  • API Obtenir la disponibilité des environnements : retourne la distribution du nombre d’événements au cours du timestamp $ts de l’événement. Cette API permet de déterminer s’il s’est produit des événements dans l’environnement en renvoyant le nombre d’événements scindés en intervalles de temps, le cas échéant.
  • Obtenir une API Schéma d’événement : retourne les métadonnées du schéma d’événement pour une période de recherche donnée. Cette API permet de récupérer toutes les métadonnées et propriétés disponibles dans le schéma sur une période définie.

API modèle-requête de série chronologique (TSM-Q)

La plupart de ces API prennent en charge l’opération d’exécution par lot pour activer les opérations CRUD par lot sur plusieurs entités de modèle Time Series :

  • API Paramètres du modèle : active GET et PATCH sur le type par défaut et le nom du modèle de l’environnement.
  • API Types : active CRUD sur les types de série chronologique et leurs variables associées.
  • API Hiérarchies: active les opérations CRUD sur les hiérarchies de série chronologique et leurs chemins de champ associés.
  • API d’instances : active CRUD sur les instances de série chronologique et leurs champs d’instance associés. En outre, l’API Instances prend en charge les opérations suivantes :
    • Recherche : récupère une liste partielle des résultats d’une recherche d’instances de série chronologique en fonction des attributs de l’instance.
    • Suggérer : recherche et suggère une liste partielle des résultats d’une recherche d’instances de série chronologique en fonction des attributs de l’instance.

API de requête de série chronologique (TSQ)

Ces API sont disponibles dans les deux magasins (chaud et froid) de notre solution de stockage multicouche.

  • API Obtenir des événements : permet l’interrogation et l’extraction d’événements bruts et des timestamps d’événements associés tels qu’ils sont enregistrés dans Azure Time Series Insights Gen2 à partir du fournisseur de source. Cette API permet de récupérer des événements bruts pour un ID Time Series donné et une étendue de recherche. Cette API prend en charge la pagination pour récupérer le jeu de données de réponse complet pour l’entrée sélectionnée.

    Important

    Dans le cadre des modifications à venir des règles de mise à plat et d’échappement au format JSON, les tableaux sont stockés sous le type Dynamique. Les propriétés de charge utile stockées sous ce type sont accessibles UNIQUEMENT par le biais de l’API d’extraction d’événements.

  • API Obtenir des séries : active l’interrogation et la récupération des valeurs calculées et des timestamps d’événements associés, en appliquant des calculs définis par des variables sur des événements bruts. Ces variables peuvent être définies dans le modèle Time Series ou fournies inline dans la requête. Cette API prend en charge la pagination pour récupérer le jeu de données de réponse complet pour l’entrée sélectionnée.

  • API Agréger les séries : permet l’interrogation et la récupération des valeurs agrégées, mais également des timestamps d’intervalle associés, en appliquant des calculs définis par des variables sur des événements bruts. Ces variables peuvent être définies dans le modèle Time Series ou fournies inline dans la requête. Cette API prend en charge la pagination pour récupérer le jeu de données de réponse complet pour l’entrée sélectionnée.

    Pour une étendue de recherche et un intervalle spécifiés, cette API renvoie une réponse agrégée par intervalle et par variable pour un ID de série chronologique. Le nombre d’intervalles dans le jeu de données de réponse est calculé en comptant les cycles d’époque (le nombre de millisecondes qui se sont écoulées depuis l’époque UNIX - 1er janvier 1970) et en divisant les cycles par la taille de l’intervalle de temps spécifiée dans la requête.

    Les timestamps retournés dans le jeu de réponses sont des limites de l’intervalle gauche, et non des événements échantillonnés à partir de l’intervalle.

Sélection du type de magasin

Les API ci-dessus ne peuvent s’exécuter que sur l’un des deux types de stockage (froid ou chaud) dans un seul appel. Les paramètres URL de requête permettent de spécifier le type de stockage sur lequel la requête doit s’exécuter.

Si aucun paramètre n’est spécifié, la requête est exécutée dans le stockage froid par défaut. Si une requête s’étend sur une plage de temps qui chevauche à la fois le stockage froid et le stockage chaud, il est recommandé de router la requête vers le stockage froid pour une expérience optimale, puisque le stockage chaud contient uniquement des données partielles.

L’Explorateur Time Series Insights et le connecteur Power BI effectuent des appels aux API ci-dessus et sélectionnent automatiquement le paramètre storeType approprié, si besoin.

Étapes suivantes