Partager via

Time Series Types - Execute Batch

  • Référence
Service:
Time Series Insights
Version d'API:
2020-07-31

Exécute une opération d’obtention, de création, de mise à jour et de suppression par lot sur plusieurs types de séries chronologiques.

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

Paramètres URI

Nom Dans Obligatoire Type Description
environmentFqdn
 path True

string

Par nom de domaine complet de l’environnement, par exemple 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com. Vous pouvez obtenir ce nom de domaine à partir de la réponse de l’API Get Environments, Portail Azure ou azure Resource Manager.
api-version
 query True

string

Version de l’API à utiliser avec la demande cliente. La version actuellement prise en charge est « 31/07/2020 ».

En-tête de la demande

Nom Obligatoire Type Description
x-ms-client-request-id

string

ID de demande client facultative. Le service enregistre cette valeur. Permet au service de suivre l’opération entre les services et permet au client de contacter le support technique pour une demande particulière.
x-ms-client-session-id

string

ID de session client facultatif. Le service enregistre cette valeur. Permet au service de suivre un groupe d’opérations associées entre les services et permet au client de contacter le support technique concernant un groupe particulier de demandes.

Corps de la demande

Nom Type Description
delete

TypesRequestBatchGetOrDelete

Définition des types de séries chronologiques à supprimer.
get

TypesRequestBatchGetOrDelete

Définition des types de séries chronologiques à retourner.
put

TimeSeriesType[]

Définition des types de séries chronologiques à mettre à jour ou à créer.

Réponses

Nom Type Description
200 OK

TypesBatchResponse

Opération réussie.

En-têtes

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

TsiError

Erreur inattendue.

En-têtes

x-ms-request-id: string

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom Description
user_impersonation Emprunter l’identité de votre compte d’utilisateur

Exemples

TypesBatchDeleteByIds
TypesBatchDeleteByNames
TypesBatchGetByIds
TypesBatchGetByNames
TypesBatchPut

TypesBatchDeleteByIds

Exemple de requête

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

Exemple de réponse

Code d’état:
200 
{
  "delete": [
    null
  ]
}

TypesBatchDeleteByNames

Exemple de requête

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

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

Exemple de réponse

Code d’état:
200 
{
  "delete": [
    null
  ]
}

TypesBatchGetByIds

Exemple de requête

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

Exemple de réponse

Code d’état:
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

Exemple de requête

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

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

Exemple de réponse

Code d’état:
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

Exemple de requête

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

Exemple de réponse

Code d’état:
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
    }
  ]
}

Définitions

Nom Description
AggregateVariable

La variable d’agrégation représente n’importe quel calcul d’agrégation. Les variables d’agrégation ne prennent pas en charge l’interpolation.
Boundary

Intervalle de temps à gauche et à droite de l’étendue de recherche à utiliser pour l’interpolation. Cela est utile dans les scénarios où les points de données sont manquants près du début ou de la fin de l’étendue de recherche d’entrée. Peuvent avoir la valeur null.
CategoricalVariable

La variable de catégorie représente le signal qui doit être analysé en fonction du nombre ou de la durée d’occurrence d’un ensemble limité de valeurs définies.
Interpolation

Opération d’interpolation à effectuer sur les points de données brutes. Actuellement, seul l’échantillonnage de séries chronologiques interpolées est autorisé. Fonction d’agrégation autorisée - par exemple : left($value). Peut être null si aucune interpolation ne doit être appliquée.
InterpolationKind

Type de technique d’interpolation : « Linéaire » ou « Step ».
NumericVariable

La variable numérique représente un seul signal numérique continu qui peut être reconstruit à l’aide de l’interpolation.
TimeSeriesAggregateCategory

Catégorie utilisée dans les variables catégorielles. Une catégorie est définie par « label » et les « valeurs » auxquelles cette étiquette est attribuée.
TimeSeriesDefaultCategory

Représente la catégorie par défaut.
TimeSeriesType

