Share via

Time Series Types - Execute Batch

  • Referenz
Service:
Time Series Insights
API Version:
2020-07-31

Führt einen Batchvorgang zum Abrufen, Erstellen, Aktualisieren und Löschen für mehrere Zeitreihentypen aus.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
environmentFqdn
 path True

string

FQDN pro Umgebung, z. B. 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com. Sie können diesen Domänennamen aus der Antwort der Get Environments-API, Azure-Portal oder azure Resource Manager abrufen.
api-version
 query True

string

Version der API, die mit der Clientanforderung verwendet werden soll. Die derzeit unterstützte Version ist "2020-07-31".

Anforderungsheader

Name Erforderlich Typ Beschreibung
x-ms-client-request-id

string

Optionale Clientanforderungs-ID. Der Dienst zeichnet diesen Wert auf. Ermöglicht dem Dienst die dienstübergreifende Ablaufverfolgung des Vorgangs und ermöglicht es dem Kunden, sich bezüglich einer bestimmten Anforderung an den Support zu wenden.
x-ms-client-session-id

string

Optionale Clientsitzungs-ID. Der Dienst zeichnet diesen Wert auf. Ermöglicht dem Dienst, eine Gruppe verwandter Vorgänge dienstübergreifend nachzuverfolgen, und ermöglicht es dem Kunden, den Support bezüglich einer bestimmten Gruppe von Anforderungen zu kontaktieren.

Anforderungstext

Name Typ Beschreibung
delete

TypesRequestBatchGetOrDelete

Definition der zu löschenden Zeitreihentypen.
get

TypesRequestBatchGetOrDelete

Definition, welche Zeitreihentypen zurückgegeben werden sollen.
put

TimeSeriesType[]

Definition, welche Zeitreihentypen aktualisiert oder erstellt werden sollen.

Antworten

Name Typ Beschreibung
200 OK

TypesBatchResponse

Erfolgreiche Ausführung

Headers

x-ms-request-id: string
Other Status Codes

TsiError

Unerwarteter Fehler.

Headers

x-ms-request-id: string

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

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

Scopes

Name Beschreibung
user_impersonation Identitätswechsel Ihres Benutzerkontos

Beispiele

TypesBatchDeleteByIds
TypesBatchDeleteByNames
TypesBatchGetByIds
TypesBatchGetByNames
TypesBatchPut

TypesBatchDeleteByIds

Sample Request

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

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

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

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

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
    }
  ]
}

Definitionen

Name Beschreibung
AggregateVariable

Die Aggregatvariable stellt eine beliebige Aggregationsberechnung dar. Aggregatvariablen unterstützen keine Interpolation.
Boundary

Der Zeitbereich links und rechts der Suchspanne, die für die Interpolation verwendet werden soll. Dies ist hilfreich in Szenarien, in denen die Datenpunkte nahe am Anfang oder Ende der Eingabesuchspanne fehlen. Kann NULL sein.
CategoricalVariable

Die kategorische Variable stellt ein Signal dar, das basierend auf der Anzahl oder Dauer des Vorkommens eines begrenzten Satzes definierter Werte analysiert werden muss.
Interpolation

Der Interpolationsvorgang, der für die Rohdatenpunkte ausgeführt werden soll. Derzeit ist nur das Sampling interpolierter Zeitreihen zulässig. Zulässige Aggregatfunktion – z. B. left($value). Kann NULL sein, wenn keine Interpolation angewendet werden muss.
InterpolationKind

Der Typ der Interpolationstechnik: "Linear" oder "Step".
NumericVariable

Die numerische Variable stellt ein einzelnes kontinuierliches numerisches Signal dar, das mithilfe von Interpolation rekonstruiert werden kann.
TimeSeriesAggregateCategory

Kategorie, die in kategorischen Variablen verwendet wird. Eine Kategorie wird durch "label" und die "Werte" definiert, denen diese Bezeichnung zugewiesen ist.
TimeSeriesDefaultCategory

Stellt die Standardkategorie dar.
TimeSeriesType

Der Zeitreihentyp definiert Variablen oder Formeln für die Berechnung von Ereignissen, die Zeitreiheninstanzen zugeordnet sind. Jede Zeitreihen instance ist genau einem Typ zugeordnet. Ein Typ kann eine oder mehrere Variablen enthalten. Beispielsweise kann eine Zeitreihe instance vom Typ Temperatursensor sein, der aus den Variablen Durchschnittstemperatur, Mindesttemperatur und max. Temperatur besteht.
TimeSeriesTypeOrError

Ergebnis eines Batchvorgangs für einen bestimmten Zeitreihentyp. Das Typobjekt wird festgelegt, wenn der Vorgang erfolgreich ist, und das Fehlerobjekt wird festgelegt, wenn der Vorgang nicht erfolgreich ist.
TsiError

