Time Series Types - Execute Batch

Reference

Service:: Time Series Insights

API Version:: 2020-07-31

Provede dávkovou operaci get, create, update, delete pro více typů časových řad.

POST https://{environmentFqdn}/timeseries/types/$batch?api-version=2020-07-31

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
environmentFqdn	path	True	string	Plně kvalifikovaný název domény prostředí, například 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com. Tento název domény můžete získat z odpovědi rozhraní API Get Environment, Azure Portal nebo Azure Resource Manager.
api-version	query	True	string	Verze rozhraní API, která se má použít s požadavkem klienta. Aktuálně podporovaná verze je "2020-07-31".

Hlavička požadavku

Name	Vyžadováno	Typ	Description
x-ms-client-request-id		string	Volitelné ID žádosti klienta. Služba tuto hodnotu zaznamenává. Umožňuje službě trasovat operace napříč službami a umožňuje zákazníkovi kontaktovat podporu ohledně konkrétní žádosti.
x-ms-client-session-id		string	Volitelné ID relace klienta. Služba tuto hodnotu zaznamenává. Umožňuje službě trasovat skupinu souvisejících operací mezi službami a umožňuje zákazníkovi kontaktovat podporu ohledně konkrétní skupiny žádostí.

Text požadavku

Name	Typ	Description
delete	TypesRequestBatchGetOrDelete	Definice typů časových řad, které se mají odstranit.
get	TypesRequestBatchGetOrDelete	Definice typů časových řad, které se mají vrátit.
put	TimeSeriesType[]	Definice typů časových řad, které se mají aktualizovat nebo vytvořit.

Odpovědi

Name	Typ	Description
200 OK	TypesBatchResponse	Operace byla úspěšná. Headers x-ms-request-id: string
Other Status Codes	TsiError	Neočekávaná chyba. Headers x-ms-request-id: string

Name

Typ

Description

200 OK

TypesBatchResponse

Operace byla úspěšná.

Headers

x-ms-request-id: string

Other Status Codes

TsiError

Neočekávaná chyba.

Headers

x-ms-request-id: string

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

TypesBatchDeleteByIds

TypesBatchDeleteByNames

TypesBatchGetByIds

TypesBatchGetByNames

TypesBatchPut

TypesBatchDeleteByIds

Sample Request

HTTP

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/types/$batch?api-version=2020-07-31

{
  "delete": {
    "typeIds": [
      "9250f816-faed-44c4-88e6-630e5eefa38b"
    ]
  }
}

Sample Response

Status code:: 200

{
  "delete": [
    null
  ]
}

TypesBatchDeleteByNames

Sample Request

HTTP

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/types/$batch?api-version=2020-07-31

{
  "delete": {
    "names": [
      "TemperatureSensor"
    ]
  }
}

Sample Response

Status code:: 200

{
  "delete": [
    null
  ]
}

TypesBatchGetByIds

Sample Request

HTTP

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/types/$batch?api-version=2020-07-31

{
  "get": {
    "typeIds": [
      "1be09af9-f089-4d6b-9f0b-48018b5f7393",
      "c1cb7a33-ed9b-4cf1-9958-f3162fed8ee8"
    ],
    "names": null
  }
}

Sample Response

Status code:: 200

{
  "get": [
    {
      "timeSeriesType": {
        "id": "1be09af9-f089-4d6b-9f0b-48018b5f7393",
        "name": "DefaultType",
        "description": "Default type",
        "variables": {
          "EventCount": {
            "kind": "aggregate",
            "filter": null,
            "aggregation": {
              "tsx": "count()"
            }
          }
        }
      },
      "error": null
    },
    {
      "timeSeriesType": {
        "id": "c1cb7a33-ed9b-4cf1-9958-f3162fed8ee8",
        "name": "TemperatureSensor",
        "description": "This is a temperature sensor.",
        "variables": {
          "AverageTemperature": {
            "kind": "numeric",
            "value": {
              "tsx": "$event.Temperature.Double"
            },
            "filter": null,
            "aggregation": {
              "tsx": "avg($value)"
            }
          }
        }
      },
      "error": null
    }
  ]
}

TypesBatchGetByNames

Sample Request

HTTP

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/types/$batch?api-version=2020-07-31

{
  "get": {
    "names": [
      "DefaultType",
      "TemperatureSensor"
    ]
  }
}

Sample Response

Status code:: 200

