Freigeben über

Time Series Types - Execute Batch

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

Führt einen Batchvorgang zum Abrufen, Erstellen, Aktualisieren, 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

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

string

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

Anforderungsheader

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

string

Optionale Clientanforderungs-ID. Dieser Wert wird vom Dienst aufgezeichnet. Ermöglicht dem Dienst das Nachverfolgen des Vorgangs über Dienste hinweg und ermöglicht es dem Kunden, den Support in Bezug auf eine bestimmte Anfrage zu kontaktieren.
x-ms-client-session-id

string

Optionale Clientsitzungs-ID. Dieser Wert wird vom Dienst aufgezeichnet. Ermöglicht dem Dienst die Ablaufverfolgung einer Gruppe verwandter Vorgänge über Dienste hinweg und ermöglicht es dem Kunden, den Support in Bezug auf eine bestimmte Gruppe von Anfragen zu kontaktieren.

Anforderungstext

Name Typ Beschreibung
delete

TypesRequestBatchGetOrDelete

Definition der zu löschenden Zeitreihentypen.
get

TypesRequestBatchGetOrDelete

Definition der zurückzugebenden Zeitreihentypen.
put

TimeSeriesType[]

Definition der Zeitreihentypen, die aktualisiert oder erstellt werden sollen.

Antworten

Name Typ Beschreibung
200 OK

TypesBatchResponse

Erfolgreicher Vorgang.

Header

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

TsiError

Unerwarteter Fehler.

Header

x-ms-request-id: string

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name Beschreibung
user_impersonation Identitätswechsel ihres Benutzerkontos

Beispiele

TypesBatchDeleteByIds
TypesBatchDeleteByNames
TypesBatchGetByIds
TypesBatchGetByNames
TypesBatchPut

TypesBatchDeleteByIds

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:
200 
{
  "delete": [
    null
  ]
}

TypesBatchDeleteByNames

Beispielanforderung

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

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

Beispiel für eine Antwort

Statuscode:
200 
{
  "delete": [
    null
  ]
}

TypesBatchGetByIds

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:
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

Beispielanforderung

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

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

Beispiel für eine Antwort

Statuscode:
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

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:
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 jede Aggregationsberechnung dar. Aggregatvariablen unterstützen keine Interpolation.
Boundary

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

Die kategorisierte Variable stellt ein Signal dar, das basierend auf der Anzahl oder Dauer des Auftretens begrenzter Wertegruppen analysiert werden muss.
Interpolation

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

Die Art der Interpolationstechnik: "Linear" oder "Step".
NumericVariable

Numerische Variable stellt ein einzelnes fortlaufendes numerisches Signal dar, das mithilfe der Interpolation rekonstruiert werden kann.
TimeSeriesAggregateCategory

Kategorie, die in kategorisierten 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 mit Zeitreiheninstanzen verknüpft sind. Jedes Mal, wenn die Datenreiheninstanz genau einem Typ zugeordnet ist. Ein Typ kann eine oder mehrere Variablen aufweisen. Eine Zeitreiheninstanz kann z. B. vom Typ "Temperatursensor" sein, der aus den Variablen "Durchschnittliche Temperatur", "Min. Temperatur" und "Max. Temperatur" besteht.
TimeSeriesTypeOrError

Ergebnis eines Batchvorgangs für einen bestimmten Zeitreihentyp. Type-Objekt wird festgelegt, wenn der Vorgang erfolgreich ist und fehlerobjekt festgelegt wird, 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 (TSX), der als einzelne Zeichenfolge geschrieben wurde. Beispiele: "$event. Status.String='Good'", "avg($event). Temperatur)". 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 einer von "get", "put" oder "delete" muss festgelegt werden.
TypesBatchResponse

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

Fordern Sie an, Zeitreihentypen nach IDs oder Typnamen abzurufen oder zu löschen. Genau eine der "typeIds" oder "Names" muss festgelegt werden.

AggregateVariable

Objekt

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

Name Typ Beschreibung
aggregation

Tsx

