API de modèle Azure Time Series Insights Gen2

Vue d’ensemble

Chacun des trois composants qui créent un modèle de série chronologique (instances, hiérarchies et types) a des API REST correspondantes qui prennent en charge les opérations CREATE, READ, UPDATE et DELETE, paginés et/ou batch.

  • L’API Instance prend en charge les opérations GET paginés, les opérations CREATE, READ, UPDATE et DELETE, la recherche et les suggestions de mots clés pour les opérations de recherche.
  • L’API Hierarchy prend en charge les opérations GET paginés et les opérations CREATE, READ, UPDATE et DELETE paginés.
  • L’API Type prend en charge les opérations GET paginés et les opérations CREATE, READ, UPDATE et DELETE paginés.

Une quatrième API fournit la prise en charge REST des paramètres de modèle Time Series :

  • L’API Model Paramètres prend en charge les opérations HTTP GET et UPDATE pour les paramètres de configuration du modèle de série chronologique. Lisez le modèle de série chronologique pour obtenir des informations détaillées sur les définitions de modèle, dehiérarchie et de type time Series Model.

Instances API

L’API Instances permet d’effectuer des opérations CREATE, READ, UPDATE et DELETE sur les instances time series :

  • L’API Get Instances retourne toutes les instances Time Series qui correspondent à la demande.

  • L’API Gérer les instances active les opérations de traitement par lots sur les instances. Toutes les opérations sur cette API sont des opérations HTTP POST . Chaque opération accepte une charge utile. La charge utile est un objet JSON. Cet objet définit une propriété unique. La clé de propriété est le nom d’une opération autorisée par l’API. Les opérations prises en charge sont PUT, UPDATE et DELETE.

  • Ces API permettent la découverte d’instances Time Series :

    • Suggest active les scénarios de saisie semi-automatique lors de la recherche d’une instance.
    • La recherche permet d’identifier les instances en fonction des mots clés fournis.

    Conseil

    Découvrez les fonctionnalités de requête de recherche ci-dessous.

API Hiérarchies

L’API Hiérarchies active CREATE, READ, UPDATE et DELETE sur les hiérarchies de série chronologique.

API Description
Api Obtenir des hiérarchies Retourne toutes les hiérarchies Time Series qui correspondent à la requête.
Gérer les API de hiérarchies Active les opérations de traitement par lots sur les hiérarchies. Toutes les opérations sur cette API sont des opérations HTTP POST . Chaque opération accepte une charge utile. La charge utile est un objet JSON. Cet objet définit une propriété unique. La clé de propriété est le nom d’une opération autorisée par l’API. Les opérations prises en charge sont PUT, UPDATE et DELETE.

Types API

L’API Types active CREATE, READ, UPDATE et DELETE sur les types de série chronologique et leurs variables associées.

API Description
API Obtenir des types Retourne tous les types de série chronologique et leurs variables associées.
Post Types API Active les opérations de traitement par lots sur les types. Toutes les opérations sur cette API sont des opérations HTTP POST . Chaque opération accepte une charge utile. La charge utile est un objet JSON. Cet objet définit une propriété unique. La clé de propriété est le nom d’une opération autorisée par l’API. Les opérations prises en charge sont PUT, UPDATE et DELETE.

API model Paramètres

L’API Model Paramètres active CREATE, READ, UPDATE et DELETE sur les modèles créés automatiquement dans l’environnement par TimeSeriesIds.

API Description
Obtenir l’API Model Paramètres Retourne le modèle créé automatiquement dans l’environnement pour TimeSeriesIds.
Mettre à jour l’API model Paramètres Met à jour le modèle dans l’environnement pour TimeSeriesIds avec les nouvelles valeurs fournies dans la requête.

Fonctionnalités de recherche

Recherches par caractères génériques

Nous prenons en charge les recherches à caractères génériques uniques et multiples dans des termes uniques (et non dans les recherches d’expressions).

Caractère unique