{
  "get": [
    {
      "timeSeriesType": {
        "id": "1be09af9-f089-4d6b-9f0b-48018b5f7393",
        "name": "DefaultType",
        "description": "Default type",
        "variables": {
          "EventCount": {
            "kind": "aggregate",
            "filter": null,
            "aggregation": {
              "tsx": "count()"
            }
          }
        }
      },
      "error": null
    },
    {
      "timeSeriesType": {
        "id": "c1cb7a33-ed9b-4cf1-9958-f3162fed8ee8",
        "name": "TemperatureSensor",
        "description": "This is a temperature sensor.",
        "variables": {
          "AverageTemperature": {
            "kind": "numeric",
            "value": {
              "tsx": "$event.Temperature.Double"
            },
            "filter": null,
            "aggregation": {
              "tsx": "avg($value)"
            }
          }
        }
      },
      "error": null
    }
  ]
}

TypesBatchPut

Sample Request

HTTP

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/types/$batch?api-version=2020-07-31

{
  "put": [
    {
      "id": "1be09af9-f089-4d6b-9f0b-48018b5f7393",
      "name": "DefaultType",
      "description": "My Default type",
      "variables": {
        "EventCount": {
          "kind": "aggregate",
          "filter": null,
          "aggregation": {
            "tsx": "count()"
          }
        }
      }
    },
    {
      "id": "c1cb7a33-ed9b-4cf1-9958-f3162fed8ee8",
      "name": "OutdoorTemperatureSensor",
      "description": "This is an outdoor temperature sensor.",
      "variables": {
        "AverageTemperature": {
          "kind": "numeric",
          "value": {
            "tsx": "$event.Temperature.Double"
          },
          "filter": {
            "tsx": "$event.Mode.String = 'outdoor'"
          },
          "aggregation": {
            "tsx": "avg($value)"
          }
        }
      }
    }
  ]
}

Sample Response

Status code:: 200

{
  "put": [
    {
      "timeSeriesType": {
        "id": "1be09af9-f089-4d6b-9f0b-48018b5f7393",
        "name": "DefaultType",
        "description": "My Default type",
        "variables": {
          "EventCount": {
            "kind": "aggregate",
            "filter": null,
            "aggregation": {
              "tsx": "count()"
            }
          }
        }
      },
      "error": null
    },
    {
      "timeSeriesType": {
        "id": "c1cb7a33-ed9b-4cf1-9958-f3162fed8ee8",
        "name": "OutdoorTemperatureSensor",
        "description": "This is an outdoor temperature sensor.",
        "variables": {
          "AverageTemperature": {
            "kind": "numeric",
            "value": {
              "tsx": "$event.Temperature.Double"
            },
            "filter": {
              "tsx": "$event.Mode.String = 'outdoor'"
            },
            "aggregation": {
              "tsx": "avg($value)"
            }
          }
        }
      },
      "error": null
    }
  ]
}

Definice

Name	Description
AggregateVariable	Agregační proměnná představuje jakýkoli výpočet agregace. Agregované proměnné nepodporují interpolaci.
Boundary	Časový rozsah vlevo a vpravo od rozsahu hledání, který se má použít k interpolaci. To je užitečné ve scénářích, kdy datové body chybí blízko začátku nebo konce rozsahu vstupního vyhledávání. Může mít hodnotu null.
CategoricalVariable	Kategorická proměnná představuje signál, který je potřeba analyzovat na základě počtu nebo doby trvání výskytu omezené sady definovaných hodnot.
Interpolation	Operace interpolace, která se má provést na nezpracovaných datových bodech. V současné době je povoleno pouze vzorkování interpolovaných časových řad. Povolená agregační funkce – např. left($value). Pokud není potřeba použít interpolaci, může mít hodnotu null.
InterpolationKind	Typ techniky interpolace: "Lineární" nebo "Krok".
NumericVariable	Číselná proměnná představuje jeden souvislý číselný signál, který lze rekonstruovat pomocí interpolace.
TimeSeriesAggregateCategory	Kategorie používaná v proměnných kategorií. Kategorie je definována pomocí "label" a "values", které jsou přiřazeny tomuto popisku.
TimeSeriesDefaultCategory	Představuje výchozí kategorii.
TimeSeriesType	Typ časové řady definuje proměnné nebo vzorce pro provádění výpočtů s událostmi přidruženými k instancím časových řad. Každá instance časové řady je přidružená přesně k jednomu typu. Typ může mít jednu nebo více proměnných. Instance časové řady může být například typu Senzor teploty, který se skládá z proměnných průměrná teplota, minimální teplota a maximální teplota.
TimeSeriesTypeOrError	Výsledek dávkové operace u konkrétního typu časové řady. Objekt typu se nastaví, když je operace úspěšná, a objekt chyby se nastaví, když operace není úspěšná.
TsiError	Informace o chybě rozhraní API
TsiErrorBody	Konkrétní chyba rozhraní API s kódem chyby a zprávou
TsiErrorDetails	Další informace o chybě.
Tsx	Výraz časové řady (TSX) napsaný jako jeden řetězec. Příklady: "$event. Status.String='Good'", "avg($event. Teplota)". Informace o tom, jak psát výrazy časových řad, najdete v dokumentaci.
TypesBatchRequest	Požadavek na provedení jedné operace v dávce typů časových řad Musí být nastavena přesně jedna z hodnot "get", "put" nebo "delete".
TypesBatchResponse	Odpověď jedné operace v dávce typů časových řad. Nastaví se přesně jedna z hodnot "get", "put" nebo "delete".
TypesRequestBatchGetOrDelete	Žádost o získání nebo odstranění typů časových řad podle ID nebo názvů typů Musí být nastaveno právě jedno z "typeIds" nebo "names".