Le type de série chronologique définit des variables ou des formules pour effectuer des calculs sur des événements associés à des instances de série chronologique. Chaque série chronologique instance est associée à exactement un type. Un type peut avoir une ou plusieurs variables. Par exemple, une série chronologique instance peut être de type Capteur de température, qui se compose des variables température moyenne, température minimale et température maximale.
TimeSeriesTypeOrError

Résultat d’une opération par lot sur un type de série chronologique particulier. L’objet Type est défini lorsque l’opération réussit et que l’objet d’erreur est défini en cas d’échec de l’opération.
TsiError

Informations sur une erreur d’API.
TsiErrorBody

Erreur d’API particulière avec un code d’erreur et un message.
TsiErrorDetails

Informations supplémentaires sur l’erreur.
Tsx

Expression de série chronologique (TSX) écrite sous la forme d’une chaîne unique. Exemples : « $event. Status.String='Good' », « avg($event. Température) ». Reportez-vous à la documentation sur l’écriture d’expressions de série chronologique.
TypesBatchRequest

Demande d’effectuer une seule opération sur un lot de types de séries chronologiques. L’un des éléments « get », « put » ou « delete » doit être défini.
TypesBatchResponse

Réponse d’une seule opération sur un lot de types de séries chronologiques. L’une des valeurs « get », « put » ou « delete » sera définie.
TypesRequestBatchGetOrDelete

Demande d’obtention ou de suppression de types de séries chronologiques par ID ou nom de type. L’un des « typeIds » ou « noms » doit être défini.

AggregateVariable

La variable d’agrégation représente n’importe quel calcul d’agrégation. Les variables d’agrégation ne prennent pas en charge l’interpolation.

Nom Type Description
aggregation

Tsx

L’expression de série chronologique d’agrégation lorsque le type est « agrégat » est utilisée pour représenter l’agrégation qui doit être effectuée directement à l’aide de propriétés d’événement telles que « $event . Température ». Par exemple, l’agrégation pour calculer la plage de changements de température peut être écrite comme suit : « max($event. Température)-min($event. Température) ».
filter

Tsx

Filtrez les événements qui limitent le nombre d’événements pris en compte pour le calcul. Exemple : « $event. Status.String='Good' ». facultatif.
kind string:

aggregate

Les valeurs « kind » autorisées sont « numeric » ou « aggregate ». Alors que « numérique » vous permet de spécifier la valeur du signal reconstruit et l’expression pour les agréger, le type « agrégat » vous permet d’agréger directement sur les propriétés d’événement sans spécifier de valeur.

Boundary

Intervalle de temps à gauche et à droite de l’étendue de recherche à utiliser pour l’interpolation. Cela est utile dans les scénarios où les points de données sont manquants près du début ou de la fin de l’étendue de recherche d’entrée. Peuvent avoir la valeur null.

Nom Type Description
span

string

CategoricalVariable

La variable de catégorie représente le signal qui doit être analysé en fonction du nombre ou de la durée d’occurrence d’un ensemble limité de valeurs définies.

Nom Type Description
categories

TimeSeriesAggregateCategory[]

Catégorie utilisée dans les variables catégorielles. Une catégorie est définie par « label » et les « valeurs » auxquelles cette étiquette est attribuée.
defaultCategory

TimeSeriesDefaultCategory

Représente la catégorie par défaut.
filter

Tsx

Filtrez les événements qui limitent le nombre d’événements pris en compte pour le calcul. Exemple : « $event. Status.String='Good' ». facultatif.
interpolation

Interpolation

La variable de catégorie prend uniquement en charge l’interpolation « étape ».
kind string:

categorical

Les valeurs « kind » autorisées sont « numeric » ou « aggregate ». Alors que « numérique » vous permet de spécifier la valeur du signal reconstruit et l’expression pour les agréger, le type « agrégat » vous permet d’agréger directement sur les propriétés d’événement sans spécifier de valeur.
value

Tsx

L’expression de série chronologique value est utilisée pour représenter la valeur du signal qui va être classé. Il peut évaluer uniquement le type « String » ou « Long » pour les variables catégorielles.

Interpolation