Informationen zu einem API-Fehler.
TsiErrorBody

Ein bestimmter API-Fehler mit einem Fehlercode und einer Meldung.
TsiErrorDetails

Zusätzliche Fehlerinformationen.
Tsx

Zeitreihenausdruck (TIME Series Expression, TSX), der als einzelne Zeichenfolge geschrieben wird. Beispiele: "$event. Status.String='Good'", "avg($event. Temperature)". Informationen zum Schreiben von Zeitreihenausdrücken finden Sie in der Dokumentation.
TypesBatchRequest

Anforderung zum Ausführen eines einzelnen Vorgangs für einen Batch von Zeitreihentypen. Genau eins von "get", "put" oder "delete" muss festgelegt werden.
TypesBatchResponse

Antwort eines einzelnen Vorgangs für einen Batch von Zeitreihentypen. Genau eins von "get", "put" oder "delete" wird festgelegt.
TypesRequestBatchGetOrDelete

Anforderung zum Abrufen oder Löschen von Zeitreihentypen nach IDs oder Typnamen. Genau einer von "typeIds" oder "names" muss festgelegt werden.

AggregateVariable

Die Aggregatvariable stellt eine beliebige Aggregationsberechnung dar. Aggregatvariablen unterstützen keine Interpolation.

Name Typ Beschreibung
aggregation

Tsx

Aggregationszeitreihenausdruck, wenn art "aggregat" ist, wird verwendet, um die Aggregation darzustellen, die direkt mithilfe von Ereigniseigenschaften wie "$event. Temperatur". Beispielsweise kann die Aggregation zum Berechnen des Bereichs von Temperaturänderungen wie folgt geschrieben werden: "max($event. Temperature)-min($event. Temperature)".
filter

Tsx

Filtern Sie nach den Ereignissen, die die Anzahl der Ereignisse einschränken, die für die Berechnung berücksichtigt werden. Beispiel: "$event. Status.String='Good'"" Optional.
kind string:

aggregate

Zulässige "Kind"-Werte sind "numeric" oder "aggregate". Während Sie mit "numeric" den Wert des rekonstruierten Signals und des Ausdrucks angeben können, um sie zu aggregieren, können Sie mit der Art "Aggregat" die Ereigniseigenschaften direkt aggregieren, ohne wert anzugeben.

Boundary

Der Zeitbereich links und rechts der Suchspanne, die für die Interpolation verwendet werden soll. Dies ist hilfreich in Szenarien, in denen die Datenpunkte nahe am Anfang oder Ende der Eingabesuchspanne fehlen. Kann NULL sein.

Name Typ Beschreibung
span

string

CategoricalVariable

Die kategorische Variable stellt ein Signal dar, das basierend auf der Anzahl oder Dauer des Vorkommens eines begrenzten Satzes definierter Werte analysiert werden muss.

Name Typ Beschreibung
categories

TimeSeriesAggregateCategory[]

Kategorie, die in kategorischen Variablen verwendet wird. Eine Kategorie wird durch "label" und die "Werte" definiert, denen diese Bezeichnung zugewiesen ist.
defaultCategory

TimeSeriesDefaultCategory

Stellt die Standardkategorie dar.
filter

Tsx

Filtern Sie nach den Ereignissen, die die Anzahl der Ereignisse einschränken, die für die Berechnung berücksichtigt werden. Beispiel: "$event. Status.String='Good'"" Optional.
interpolation

Interpolation

Kategorische Variable unterstützt nur die "Schritt"-Interpolation.
kind string:

categorical

Zulässige "Kind"-Werte sind "numeric" oder "aggregate". Während Sie mit "numeric" den Wert des rekonstruierten Signals und des Ausdrucks angeben können, um sie zu aggregieren, können Sie mit der Art "Aggregat" die Ereigniseigenschaften direkt aggregieren, ohne wert anzugeben.
value

Tsx

Der Wertzeitreihenausdruck wird verwendet, um den Wert des Signals darzustellen, das kategorisiert werden soll. Es kann nur den Typ "String" oder "Long" für kategorische Variablen auswerten.

Interpolation

Der Interpolationsvorgang, der für die Rohdatenpunkte ausgeführt werden soll. Derzeit ist nur das Sampling interpolierter Zeitreihen zulässig. Zulässige Aggregatfunktion – z. B. left($value). Kann NULL sein, wenn keine Interpolation angewendet werden muss.

Name Typ Beschreibung
boundary

Boundary

Der Zeitbereich links und rechts der Suchspanne, die für die Interpolation verwendet werden soll. Dies ist hilfreich in Szenarien, in denen die Datenpunkte nahe am Anfang oder Ende der Eingabesuchspanne fehlen. Kann NULL sein.
kind

