Azure Time Series Insights Gen2-modell-API:er

  • Artikel

Översikt

Var och en av de tre komponenter som skapar en Time Series-modell (instanser, hierarkier och typer) har motsvarande REST-API:er som stöder åtgärderna CREATE, READ, UPDATE och DELETE, sidnumrerade och/eller batchåtgärder.

  • Instans-API:et stöder sidnumrerade GET-åtgärder, batchåtgärderna CREATE, READ, UPDATE och DELETE, sök- och nyckelordsförslag för sökåtgärder.
  • Hierarki-API:et stöder sidnumrerade GET-åtgärder och batchåtgärderna CREATE, READ, UPDATE och DELETE.
  • Typ-API:et stöder sidnumrerade GET-åtgärder och batchåtgärderna CREATE, READ, UPDATE och DELETE.

Ett fjärde API ger REST-stöd för Time Series Model-inställningar:

  • API:et för modellinställningar stöder HTTP GET- och UPDATE-åtgärder för konfigurationsinställningar för Time Series Model. Läs Time Series Model för detaljerad information om Time Series Model och instanser, hierarki och typdefinitioner .

Instans-API

Med INstans-API:et kan åtgärderna CREATE, READ, UPDATE och DELETE utföras på Time Series-instanser:

  • API:et Get Instances returnerar alla Time Series-instanser som matchar begäran.

  • API:et Hantera instanser aktiverar batchåtgärder på instanser. Alla åtgärder mot det här API:et är HTTP POST-åtgärder . Varje åtgärd accepterar en nyttolast. Nyttolasten är ett JSON-objekt. Det här objektet definierar en enda egenskap. Egenskapsnyckeln är namnet på en åtgärd som tillåts av API:et. Åtgärder som stöds är PUT, UPDATE och DELETE.

  • Dessa API:er aktiverar identifiering av Time Series-instanser:

    • Föreslå aktiverar autocomplete-scenarier när du söker efter en instans.
    • Sökning hjälper till att identifiera instanserna baserat på de nyckelord som tillhandahålls.

    Tips

    Läs mer om sökfrågefunktionerna nedan.

API för hierarkier

Api:et Hierarkier aktiverar CREATE, READ, UPDATE och DELETE i Tidsseriehierarkier.

API Beskrivning
Hämta API för hierarkier Returnerar alla Tidsseriehierarkier som matchar begäran.
Hantera API:er för hierarkier Aktiverar batchåtgärder i hierarkier. Alla åtgärder mot det här API:et är HTTP POST-åtgärder . Varje åtgärd accepterar en nyttolast. Nyttolasten är ett JSON-objekt. Det här objektet definierar en enda egenskap. Egenskapsnyckeln är namnet på en åtgärd som API:et tillåter. Åtgärder som stöds är PUT, UPDATE och DELETE.

Api för typer

Api:et Types aktiverar CREATE, READ, UPDATE och DELETE på Time Series Types och deras associerade variabler.

API Beskrivning
Api för att hämta typer Returnerar alla Typer av tidsserier och deras associerade variabler.
API för eftertyper Aktiverar batchåtgärder på typer. Alla åtgärder mot det här API:et är HTTP POST-åtgärder . Varje åtgärd accepterar en nyttolast. Nyttolasten är ett JSON-objekt. Det här objektet definierar en enda egenskap. Egenskapsnyckeln är namnet på en åtgärd som API:et tillåter. Åtgärder som stöds är PUT, UPDATE och DELETE.

API för modellinställningar

API:et för modellinställningar aktiverar CREATE, READ, UPDATE och DELETE på automatiskt skapade modeller i miljön av TimeSeriesIds.

API Beskrivning
Hämta API för modellinställningar Returnerar den automatiskt skapade modellen i miljön för TimeSeriesIds.
UPPDATERA API:et för modellinställningar Uppdateringar modellen i miljön för TimeSeriesIds med de nya värdena som anges i begäran.