Opération d’interpolation à effectuer sur les points de données brutes. Actuellement, seul l’échantillonnage de séries chronologiques interpolées est autorisé. Fonction d’agrégation autorisée - par exemple : left($value). Peut être null si aucune interpolation ne doit être appliquée.

Nom Type Description
boundary

Boundary

Intervalle de temps à gauche et à droite de l’étendue de recherche à utiliser pour l’interpolation. Cela est utile dans les scénarios où les points de données sont manquants près du début ou de la fin de l’étendue de recherche d’entrée. Peuvent avoir la valeur null.
kind

InterpolationKind

Type de technique d’interpolation : « Linéaire » ou « Step ».

InterpolationKind

Type de technique d’interpolation : « Linéaire » ou « Step ».

Nom Type Description
Linear

string

Step

string

NumericVariable

La variable numérique représente un seul signal numérique continu qui peut être reconstruit à l’aide de l’interpolation.

Nom Type Description
aggregation

Tsx

L’expression de série chronologique d’agrégation lorsque le type est « numérique » est utilisée pour représenter l’agrégation qui doit être effectuée sur l’expression $value. Cela nécessite que $value soient spécifiés et ne peut utiliser que $value à l’intérieur des fonctions d’agrégation. Par exemple, l’agrégation pour calculer le minimum de la $value est écrite comme suit : « min($value) ».
filter

Tsx

Filtrez les événements qui limitent le nombre d’événements pris en compte pour le calcul. Exemple : « $event. Status.String='Good' ». facultatif.
interpolation

Interpolation

Opération d’interpolation à effectuer sur les points de données brutes. Actuellement, seul l’échantillonnage de séries chronologiques interpolées est autorisé. Fonction d’agrégation autorisée - par exemple : left($value). Peut être null si aucune interpolation ne doit être appliquée.
kind string:

numeric

Les valeurs « kind » autorisées sont « numeric » ou « aggregate ». Alors que « numérique » vous permet de spécifier la valeur du signal reconstruit et l’expression pour les agréger, le type « agrégat » vous permet d’agréger directement sur les propriétés d’événement sans spécifier de valeur.
value

Tsx

L’expression de série chronologique value est utilisée pour représenter la valeur du signal qui va être agrégé ou interpolé. Par exemple, les valeurs de température de l’événement sont représentées comme suit : « $event. Temperature.Double ».

TimeSeriesAggregateCategory

Catégorie utilisée dans les variables catégorielles. Une catégorie est définie par « label » et les « valeurs » auxquelles cette étiquette est attribuée.

Nom Type Description
label

string

Nom de la catégorie qui sera utilisée pour construire les noms de variables de sortie.
values

object[]

Liste des valeurs auxquelles une catégorie est mappée. Il peut s’agir d’une liste unique de chaîne ou d’une liste de long.

TimeSeriesDefaultCategory

Représente la catégorie par défaut.

Nom Type Description
label

string

Nom de la catégorie par défaut qui sera affectée aux valeurs qui ne correspondent à aucune de celles définies dans les « catégories ».

TimeSeriesType

Le type de série chronologique définit des variables ou des formules pour effectuer des calculs sur des événements associés à des instances de série chronologique. Chaque série chronologique instance est associée à exactement un type. Un type peut avoir une ou plusieurs variables. Par exemple, une série chronologique instance peut être de type Capteur de température, qui se compose des variables température moyenne, température minimale et température maximale.

Nom Type Description
description

string

Description du type. Ce paramètre peut être null.
id

string

Identificateur de type unique respectant la casse qui est immuable. Peut être null sur les demandes de création ou de mise à jour, puis le serveur génère l’ID. Non null sur les opérations d’obtention et de suppression.
name

string

Nom unique donné par l’utilisateur pour le type. Mutable, et non null.
variables

object

Différentes variables associées au type. Non vide, pas null.

TimeSeriesTypeOrError

Résultat d’une opération par lot sur un type de série chronologique particulier. L’objet Type est défini lorsque l’opération réussit et que l’objet d’erreur est défini en cas d’échec de l’opération.

Nom Type Description
error

