Freigeben über


Azure Time Series Insights Gen2-Modell-APIs

Überblick

Jede der drei Komponenten, aus denen ein Zeitreihenmodell besteht (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-Operationen, Batch-CREATE-, READ-, UPDATE- und DELETE-Operationen, Such- und Schlüsselwortvorschläge für Suchvorgänge.
  • Die Hierarchie-API unterstützt paginierte GET-Vorgänge und Batchvorgänge CREATE,READ,UPDATE undDELETE .
  • Die Typ-API unterstützt paginierte GET-Vorgänge und Batchvorgänge vom Typ CREATE,READ,UPDATE undDELETE .

Eine vierte API bietet REST-Unterstützung für Einstellungen des Zeitreihenmodells:

  • Die Modelleinstellungs-API unterstützt HTTP GET - und UPDATE-Vorgänge für Konfigurationseinstellungen für Zeitreihenmodelle. Unter Zeitreihenmodell finden Sie ausführliche Informationen zu Zeitreihenmodell- und Instanz-, Hierarchie- und Typdefinitionen.

Instanzen-API

Mit der Instanzen-API können CREATE-, READ-, UPDATE- und DELETE-Vorgänge für Zeitreiheninstanzen ausgeführt werden:

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

  • Die Manage Instances API ermöglicht Batch-Vorgänge für Instances. Alle Vorgänge für diese API sind HTTP POST-Vorgänge . Jeder Vorgang akzeptiert eine Nutzlast. Bei der Nutzlast handelt es sich um ein JSON-Objekt. Dieses Objekt definiert eine einzelne Eigenschaft. Der Eigenschaftsschlüssel ist der Name eines Vorgangs, der von der API zugelassen wird. Unterstützte Vorgänge sind PUT, UPDATE und DELETE.

  • Diese APIs ermöglichen die Ermittlung von Zeitreiheninstanzen:

    • Suggest aktiviert die automatische Vervollständigung von Szenarien bei der Suche nach einer Instanz.
    • Die Suche hilft bei der Identifizierung der Instanzen anhand der bereitgestellten Schlüsselwörter.

    Tipp

    Lesen Sie weiter unten mehr über die Funktionen für Suchanfragen .

Hierarchien-API

Die Hierarchien-API ermöglicht CREATE,READ,UPDATE und DELETE für Zeitreihenhierarchien.

Programmierschnittstelle (API) BESCHREIBUNG
Abrufen der Hierarchien-API Gibt alle Zeitreihenhierarchien zurück, die mit der Anforderung übereinstimmen.
Verwalten von Hierarchien-APIs Ermöglicht Batchvorgänge für Hierarchien. Alle Vorgänge für diese API sind HTTP POST-Vorgänge . Jeder Vorgang akzeptiert eine Nutzlast. Bei der Nutzlast handelt es sich um ein JSON-Objekt. Dieses Objekt definiert eine einzelne Eigenschaft. Der Eigenschaftsschlüssel ist der Name eines Vorgangs, den die API zulässt. Unterstützte Vorgänge sind PUT, UPDATE und DELETE.

Typen-API

Die Types-API ermöglicht CREATE,READ,UPDATE und DELETE für Zeitreihentypen und die zugehörigen Variablen.

Programmierschnittstelle (API) BESCHREIBUNG
API zum Abrufen von Typen Gibt alle Zeitreihentypen und die zugehörigen Variablen zurück.
Beitragstypen-API Ermöglicht Batchvorgänge für Typen. Alle Vorgänge für diese API sind HTTP POST-Vorgänge . Jeder Vorgang akzeptiert eine Nutzlast. Bei der Nutzlast handelt es sich um ein JSON-Objekt. Dieses Objekt definiert eine einzelne Eigenschaft. Der Eigenschaftsschlüssel ist der Name eines Vorgangs, den die API zulässt. Unterstützte Vorgänge sind PUT, UPDATE und DELETE.

API für Modelleinstellungen

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

Programmierschnittstelle (API) BESCHREIBUNG
Abrufen der API für Modelleinstellungen Gibt das automatisch erstellte Modell in der Umgebung für TimeSeriesIds zurück.
Aktualisieren der API für Modelleinstellungen Aktualisiert das Modell in der Umgebung für TimeSeriesIds mit den neuen Werten, die in der Anforderung bereitgestellt werden.

Suchfunktionen

Platzhaltersuchen

Wir unterstützen die Suche nach ein- und mehrstelligen Platzhaltern innerhalb einzelner Begriffe (nicht innerhalb der Ausdruckssuche).

Einzelnes Zeichen

Um eine Platzhaltersuche mit einem einzelnen Zeichen durchzuführen, verwenden Sie das ? Symbol. Bei der Suche nach Platzhaltern mit nur einem Zeichen wird nach Begriffen gesucht, die mit der Zeichenfolge übereinstimmen, wobei das einzelne Zeichen ersetzt wurde.

Um nach entweder text oder testzu suchen, suchen Sie: te?t.

Mehrere Zeichen

Um eine Platzhaltersuche mit mehreren Zeichen durchzuführen, verwenden Sie das * Symbol. Bei der Suche nach Platzhaltern mit mehreren Zeichen wird nach null oder mehr Zeichen gesucht.

Um nach test, oder testerzu suchen, testsverwenden Sie die Suche: test*.

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

Boolesche Operatoren

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

Von Bedeutung

  • Boolesche Operatoren müssen in GROSSBUCHSTABEN angegeben werden.
  • Boolesche Operatoren müssen durch Leerzeichen von Suchbegriffen getrennt werden.
  • dryer AND washer ist gültig, aber nicht dryer ANDwasher.

AND-Operator

Der UND-Operator stimmt mit Dokumenten überein, bei denen beide Begriffe an einer beliebigen 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 sucht ein übereinstimmendes Dokument, wenn einer der Begriffe in einem Dokument vorhanden ist. Der OR-Operator ist der Standard-Konjunktionsoperator. Das bedeutet, dass der ODER-Operator verwendet wird, wenn zwischen zwei Begriffen kein boolescher Operator steht.

Um nach Dokumenten zu suchen, 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 Operators ODER verwendet werden.

+ Bediener

Der + Operator or required erfordert, dass der Begriff nach dem + Symbol an einer beliebigen Stelle in einem Feld eines einzelnen Dokuments vorhanden ist.

Um nach Dokumenten zu suchen, die enthalten dryer müssen 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 Begriff 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 dem ausgeschlossenen Suchbegriff unmittelbar vorangestellt werden.
  • dryer !washer ist gültig, aber nicht dryer ! washer.

Siehe auch

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

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

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

  • Geiger. Dieser kostenlose Web-Debugging-Proxy kann Ihre REST-Anforderungen abfangen, sodass Sie die HTTP-Anforderungs- und 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.

  • Postbote. Hierbei handelt es sich um ein kostenloses Tool zum Testen von HTTP-Anfragen und -Antworten zum Debuggen von REST-APIs.

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