AggregateVariable

Agregační proměnná představuje jakýkoli výpočet agregace. Agregované proměnné nepodporují interpolaci.

Name	Typ	Description
aggregation	Tsx	Výraz časové řady agregace, pokud je kind "aggregate", se používá k reprezentaci agregace, kterou je potřeba provést přímo pomocí vlastností události, jako je například "$event. Teplota". Agregaci pro výpočet rozsahu změn teploty lze například zapsat takto: "max($event. Teplota)-min($event. Teplota)".
filter	Tsx	Vyfiltrujte události, které omezují počet událostí zvažovaných pro výpočet. Příklad: "$event. Status.String='Good'". Nepovinný parametr.
kind	string: aggregate	Povolené hodnoty typu "kind" jsou - "numeric" nebo "aggregate". Zatímco "číselný" umožňuje zadat hodnotu rekonstruovaného signálu a výraz pro jejich agregaci, druh "agregace" umožňuje přímo agregovat vlastnosti události bez zadání hodnoty.

Boundary

Časový rozsah vlevo a vpravo od rozsahu hledání, který se má použít k interpolaci. To je užitečné ve scénářích, kdy datové body chybí blízko začátku nebo konce rozsahu vstupního vyhledávání. Může mít hodnotu null.

Name	Typ	Description
span	string

CategoricalVariable

Kategorická proměnná představuje signál, který je potřeba analyzovat na základě počtu nebo doby trvání výskytu omezené sady definovaných hodnot.

Name	Typ	Description
categories	TimeSeriesAggregateCategory[]	Kategorie použitá v kategorických proměnných. Kategorie je definována pomocí "label" a "values", které jsou přiřazeny tomuto popisku.
defaultCategory	TimeSeriesDefaultCategory	Představuje výchozí kategorii.
filter	Tsx	Vyfiltrujte události, které omezují počet událostí zvažovaných pro výpočet. Příklad: "$event. Status.String='Good'". Nepovinný parametr.
interpolation	Interpolation	Kategorická proměnná podporuje pouze interpolaci kroku.
kind	string: categorical	Povolené hodnoty typu "kind" jsou - "numeric" nebo "aggregate". Zatímco "číselný" umožňuje zadat hodnotu rekonstruovaného signálu a výraz pro jejich agregaci, druh "agregace" umožňuje přímo agregovat vlastnosti události bez zadání hodnoty.
value	Tsx	Výraz hodnotové časové řady se používá k reprezentaci hodnoty signálu, který bude zařazen do kategorií. U kategorických proměnných může být vyhodnocen pouze jako typ String nebo Long.

Interpolation

Operace interpolace, která se má provést na nezpracovaných datových bodech. V současné době je povoleno pouze vzorkování interpolovaných časových řad. Povolená agregační funkce – např. left($value). Pokud není potřeba použít interpolaci, může mít hodnotu null.