InterpolationKind

Der Typ der Interpolationstechnik: "Linear" oder "Step".

InterpolationKind

Der Typ der Interpolationstechnik: "Linear" oder "Step".

Name Typ Beschreibung
Linear

string

Step

string

NumericVariable

Die numerische Variable stellt ein einzelnes kontinuierliches numerisches Signal dar, das mithilfe von Interpolation rekonstruiert werden kann.

Name Typ Beschreibung
aggregation

Tsx

Der Aggregationszeitreihenausdruck, wenn art "numerisch" ist, wird verwendet, um die Aggregation darzustellen, die für den $value Ausdruck ausgeführt werden muss. Hierfür müssen $value angegeben werden und können nur $value innerhalb der Aggregatfunktionen verwenden. Beispielsweise wird die Aggregation zum Berechnen des Mindestwerts der $value als "min($value)" geschrieben.
filter

Tsx

Filtern Sie nach den Ereignissen, die die Anzahl der Ereignisse einschränken, die für die Berechnung berücksichtigt werden. Beispiel: "$event. Status.String='Good'"" Optional.
interpolation

Interpolation

Der Interpolationsvorgang, der für die Rohdatenpunkte ausgeführt werden soll. Derzeit ist nur das Sampling interpolierter Zeitreihen zulässig. Zulässige Aggregatfunktion – z. B. left($value). Kann NULL sein, wenn keine Interpolation angewendet werden muss.
kind string:

numeric

Zulässige "Kind"-Werte sind "numeric" oder "aggregate". Während Sie mit "numeric" den Wert des rekonstruierten Signals und des Ausdrucks angeben können, um sie zu aggregieren, können Sie mit der Art "Aggregat" die Ereigniseigenschaften direkt aggregieren, ohne wert anzugeben.
value

Tsx

Der Wertzeitreihenausdruck wird verwendet, um den Wert des Signals darzustellen, das aggregiert oder interpoliert werden soll. Beispielsweise werden Temperaturwerte aus dem Ereignis wie folgt dargestellt: "$event. Temperature.Double".

TimeSeriesAggregateCategory

Kategorie, die in kategorischen Variablen verwendet wird. Eine Kategorie wird durch "label" und die "Werte" definiert, denen diese Bezeichnung zugewiesen ist.

Name Typ Beschreibung
label

string

Der Name der Kategorie, die beim Erstellen der Namen der Ausgabevariablen verwendet wird.
values

object[]

Die Liste der Werte, denen eine Kategorie zugeordnet ist. Kann entweder eine eindeutige Liste von Zeichenfolgen oder eine Liste von langen sein.

TimeSeriesDefaultCategory

Stellt die Standardkategorie dar.

Name Typ Beschreibung
label

string

Der Name der Standardkategorie, die den Werten zugewiesen wird, die keinem der werte entsprechen, die in den "Kategorien" definiert sind.

TimeSeriesType

Der Zeitreihentyp definiert Variablen oder Formeln für die Berechnung von Ereignissen, die Zeitreiheninstanzen zugeordnet sind. Jede Zeitreihen instance ist genau einem Typ zugeordnet. Ein Typ kann eine oder mehrere Variablen enthalten. Beispielsweise kann eine Zeitreihe instance vom Typ Temperatursensor sein, der aus den Variablen Durchschnittstemperatur, Mindesttemperatur und max. Temperatur besteht.

Name Typ Beschreibung
description

string

Die Beschreibung des Typs. Ist möglicherweise NULL.
id

string

Bei unveränderlicher Typbezeichner wird die Groß-/Kleinschreibung beachtet. Kann bei Erstellungs- oder Aktualisierungsanforderungen NULL sein, und dann generiert der Server die ID. Bei Get- und Delete-Vorgängen nicht NULL.
name

string

Benutzerseitig eindeutiger Name für den Typ. Änderbar, nicht NULL.
variables

object

Verschiedene Variablen, die dem Typ zugeordnet sind. Nicht leer, nicht NULL.

TimeSeriesTypeOrError

Ergebnis eines Batchvorgangs für einen bestimmten Zeitreihentyp. Das Typobjekt wird festgelegt, wenn der Vorgang erfolgreich ist, und das Fehlerobjekt wird festgelegt, wenn der Vorgang nicht erfolgreich ist.

Name Typ Beschreibung
error

TsiErrorBody

Fehlerobjekt: Wird festgelegt, wenn der Vorgang nicht erfolgreich ist.
timeSeriesType

TimeSeriesType

Zeitreihentypobjekt: Legt fest, wann der Vorgang erfolgreich ist.

TsiError