Ausdruck der Aggregationszeitreihen, wenn die Art "Aggregat" ist, wird verwendet, um die Aggregation darzustellen, die direkt mithilfe von Ereigniseigenschaften wie "$event" ausgeführt werden muss. Temperatur". Beispielsweise kann die Aggregation zum Berechnen des Temperaturbereichs wie folgt geschrieben werden: "max($event). Temperatur)-min($event. Temperatur)".
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'". Wahlfrei.
kind string:

aggregate

Zulässige "Art"-Werte sind - "numerisch" oder "Aggregat". Während "numerisch" es Ihnen ermöglicht, den Wert des rekonstruierbaren Signals und des Ausdrucks anzugeben, um sie zu aggregieren, können Sie mit der Art "Aggregat" direkt auf die Ereigniseigenschaften aggregieren, ohne einen Wert anzugeben.

Boundary

Objekt

Der Zeitbereich links und rechts neben dem Suchbereich, der für die Interpolation verwendet werden soll. Dies ist in Szenarien hilfreich, in denen die Datenpunkte nah am Anfang oder Ende der Eingabesuchspanne fehlen. Kann null sein.

Name Typ Beschreibung
span

string (duration)

CategoricalVariable

Objekt

Die kategorisierte Variable stellt ein Signal dar, das basierend auf der Anzahl oder Dauer des Auftretens begrenzter Wertegruppen analysiert werden muss.

Name Typ Beschreibung
categories

TimeSeriesAggregateCategory[]

Kategorie, die in kategorisierten 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'". Wahlfrei.
interpolation

Interpolation

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

categorical

Zulässige "Art"-Werte sind - "numerisch" oder "Aggregat". Während "numerisch" es Ihnen ermöglicht, den Wert des rekonstruierbaren Signals und des Ausdrucks anzugeben, um sie zu aggregieren, können Sie mit der Art "Aggregat" direkt auf die Ereigniseigenschaften aggregieren, ohne einen Wert anzugeben.
value

Tsx

Wertzeitreihenausdruck wird verwendet, um den Wert des Signals darzustellen, das kategorisiert werden soll. Sie kann für kategorisierte Variablen nur den Typ 'String' oder 'Long' auswerten.

Interpolation

Objekt

Der Interpolationsvorgang, der für die Rohdatenpunkte ausgeführt werden soll. Derzeit ist nur das Sampling von interpolierten 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 neben dem Suchbereich, der für die Interpolation verwendet werden soll. Dies ist in Szenarien hilfreich, in denen die Datenpunkte nah am Anfang oder Ende der Eingabesuchspanne fehlen. Kann null sein.
kind

InterpolationKind

Die Art der Interpolationstechnik: "Linear" oder "Step".

InterpolationKind

Enumeration

Die Art der Interpolationstechnik: "Linear" oder "Step".

Wert Beschreibung
Linear
Step

NumericVariable

Objekt

Numerische Variable stellt ein einzelnes fortlaufendes numerisches Signal dar, das mithilfe der Interpolation rekonstruiert werden kann.

Name Typ Beschreibung
aggregation

Tsx

Ausdruck der Aggregationszeitreihen, wenn die Art "numerisch" ist, um die Aggregation darzustellen, die für den $value Ausdruck ausgeführt werden muss. Dazu müssen $value angegeben werden und können nur $value innerhalb der Aggregatfunktionen verwenden. Beispielsweise wird die Aggregation zum Berechnen des Minimums der $value wie folgt geschrieben: "min($value)".
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'". Wahlfrei.
interpolation

Interpolation

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

numeric

Zulässige "Art"-Werte sind - "numerisch" oder "Aggregat". Während "numerisch" es Ihnen ermöglicht, den Wert des rekonstruierbaren Signals und des Ausdrucks anzugeben, um sie zu aggregieren, können Sie mit der Art "Aggregat" direkt auf die Ereigniseigenschaften aggregieren, ohne einen Wert anzugeben.
value

Tsx

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

Objekt

Kategorie, die in kategorisierten 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 Ausgabevariablennamen verwendet wird.
values

object[]

Die Liste der Werte, denen eine Kategorie zugeordnet ist. Dabei kann es sich entweder um eine eindeutige Liste von Zeichenfolgen oder eine Liste mit langer Länge sein.

TimeSeriesDefaultCategory

Objekt