Name	Typ	Description
boundary	Boundary	Časový rozsah vlevo a vpravo od rozsahu hledání, který se má použít k interpolaci. To je užitečné ve scénářích, kdy datové body chybí blízko začátku nebo konce rozsahu vstupního vyhledávání. Může mít hodnotu null.
kind	InterpolationKind	Typ techniky interpolace: "Lineární" nebo "Krok".

InterpolationKind

Typ techniky interpolace: "Lineární" nebo "Krok".

Name	Typ	Description
Linear	string
Step	string

NumericVariable

Číselná proměnná představuje jeden souvislý číselný signál, který lze rekonstruovat pomocí interpolace.

Name	Typ	Description
aggregation	Tsx	Výraz časové řady agregace, pokud je druh "číselný", se používá k reprezentaci agregace, kterou je potřeba provést ve výrazu $value. To vyžaduje zadání $value a může používat pouze $value uvnitř agregačních funkcí. Například agregace pro výpočet minima $value se zapisuje takto: min($value)."
filter	Tsx	Vyfiltrujte události, které omezují počet událostí zvažovaných pro výpočet. Příklad: "$event. Status.String='Good'". Nepovinný parametr.
interpolation	Interpolation	Operace interpolace, která se má provést na nezpracovaných datových bodech. V současné době je povoleno pouze vzorkování interpolovaných časových řad. Povolená agregační funkce – např. left($value). Pokud není potřeba použít interpolaci, může mít hodnotu null.
kind	string: numeric	Povolené hodnoty typu "kind" jsou - "numeric" nebo "aggregate". Zatímco "číselný" umožňuje zadat hodnotu rekonstruovaného signálu a výraz pro jejich agregaci, druh "agregace" umožňuje přímo agregovat vlastnosti události bez zadání hodnoty.
value	Tsx	Výraz časové řady hodnot se používá k reprezentaci hodnoty signálu, který bude agregován nebo interpolován. Například hodnoty teploty z události jsou znázorněny takto: "$event. Temperature.Double".

TimeSeriesAggregateCategory

Kategorie používaná v proměnných kategorií. Kategorie je definována pomocí "label" a "values", které jsou přiřazeny tomuto popisku.

Name	Typ	Description
label	string	Název kategorie, která se použije při vytváření názvů výstupních proměnných.
values	object[]	Seznam hodnot, na které se kategorie mapuje. Může to být jedinečný seznam řetězců nebo dlouhý seznam.

TimeSeriesDefaultCategory

Představuje výchozí kategorii.

Name	Typ	Description
label	string	Název výchozí kategorie, která bude přiřazena k hodnotám, které neodpovídají žádným z těch, které jsou definovány v "kategoriích".

TimeSeriesType

Typ časové řady definuje proměnné nebo vzorce pro provádění výpočtů s událostmi přidruženými k instancím časových řad. Každá instance časové řady je přidružená přesně k jednomu typu. Typ může mít jednu nebo více proměnných. Instance časové řady může být například typu Senzor teploty, který se skládá z proměnných průměrná teplota, minimální teplota a maximální teplota.

Name	Typ	Description
description	string	Popis typu Může mít hodnotu null.
id	string	Jedinečný identifikátor typu rozlišující malá a velká písmena, který je neměnný. U požadavků na vytvoření nebo aktualizaci může mít hodnotu null a pak server vygeneruje ID. Není null pro operace get a delete.
name	string	Jedinečný název typu zadaný uživatelem. Měnitelné, nikoli null.
variables	object	Různé proměnné přidružené k typu Není prázdné, není null.

TimeSeriesTypeOrError

Výsledek dávkové operace u konkrétního typu časové řady. Objekt typu se nastaví, když je operace úspěšná, a objekt chyby se nastaví, když operace není úspěšná.

Name	Typ	Description
error	TsiErrorBody	Objekt Error – nastaví se, když operace nebude úspěšná.
timeSeriesType	TimeSeriesType	Objekt typu časové řady – nastaví se, když je operace úspěšná.

TsiError

Informace o chybě rozhraní API

Name	Typ	Description
error	TsiErrorBody	Konkrétní chyba rozhraní API s kódem chyby a zprávou

TsiErrorBody

Konkrétní chyba rozhraní API s kódem chyby a zprávou