TsiErrorBody

Objet Error : défini en cas d’échec de l’opération.
timeSeriesType

TimeSeriesType

Objet de type série chronologique : défini lorsque l’opération réussit.

TsiError

Informations sur une erreur d’API.

Nom Type Description
error

TsiErrorBody

Erreur d’API particulière avec un code d’erreur et un message.

TsiErrorBody

Erreur d’API particulière avec un code d’erreur et un message.

Nom Type Description
code

string

Chaîne indépendante du langage et lisible par l’homme qui définit un code d’erreur spécifique au service. Ce code sert d’indicateur plus spécifique pour le code d’erreur HTTP spécifié dans la réponse. Peut être utilisé pour gérer par programmation des cas d’erreur spécifiques.
details

TsiErrorDetails[]

Contient des informations supplémentaires sur les erreurs. Ce paramètre peut être null.
innerError

TsiErrorBody

Contient une erreur plus spécifique qui limite la cause. Ce paramètre peut être null.
message

string

Représentation de l’erreur, lisible et indépendante de la langue. Il est destiné à aider les développeurs et n’est pas adapté à l’exposition aux utilisateurs finaux.
target

string

Cible de l’erreur particulière (par exemple, le nom de la propriété en erreur). Ce paramètre peut être null.

TsiErrorDetails

Informations supplémentaires sur l’erreur.

Nom Type Description
code

string

Chaîne indépendante du langage et lisible par l’homme qui définit un code d’erreur spécifique au service. Ce code sert d’indicateur plus spécifique pour le code d’erreur HTTP spécifié dans la réponse. Peut être utilisé pour gérer par programmation des cas d’erreur spécifiques.
message

string

Représentation de l’erreur, lisible et indépendante de la langue. Il est destiné à aider les développeurs et n’est pas adapté à l’exposition aux utilisateurs finaux.

Tsx

Expression de série chronologique (TSX) écrite sous la forme d’une chaîne unique. Exemples : « $event. Status.String='Good' », « avg($event. Température) ». Reportez-vous à la documentation sur l’écriture d’expressions de série chronologique.

Nom Type Description
tsx

string

Expression de série chronologique (TSX) écrite sous la forme d’une chaîne unique. Exemples : « $event. Status.String='Good' », « avg($event. Température) ». Reportez-vous à la documentation sur l’écriture d’expressions de série chronologique.

TypesBatchRequest

Demande d’effectuer une seule opération sur un lot de types de séries chronologiques. L’un des éléments « get », « put » ou « delete » doit être défini.

Nom Type Description
delete

TypesRequestBatchGetOrDelete

Définition des types de séries chronologiques à supprimer.
get

TypesRequestBatchGetOrDelete

Définition des types de séries chronologiques à retourner.
put

TimeSeriesType[]

Définition des types de séries chronologiques à mettre à jour ou à créer.

TypesBatchResponse

Réponse d’une seule opération sur un lot de types de séries chronologiques. L’une des valeurs « get », « put » ou « delete » sera définie.

Nom Type Description
delete

TsiErrorBody[]

Liste des objets d’erreur correspondant par position au tableau « delete » dans la demande - null lorsque l’opération réussit.
get

TimeSeriesTypeOrError[]

Liste des types ou objets d’erreur correspondant par position au tableau « get » dans la requête. L’objet Type est défini lorsque l’opération réussit et que l’objet d’erreur est défini en cas d’échec de l’opération.
put

TimeSeriesTypeOrError[]

Liste des types ou objets d’erreur correspondant par position au tableau « put » dans la requête. L’objet Type est défini lorsque l’opération réussit et que l’objet d’erreur est défini en cas d’échec de l’opération.

TypesRequestBatchGetOrDelete

Demande d’obtention ou de suppression de types de séries chronologiques par ID ou nom de type. L’un des « typeIds » ou « noms » doit être défini.

Nom Type Description
names

string[]

Liste des noms des types de séries chronologiques à retourner ou à supprimer.
typeIds

string[]

Liste des ID des types de séries chronologiques à retourner ou à supprimer.