Stellt die Standardkategorie dar.

Name Typ Beschreibung
label

string

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

TimeSeriesType

Objekt

Der Zeitreihentyp definiert Variablen oder Formeln für die Berechnung von Ereignissen, die mit Zeitreiheninstanzen verknüpft sind. Jedes Mal, wenn die Datenreiheninstanz genau einem Typ zugeordnet ist. Ein Typ kann eine oder mehrere Variablen aufweisen. Eine Zeitreiheninstanz kann z. B. vom Typ "Temperatursensor" sein, der aus den Variablen "Durchschnittliche Temperatur", "Min. Temperatur" und "Max. Temperatur" besteht.

Name Typ Beschreibung
description

string

Beschreibung des Typs. Kann null sein.
id

string

Eindeutiger Typbezeichner mit Groß-/Kleinschreibung, der unveränderlich ist. Kann bei Erstellungs- oder Aktualisierungsanforderungen NULL sein, und der Server generiert dann die ID. Nicht NULL für Get- und Löschvorgänge.
name

string

Der vom Benutzer angegebene eindeutige Name für den Typ. Änderbar, nicht NULL.
variables

object

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

TimeSeriesTypeOrError

Objekt

Ergebnis eines Batchvorgangs für einen bestimmten Zeitreihentyp. Type-Objekt wird festgelegt, wenn der Vorgang erfolgreich ist und fehlerobjekt festgelegt wird, wenn der Vorgang nicht erfolgreich ist.

Name Typ Beschreibung
error

TsiErrorBody

Error-Objekt – festgelegt, wenn der Vorgang nicht erfolgreich ist.
timeSeriesType

TimeSeriesType

Time series type object - set when the operation is successful.

TsiError

Objekt

Informationen zu einem API-Fehler.

Name Typ Beschreibung
error

TsiErrorBody

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

TsiErrorBody

Objekt

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

Name Typ Beschreibung
code

string

Sprachunabhängige, 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. Kann null sein.
innerError

TsiErrorBody

Enthält einen spezifischeren Fehler, der die Ursache einschränkt. Kann null sein.
message

string

Lesbare, sprachunabhängige Darstellung des Fehlers. Es ist als Hilfe für Entwickler gedacht und eignet sich nicht für die Gefährdung von Endbenutzern.
target

string

Ziel des bestimmten Fehlers (z. B. der Name der Eigenschaft im Fehler). Kann null sein.

TsiErrorDetails

Objekt

Zusätzliche Fehlerinformationen.

Name Typ Beschreibung
code

string

Sprachunabhängige, 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

Lesbare, sprachunabhängige Darstellung des Fehlers. Es ist als Hilfe für Entwickler gedacht und eignet sich nicht für die Gefährdung von Endbenutzern.

Tsx

Objekt

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

Name Typ Beschreibung
tsx

string

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

TypesBatchRequest

Objekt

Anforderung zum Ausführen eines einzelnen Vorgangs für einen Batch von Zeitreihentypen. Genau einer 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 der Zeitreihentypen, die aktualisiert oder erstellt werden sollen.

TypesBatchResponse

Objekt

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

Name Typ Beschreibung
delete

TsiErrorBody[]

Liste der Fehlerobjekte, die der Position des Arrays "delete" in der Anforderung entsprechen - NULL, wenn der Vorgang erfolgreich ist.
get

TimeSeriesTypeOrError[]

Liste der Typen oder Fehlerobjekte, die der Position des Arrays "get" in der Anforderung entsprechen. Type-Objekt wird festgelegt, wenn der Vorgang erfolgreich ist und fehlerobjekt festgelegt wird, wenn der Vorgang nicht erfolgreich ist.
put

TimeSeriesTypeOrError[]

Liste der Typen oder Fehlerobjekte, die der Position des Arrays "put" in der Anforderung entsprechen. Type-Objekt wird festgelegt, wenn der Vorgang erfolgreich ist und fehlerobjekt festgelegt wird, wenn der Vorgang nicht erfolgreich ist.

TypesRequestBatchGetOrDelete

Objekt

Fordern Sie an, Zeitreihentypen nach IDs oder Typnamen abzurufen oder zu löschen. Genau eine der "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.