Name	Typ	Description
code	string	Jazykově nezávislý řetězec čitelný pro člověka, který definuje kód chyby specifické pro službu. Tento kód slouží jako konkrétnější indikátor pro kód chyby HTTP zadaný v odpovědi. Dá se použít ke zpracování konkrétních případů chyb prostřednictvím kódu programu.
details	TsiErrorDetails[]	Obsahuje další informace o chybách. Může mít hodnotu null.
innerError	TsiErrorBody	Obsahuje konkrétnější chybu, která zpřesní příčinu. Může mít hodnotu null.
message	string	Člověkem čitelná reprezentace chyby nezávislá na jazyce. Je určena jako pomoc vývojářům a není vhodná pro vystavení koncovým uživatelům.
target	string	Cíl konkrétní chyby (například název vlastnosti v chybě). Může mít hodnotu null.

TsiErrorDetails

Další informace o chybě.

Name	Typ	Description
code	string	Jazykově nezávislý řetězec čitelný pro člověka, který definuje kód chyby specifické pro službu. Tento kód slouží jako konkrétnější indikátor pro kód chyby HTTP zadaný v odpovědi. Dá se použít ke zpracování konkrétních případů chyb prostřednictvím kódu programu.
message	string	Člověkem čitelná reprezentace chyby nezávislá na jazyce. Je určena jako pomoc vývojářům a není vhodná pro vystavení koncovým uživatelům.

Tsx

Výraz časové řady (TSX) napsaný jako jeden řetězec. Příklady: "$event. Status.String='Good'", "avg($event. Teplota)". Informace o tom, jak psát výrazy časových řad, najdete v dokumentaci.

Name	Typ	Description
tsx	string	Výraz časové řady (TSX) napsaný jako jeden řetězec. Příklady: "$event. Status.String='Good'", "avg($event. Teplota)". Informace o tom, jak psát výrazy časových řad, najdete v dokumentaci.

TypesBatchRequest

Požadavek na provedení jedné operace v dávce typů časových řad Musí být nastavena přesně jedna z hodnot "get", "put" nebo "delete".

Name	Typ	Description
delete	TypesRequestBatchGetOrDelete	Definice typů časových řad, které se mají odstranit.
get	TypesRequestBatchGetOrDelete	Definice typů časových řad, které se mají vrátit.
put	TimeSeriesType[]	Definice typů časových řad, které se mají aktualizovat nebo vytvořit

TypesBatchResponse

Odpověď jedné operace v dávce typů časových řad. Nastaví se přesně jedna z hodnot "get", "put" nebo "delete".

Name	Typ	Description
delete	TsiErrorBody[]	Seznam chybových objektů odpovídajících umístěním k poli "delete" v požadavku – null, pokud je operace úspěšná.
get	TimeSeriesTypeOrError[]	Seznam typů nebo chybových objektů odpovídajících umístění poli get v požadavku. Objekt typu se nastaví, když je operace úspěšná, a objekt chyby se nastaví, když operace není úspěšná.
put	TimeSeriesTypeOrError[]	Seznam typů nebo chybových objektů odpovídajících umístění poli "put" v požadavku. Objekt typu se nastaví, když je operace úspěšná, a objekt chyby se nastaví, když operace není úspěšná.

TypesRequestBatchGetOrDelete

Žádost o získání nebo odstranění typů časových řad podle ID nebo názvů typů Musí být nastaveno právě jedno z "typeIds" nebo "names".

Name	Typ	Description
names	string[]	Seznam názvů typů časových řad, které se mají vrátit nebo odstranit.
typeIds	string[]	Seznam ID typů časových řad, které se mají vrátit nebo odstranit

Sdílet prostřednictvím

Time Series Types - Execute Batch

Parametry identifikátoru URI

Hlavička požadavku

Text požadavku

Odpovědi

Zabezpečení

azure_auth

Scopes

Příklady

TypesBatchDeleteByIds

Sample Request

Sample Response

TypesBatchDeleteByNames

Sample Request

Sample Response

TypesBatchGetByIds

Sample Request

Sample Response

TypesBatchGetByNames

Sample Request

Sample Response

TypesBatchPut

Sample Request

Sample Response

Definice

AggregateVariable

Boundary

CategoricalVariable

Interpolation

InterpolationKind

NumericVariable

TimeSeriesAggregateCategory

TimeSeriesDefaultCategory

TimeSeriesType

TimeSeriesTypeOrError

TsiError

TsiErrorBody

TsiErrorDetails

Tsx

TypesBatchRequest

TypesBatchResponse

TypesRequestBatchGetOrDelete

Další materiály