Informationen zu einem API-Fehler.

Name Typ Beschreibung
error

TsiErrorBody

Ein bestimmter API-Fehler mit einem Fehlercode und einer Meldung.

TsiErrorBody

Ein bestimmter API-Fehler mit einem Fehlercode und einer Meldung.

Name Typ Beschreibung
code

string

Sprachunabhängige, für Menschen lesbare Zeichenfolge, die einen dienstspezifischen Fehlercode definiert. Dieser Code dient als spezifischerer Indikator für den in der Antwort angegebenen HTTP-Fehlercode. Kann verwendet werden, um bestimmte Fehlerfälle programmgesteuert zu behandeln.
details

TsiErrorDetails[]

Enthält zusätzliche Fehlerinformationen. Ist möglicherweise NULL.
innerError

TsiErrorBody

Enthält einen spezifischeren Fehler, der die Ursache eingrenzt. Ist möglicherweise NULL.
message

string

Für Menschen lesbare, sprachunabhängige Darstellung des Fehlers. Es ist als Hilfe für Entwickler gedacht und eignet sich nicht für die Exposition gegenüber Endbenutzern.
target

string

Ziel des bestimmten Fehlers (z. B. der Name der -Eigenschaft im Fehler). Ist möglicherweise NULL.

TsiErrorDetails

Zusätzliche Fehlerinformationen.

Name Typ Beschreibung
code

string

Sprachunabhängige, für Menschen lesbare Zeichenfolge, die einen dienstspezifischen Fehlercode definiert. Dieser Code dient als spezifischerer Indikator für den in der Antwort angegebenen HTTP-Fehlercode. Kann verwendet werden, um bestimmte Fehlerfälle programmgesteuert zu behandeln.
message

string

Für Menschen lesbare, sprachunabhängige Darstellung des Fehlers. Es ist als Hilfe für Entwickler gedacht und eignet sich nicht für die Exposition gegenüber Endbenutzern.

Tsx

Zeitreihenausdruck (TIME Series Expression, TSX), der als einzelne Zeichenfolge geschrieben wird. Beispiele: "$event. Status.String='Good'", "avg($event. Temperature)". Informationen zum Schreiben von Zeitreihenausdrücken finden Sie in der Dokumentation.

Name Typ Beschreibung
tsx

string

Zeitreihenausdruck (TIME Series Expression, TSX), der als einzelne Zeichenfolge geschrieben wird. Beispiele: "$event. Status.String='Good'", "avg($event. Temperature)". Informationen zum Schreiben von Zeitreihenausdrücken finden Sie in der Dokumentation.

TypesBatchRequest

Anforderung zum Ausführen eines einzelnen Vorgangs für einen Batch von Zeitreihentypen. Genau eins von "get", "put" oder "delete" muss festgelegt werden.

Name Typ Beschreibung
delete

TypesRequestBatchGetOrDelete

Definition der zu löschenden Zeitreihentypen.
get

TypesRequestBatchGetOrDelete

Definition der zurückzugebenden Zeitreihentypen.
put

TimeSeriesType[]

Definition, welche Zeitreihentypen aktualisiert oder erstellt werden sollen.

TypesBatchResponse

Antwort eines einzelnen Vorgangs für einen Batch von Zeitreihentypen. Genau eins von "get", "put" oder "delete" wird festgelegt.

Name Typ Beschreibung
delete

TsiErrorBody[]

Liste der Fehlerobjekte, die nach Position zum Array "delete" in der Anforderung entsprechen – NULL, wenn der Vorgang erfolgreich ist.
get

TimeSeriesTypeOrError[]

Liste der Typen oder Fehlerobjekte, die nach Position zum "get"-Array in der Anforderung entsprechen. Das Typobjekt wird festgelegt, wenn der Vorgang erfolgreich ist, und das Fehlerobjekt wird festgelegt, wenn der Vorgang nicht erfolgreich ist.
put

TimeSeriesTypeOrError[]

Liste der Typen oder Fehlerobjekte, die nach Position zum "put"-Array in der Anforderung entsprechen. Das Typobjekt wird festgelegt, wenn der Vorgang erfolgreich ist, und das Fehlerobjekt wird festgelegt, wenn der Vorgang nicht erfolgreich ist.

TypesRequestBatchGetOrDelete

Anforderung zum Abrufen oder Löschen von Zeitreihentypen nach IDs oder Typnamen. Genau einer von "typeIds" oder "names" muss festgelegt werden.

Name Typ Beschreibung
names

string[]

Liste der Namen von Zeitreihentypen, die zurückgegeben oder gelöscht werden sollen.
typeIds

string[]

Liste der IDs von Zeitreihentypen, die zurückgegeben oder gelöscht werden sollen.