Freigeben über

Azure Time Series Insights Gen2-Modell-APIs

  • Artikel

Übersicht

Jede der drei Komponenten, die ein Zeitreihenmodell erstellen (Instanzen, Hierarchien und Typen), verfügt über entsprechende REST-APIs, die CREATE-, READ-, UPDATE- und DELETE-, paginierte und/oder Batchvorgänge unterstützen.

  • Die Instanz-API unterstützt paginierte GET-Vorgänge, Batchvorgänge CREATE, READ, UPDATE und DELETE, Suche und Schlüsselwort (keyword) Vorschläge für Suchvorgänge.
  • Die Hierarchie-API unterstützt paginierte GET-Vorgänge und Batchvorgänge CREATE, READ, UPDATE und DELETE .
  • Die Typ-API unterstützt paginierte GET-Vorgänge und Batchvorgänge CREATE, READ, UPDATE und DELETE .

Eine vierte API bietet REST-Unterstützung für Zeitreihenmodelleinstellungen:

  • Die Modelleinstellungen-APIunterstützt HTTP GET - und UPDATE-Vorgänge für Zeitreihenmodellkonfigurationseinstellungen. Ausführliche Informationen zu Zeitreihenmodell und instance, Hierarchie- und Typdefinitionen finden Sie unter Zeitreihenmodell.

Instanzen-API

Die Instanzen-API ermöglicht die Ausführung von CREATE-, READ-, UPDATE- und DELETE-Vorgängen für Time Series-Instanzen:

  • Die Get Instances-API gibt alle Time Series Instances zurück, die der Anforderung entsprechen.

  • Die API "Instanzen verwalten " ermöglicht Batchvorgänge für Instanzen. Alle Vorgänge für diese API sind HTTP POST-Vorgänge . Jeder Vorgang akzeptiert eine Nutzlast. Die Nutzlast ist ein JSON-Objekt. Dieses Objekt definiert eine einzelne Eigenschaft. Der Eigenschaftenschlüssel ist der Name eines Vorgangs, der von der API zulässig ist. Unterstützte Vorgänge sind PUT, UPDATE und DELETE.

  • Diese APIs ermöglichen die Ermittlung von Time Series Instances:

    • Suggest aktiviert Szenarien mit automatischer Vervollständigung bei der Suche nach einem instance.
    • Die Suche hilft bei der Identifizierung der Instanzen anhand der bereitgestellten Schlüsselwörter.

    Tipp

    Weitere Informationen zu Suchabfragefeatures finden Sie unten.

Hierarchien-API

Die Hierarchie-API aktiviert CREATE, READ, UPDATE und DELETE für Zeitreihenhierarchien.

API BESCHREIBUNG
Api zum Abrufen von Hierarchien Gibt alle Zeitreihenhierarchien zurück, die der Anforderung entsprechen.
Verwalten von Hierarchien-APIs Aktiviert Batchvorgänge für Hierarchien. Alle Vorgänge für diese API sind HTTP POST-Vorgänge . Jeder Vorgang akzeptiert eine Nutzlast. Die Nutzlast ist ein JSON-Objekt. Dieses Objekt definiert eine einzelne Eigenschaft. Der Eigenschaftenschlüssel ist der Name eines Vorgangs, den die API zulässt. Unterstützte Vorgänge sind PUT, UPDATE und DELETE.

Typen-API

Die Typen-API aktiviert CREATE, READ, UPDATE und DELETE für Zeitreihentypen und die zugehörigen Variablen.

API BESCHREIBUNG
Get Types-API Gibt alle Zeitreihentypen und die zugehörigen Variablen zurück.
Post types-API Aktiviert Batchvorgänge für Typen. Alle Vorgänge für diese API sind HTTP POST-Vorgänge . Jeder Vorgang akzeptiert eine Nutzlast. Die Nutzlast ist ein JSON-Objekt. Dieses Objekt definiert eine einzelne Eigenschaft. Der Eigenschaftenschlüssel ist der Name eines Vorgangs, den die API zulässt. Unterstützte Vorgänge sind PUT, UPDATE und DELETE.

MODELLEINSTELLUNGEN-API

Die Modelleinstellungen-API aktiviert CREATE, READ, UPDATE und DELETE für automatisch erstellte Modelle in der Umgebung durch TimeSeriesIds.

API BESCHREIBUNG
API für Modelleinstellungen abrufen Gibt das automatisch erstellte Modell in der Umgebung für TimeSeriesIds zurück.
API für Modelleinstellungen aktualisieren Updates das Modell in der Umgebung für TimeSeriesIds mit den neuen Werten, die in der Anforderung bereitgestellt werden.

Suchfunktionen

Platzhaltersuchen

Wir unterstützen Ein- und Mehrzeichenplatzhaltersuche innerhalb einzelner Begriffe (nicht innerhalb von Ausdruckssuchen).