Pour effectuer une recherche à caractère générique unique, utilisez le ? symbole. La recherche à caractère générique à caractère unique recherche des termes qui correspondent à la chaîne avec le caractère unique remplacé.

Pour rechercher l’un ou l’autre text , testrecherchez : te?t.

Plusieurs caractères

Pour effectuer une recherche à plusieurs caractères génériques, utilisez le * symbole. Plusieurs caractères génériques recherchent zéro ou plusieurs caractères.

Pour rechercher test, testsou testerutiliser la recherche : test*.

Vous pouvez également utiliser les recherches génériques au milieu d’un terme. Pour rechercher dryer, vous pouvez utiliser la recherche : dr*r.

Opérateurs booléens

Les opérateurs booléens permettent de combiner des termes par le biais d’opérateurs logiques. Nous prenons en charge AND, OR, +et -NOT en tant qu’opérateurs booléens.

Important

  • Les opérateurs booléens doivent être dans ALL CAPS.
  • Les opérateurs booléens doivent être séparés des clauses de recherche à l’aide d’espaces blancs.
  • dryer AND washer est valide, mais pas dryer ANDwasher.

AND, opérateur

L’opérateur AND correspond aux documents où les deux termes existent n’importe où dans le texte d’un seul document.

Pour rechercher des documents contenant dryer washer et foo bar utiliser la recherche : dryer washer AND foo bar.

Notes

Le symbole && peut être utilisé à la place de l’opérateur AND.

OPÉRATEUR OR

L’opérateur OR lie deux termes et trouve un document correspondant si l’un des termes existe dans un document. L’opérateur OR est l’opérateur de conjonction par défaut. Cela signifie qu’en l’absence d’opérateur booléen entre deux termes, l’opérateur OR est utilisé.

Pour rechercher des documents contenant l’une dryer washer ou l’autre dryer des recherches suivantes :

  1. 'dryer washer' dryer
  2. 'dryer washer' OR dryer

Notes

Le symbole || peut être utilisé à la place de l’opérateur OR.

+, opérateur

L’opérateur + ou obligatoire exige que le terme après le + symbole existe quelque part dans un champ d’un document unique.

Pour rechercher des documents qui doivent contenir et qui peuvent contenir dryerwasher l’utilisation de la recherche : +dryer washer.

-, opérateur

L’opérateur - ou interdit exclut les documents qui contiennent le terme après le - symbole.

Pour rechercher des documents qui contiennent dryer washer , mais qui n’utilisent pas foo bar la recherche : dryer washer -foo bar.

NOT

L’opérateur NOT exclut les documents qui contiennent le terme après NOT.

Pour rechercher des documents qui contiennent dryer washer , mais qui n’utilisent pas foo bar la recherche : dryer washer NOT foo bar.

L’opérateur NOT ne peut pas être utilisé avec un seul terme.

La recherche suivante ne retourne aucun résultat : NOT dryer washer.

Notes

Le symbole ! peut être utilisé à la place de l’opérateur NOT.

  • Il doit immédiatement précéder le terme de recherche exclu.
  • dryer !washer est valide, mais pas dryer ! washer.

Voir aussi

  • Pour plus d’informations sur l’inscription des applications et le modèle de programmation Azure Active Directory, consultez Azure Active Directory pour les développeurs.

  • Pour en savoir plus sur les paramètres de requête et d’authentification, lisez l’authentification et l’autorisation.

  • Les outils qui aident à tester les requêtes et réponses HTTP sont les suivants :

  • Fiddler. Ce proxy de débogage web gratuit peut intercepter vos requêtes REST. Vous pouvez donc diagnostiquer les messages de requête et de réponse HTTP.

  • JWT.io. Vous pouvez utiliser cet outil pour vider rapidement les revendications dans votre jeton de porteur, puis valider leur contenu.

  • Postman. Il s’agit d’un outil de test de requête et de réponse HTTP gratuit pour le débogage des API REST.

  • En savoir plus sur Azure Time Series Insights Gen2 en consultant la documentation Gen2.