Sökfunktioner

Jokerteckensökningar

Vi stöder sökningar med jokertecken med en och flera tecken i enkla termer (inte inom frassökningar).

Enstaka tecken

Använd symbolen för ? att utföra en jokerteckensökning med ett tecken. Sökningen med jokertecken med ett tecken letar efter termer som matchar strängen med det enstaka tecknet ersatt.

Om du vill söka efter antingen text eller testsöker du: te?t.

Flera tecken

Om du vill utföra en jokerteckensökning med flera tecken använder du symbolen * . Sökningar med jokertecken med flera tecken letar efter noll eller fler tecken.

Om du vill söka efter test, testseller tester, använder du sökningen: test*.

Du kan också använda jokerteckensökningarna mitt i en term. Om du vill söka efter dryerkan du använda sökningen: dr*r.

Booleska operatorer

Booleska operatorer tillåter att termer kombineras via logikoperatorer. Vi stöder AND, OR, +, -och NOT som booleska operatorer.

Viktigt

  • Booleska operatorer måste vara i ALLA CAPS.
  • Booleska operatorer måste separeras från söksatser med blanksteg.
  • dryer AND washer är giltigt men inte dryer ANDwasher.

AND-operator

OPERATORN AND matchar dokument där båda termerna finns var som helst i texten i ett enda dokument.

Så här söker du efter dokument som innehåller dryer washer och foo bar använder sökningen: dryer washer AND foo bar.

Anteckning

Symbolen && kan användas i stället för operatorn AND.

OR-operator

OPERATORN OR länkar två termer och hittar ett matchande dokument om något av termerna finns i ett dokument. OR-operatorn är standardkonjunktionsoperatorn. Det innebär att om det inte finns någon boolesk operator mellan två termer används OR-operatorn.

Om du vill söka efter dokument som innehåller antingen dryer washer eller bara dryer använda någon av följande sökningar:

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

Anteckning

Symbolen || kan användas i stället för operatorn OR.

+ Operator

Operatorn + eller den obligatoriska operatorn kräver att termen efter symbolen + finns någonstans i ett fält i ett enda dokument.

Om du vill söka efter dokument som måste innehålla dryer och kan innehålla washer använder du sökningen: +dryer washer.

-Operatör

Operatorn - eller förhindra utesluter dokument som innehåller termen efter symbolen - .

Om du vill söka efter dokument som innehåller dryer washer men inte foo bar använder sökningen: dryer washer -foo bar.

NOT

Operatorn NOT undantar dokument som innehåller termen efter NOT.

Om du vill söka efter dokument som innehåller dryer washer men inte foo bar använder sökningen: dryer washer NOT foo bar.

Operatorn NOT kan inte användas med bara en term.

Följande sökning returnerar inga resultat: NOT dryer washer.

Anteckning

Symbolen ! kan användas i stället för operatorn NOT.

  • Den måste omedelbart föregå den undantagna söktermen.
  • dryer !washer är giltigt men inte dryer ! washer.

Se även

  • Mer information om programregistrering och Azure Active Directory-programmeringsmodellen finns i Azure Active Directory för utvecklare.

  • Mer information om parametrar för begäran och autentisering finns i Autentisering och auktorisering.

  • Verktyg som hjälper dig att testa HTTP-begäranden och svar är:

  • Fiddler. Den här kostnadsfria webbfelsökningsproxyn kan fånga upp dina REST-begäranden, så att du kan diagnostisera HTTP-begäranden och svarsmeddelanden.

  • JWT.io. Du kan använda det här verktyget för att snabbt dumpa anspråken i ägartoken och sedan verifiera innehållet.

  • Postman. Det här är ett kostnadsfritt testverktyg för HTTP-begäran och svar för felsökning av REST-API:er.

  • Läs mer om Azure Time Series Insights Gen2 i Gen2-dokumentationen.