Ein einzelnes Zeichen

Verwenden Sie das ? Symbol, um eine Einzelzeichensuche durchzuführen. Die Platzhaltersuche für einzelzeichen sucht nach Begriffen, die der Zeichenfolge mit dem ersetzten Einzelzeichen entsprechen.

Um nach oder texttestzu suchen, suchen Sie: te?t.

Mehrere Zeichen

Verwenden Sie das * Symbol, um eine Wildcardsuche mit mehreren Zeichen durchzuführen. Bei der Suche nach mehreren Zeichenplatzhaltern werden null oder mehr Zeichen gesucht.

Um nach , oder zu suchentest, verwenden Sie die Suche: test*.testertests

Sie können die Feldhaltersuchen auch in der Mitte eines Begriffs verwenden. Um nach zu suchen dryer, können Sie die Suche verwenden: dr*r.

Boolesche Operatoren

Boolesche Operatoren ermöglichen die Kombination von Begriffen durch Logikoperatoren. Wir unterstützen AND, OR, +, -und NOT als boolesche Operatoren.

Wichtig

  • Boolesche Operatoren müssen in ALL CAPS vorhanden sein.
  • Boolesche Operatoren müssen durch Leerzeichen von Suchklauseln getrennt werden.
  • dryer AND washer ist gültig, aber nicht dryer ANDwasher.

AND-Operator

Der AND-Operator gleicht Dokumente ab, in denen beide Begriffe an beliebiger Stelle im Text eines einzelnen Dokuments vorhanden sind.

So suchen Sie nach Dokumenten, die die Suche enthalten dryer washer und foo bar verwenden: dryer washer AND foo bar.

Hinweis

Das Symbol && kann anstelle des Operators AND verwendet werden.

OR-Operator

Der OR-Operator verknüpft zwei Begriffe und findet ein übereinstimmende Dokument, wenn einer der Begriffe in einem Dokument vorhanden ist. Der OR-Operator ist der Standard-Konjunktionsoperator. Dies bedeutet, dass der OR-Operator verwendet wird, wenn zwischen zwei Begriffen kein boolescher Operator vorhanden ist.

So suchen Sie nach Dokumenten, die eine dryer washer der folgenden Suchvorgänge enthalten, oder verwenden Sie einfach dryer eine der folgenden Suchvorgänge:

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

Hinweis

Das Symbol || kann anstelle des Operator OR verwendet werden.

Operator +

Der + oder erforderliche Operator erfordert, dass der Ausdruck nach dem + Symbol irgendwo in einem Feld eines einzelnen Dokuments vorhanden ist.

Um nach Dokumenten zu suchen, die enthalten müssen dryer und enthalten washer können, verwenden Sie die Suche: +dryer washer.

Operator -

Der - operator or prohibit schließt Dokumente aus, die den Begriff nach dem - Symbol enthalten.

So suchen Sie nach Dokumenten, die die Suche enthalten dryer washer , aber nicht foo bar verwenden: dryer washer -foo bar.

NICHT

Der NOT-Operator schließt Dokumente aus, die den Ausdruck nach NOTenthalten.

So suchen Sie nach Dokumenten, die die Suche enthalten dryer washer , aber nicht foo bar verwenden: dryer washer NOT foo bar.

Der NOT-Operator kann nicht mit nur einem Begriff verwendet werden.

Die folgende Suche gibt keine Ergebnisse zurück: NOT dryer washer.

Hinweis

Das Symbol ! kann anstelle des Operators NOT verwendet werden.

  • Er muss sofort dem ausgeschlossenen Suchbegriff vorangestellt werden.
  • dryer !washer ist gültig, aber nicht dryer ! washer.

Weitere Informationen

  • Weitere Informationen zur Anwendungsregistrierung und zum Azure Active Directory-Programmiermodell finden Sie unter Azure Active Directory für Entwickler.

  • Informationen zu Anforderungs- und Authentifizierungsparametern finden Sie unter Authentifizierung und Autorisierung.

  • Zu den Tools, die beim Testen von HTTP-Anforderungen und -Antworten helfen, gehören:

  • Fiddler. Dieser kostenlose Webdebuggingproxy kann Ihre REST-Anforderungen abfangen, sodass Sie die HTTP-Anforderung und Die Antwortnachrichten diagnostizieren können.

  • JWT.io. Sie können dieses Tool verwenden, um die Ansprüche schnell in Ihrem Bearertoken zu speichern und dann ihren Inhalt zu überprüfen.

  • Postman. Dies ist ein kostenloses HTTP-Anforderungs- und Antworttesttool zum Debuggen von REST-APIs.

  • Weitere Informationen zu Azure Time Series Insights Gen2 finden Sie in der Gen2-Dokumentation.