Compartilhar via

Time Series Types - Execute Batch

  • Referência
Service:
Time Series Insights
API Version:
2020-07-31

Executa uma operação get, create, update, delete em vários tipos de série temporal em lote.

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
environmentFqdn
 path True

string

Por FQDN de ambiente, por exemplo, 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com. Você pode obter esse nome de domínio da resposta da API Obter Ambientes, portal do Azure ou Resource Manager do Azure.
api-version
 query True

string

Versão da API a ser usada com a solicitação do cliente. A versão atualmente com suporte é "2020-07-31".

Cabeçalho da solicitação

Nome Obrigatório Tipo Description
x-ms-client-request-id

string

ID de solicitação de cliente opcional. O serviço registra esse valor. Permite que o serviço rastreie a operação entre serviços e permite que o cliente entre em contato com o suporte em relação a uma solicitação específica.
x-ms-client-session-id

string

ID de sessão do cliente opcional. O serviço registra esse valor. Permite que o serviço rastreie um grupo de operações relacionadas entre serviços e permite que o cliente entre em contato com o suporte em relação a um grupo específico de solicitações.

Corpo da solicitação

Nome Tipo Description
delete

TypesRequestBatchGetOrDelete

Definição de quais tipos de série temporal excluir.
get

TypesRequestBatchGetOrDelete

Definição de quais tipos de série temporal retornar.
put

TimeSeriesType[]

Definição de quais tipos de série temporal atualizar ou criar.

Respostas

Nome Tipo Description
200 OK

TypesBatchResponse

Operação com êxito.

Headers

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

TsiError

Erro inesperado.

Headers

x-ms-request-id: string

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory

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

Scopes

Nome Description
user_impersonation representar sua conta de usuário

Exemplos

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

Definições

Nome Description
AggregateVariable

A variável de agregação representa qualquer cálculo de agregação. As Variáveis de Agregação não dão suporte à interpolação.
Boundary

O intervalo de tempo à esquerda e à direita do intervalo de pesquisa a ser usado para Interpolação. Isso é útil em cenários em que os pontos de dados estão ausentes perto do início ou fim do intervalo de pesquisa de entrada. Pode ser nulo.
CategoricalVariable

A variável categórica representa o sinal que precisa ser analisado com base na contagem ou duração da ocorrência do conjunto limitado de valores definidos.
Interpolation

A operação de interpolação a ser executada nos pontos de dados brutos. Atualmente, somente a amostragem de série temporal interpolada é permitida. Função de agregação permitida – por exemplo: left($value). Pode ser nulo se nenhuma interpolação precisar ser aplicada.
InterpolationKind

O tipo de técnica de interpolação: "Linear" ou "Step".
NumericVariable

A variável numérica representa um único sinal numérico contínuo que pode ser reconstruído usando interpolação.
TimeSeriesAggregateCategory

Categoria usada em variáveis categóricas. Uma categoria é definida por 'label' e 'values' que são atribuídos a esse rótulo.
TimeSeriesDefaultCategory

Representa a categoria padrão.
TimeSeriesType

O tipo de série temporal define variáveis ou fórmulas para fazer computação em eventos associados a instâncias de série temporal. Cada instância de série temporal é associada a exatamente um tipo. Um tipo pode ter uma ou mais variáveis. Por exemplo, uma instância de série temporal pode ser do tipo Sensor de Temperatura, que consiste nas variáveis temperatura média, temperatura mínima e temperatura máxima.
TimeSeriesTypeOrError

Resultado de uma operação em lote em um tipo de série temporal específico. O objeto type é definido quando a operação é bem-sucedida e o objeto de erro é definido quando a operação não é bem-sucedida.
TsiError

Informações sobre um erro de API.
TsiErrorBody

Um erro de API específico com um código de erro e uma mensagem.
TsiErrorDetails

Informações adicionais de erro.
Tsx

Expressão de série temporal (TSX) escrita como uma única cadeia de caracteres. Exemplos: "$event. Status.String='Good'", "avg($event. Temperatura)". Consulte a documentação sobre como escrever expressões de série temporal.
TypesBatchRequest

Solicitação para executar uma única operação em um lote de tipos de série temporal. Exatamente um de "get", "put" ou "delete" deve ser definido.
TypesBatchResponse

Resposta de uma única operação em um lote de tipos de série temporal. Exatamente um de "get", "put" ou "delete" será definido.
TypesRequestBatchGetOrDelete

Solicitar para obter ou excluir tipos de série temporal por IDs ou nomes de tipo. Exatamente um dos "typeIds" ou "names" deve ser definido.

AggregateVariable

A variável de agregação representa qualquer cálculo de agregação. As Variáveis de Agregação não dão suporte à interpolação.

Nome Tipo Description
aggregation

Tsx

A expressão de série temporal de agregação quando kind é "aggregate" é usada para representar a agregação que precisa ser executada diretamente usando propriedades de evento como "$event. Temperatura". Por exemplo, a agregação para calcular o intervalo de alterações de temperatura pode ser gravada como: "max($event. Temperature)-min($event. Temperatura)".
filter

Tsx

Filtre os eventos que restringem o número de eventos que estão sendo considerados para computação. Exemplo: "$event. Status.String='Good'". Opcional.
kind string:

aggregate

Os valores "kind" permitidos são - "numeric" ou "aggregate". Embora "numérico" permita que você especifique o valor do sinal reconstruído e a expressão para agregá-los, o tipo de "agregação" permite agregar diretamente nas propriedades do evento sem especificar valor.

Boundary

O intervalo de tempo à esquerda e à direita do intervalo de pesquisa a ser usado para Interpolação. Isso é útil em cenários em que os pontos de dados estão ausentes perto do início ou fim do intervalo de pesquisa de entrada. Pode ser nulo.

Nome Tipo Description
span

string

CategoricalVariable

A variável categórica representa o sinal que precisa ser analisado com base na contagem ou duração da ocorrência do conjunto limitado de valores definidos.

Nome Tipo Description
categories

TimeSeriesAggregateCategory[]

Categoria usada em variáveis categóricas. Uma categoria é definida por 'label' e 'values' que são atribuídos a esse rótulo.
defaultCategory

TimeSeriesDefaultCategory

Representa a categoria padrão.
filter

Tsx

Filtre os eventos que restringem o número de eventos que estão sendo considerados para computação. Exemplo: "$event. Status.String='Good'". Opcional.
interpolation

Interpolation

A variável categórica dá suporte apenas à interpolação 'step'.
kind string:

categorical

Os valores "kind" permitidos são - "numeric" ou "aggregate". Embora "numérico" permita que você especifique o valor do sinal reconstruído e a expressão para agregá-los, o tipo de "agregação" permite agregar diretamente nas propriedades do evento sem especificar valor.
value

Tsx

A expressão de série temporal de valor é usada para representar o valor do sinal que será categorizado. Ele pode avaliar apenas o tipo 'String' ou 'Long' para variáveis categóricas.

Interpolation

A operação de interpolação a ser executada nos pontos de dados brutos. Atualmente, somente a amostragem de série temporal interpolada é permitida. Função de agregação permitida – por exemplo: left($value). Pode ser nulo se nenhuma interpolação precisar ser aplicada.

Nome Tipo Description
boundary

Boundary

O intervalo de tempo à esquerda e à direita do intervalo de pesquisa a ser usado para Interpolação. Isso é útil em cenários em que os pontos de dados estão ausentes perto do início ou fim do intervalo de pesquisa de entrada. Pode ser nulo.
kind

InterpolationKind

O tipo de técnica de interpolação: "Linear" ou "Step".

InterpolationKind

O tipo de técnica de interpolação: "Linear" ou "Step".

Nome Tipo Description
Linear

string

Step

string

NumericVariable

A variável numérica representa um único sinal numérico contínuo que pode ser reconstruído usando interpolação.

Nome Tipo Description
aggregation

Tsx

A expressão de série temporal de agregação quando o tipo é "numérico" é usada para representar a agregação que precisa ser executada na expressão $value. Isso requer que $value seja especificado e só pode usar $value dentro das funções de agregação. Por exemplo, a agregação para calcular o mínimo do $value é escrita como: "min($value)".
filter

Tsx

Filtre os eventos que restringem o número de eventos que estão sendo considerados para computação. Exemplo: "$event. Status.String='Good'". Opcional.
interpolation

Interpolation

A operação de interpolação a ser executada nos pontos de dados brutos. Atualmente, somente a amostragem de série temporal interpolada é permitida. Função de agregação permitida – por exemplo: left($value). Pode ser nulo se nenhuma interpolação precisar ser aplicada.
kind string:

numeric

Os valores "kind" permitidos são - "numeric" ou "aggregate". Embora "numérico" permita que você especifique o valor do sinal reconstruído e a expressão para agregá-los, o tipo de "agregação" permite agregar diretamente nas propriedades do evento sem especificar valor.
value

Tsx

A expressão de série temporal de valor é usada para representar o valor do sinal que será agregado ou interpolado. Por exemplo, os valores de temperatura do evento são representados da seguinte maneira: "$event. Temperature.Double".

TimeSeriesAggregateCategory

Categoria usada em variáveis categóricas. Uma categoria é definida por 'label' e 'values' que são atribuídos a esse rótulo.

Nome Tipo Description
label

string

O nome da categoria que será usada na construção dos nomes das variáveis de saída.
values

object[]

A lista de valores para os quais uma categoria é mapeada. Pode ser uma lista exclusiva de cadeia de caracteres ou uma lista de long.

TimeSeriesDefaultCategory

Representa a categoria padrão.

Nome Tipo Description
label

string

O nome da categoria padrão que será atribuída aos valores que não correspondem a nenhum dos definidos nas 'categorias'.

TimeSeriesType

O tipo de série temporal define variáveis ou fórmulas para fazer computação em eventos associados a instâncias de série temporal. Cada instância de série temporal é associada a exatamente um tipo. Um tipo pode ter uma ou mais variáveis. Por exemplo, uma instância de série temporal pode ser do tipo Sensor de Temperatura, que consiste nas variáveis temperatura média, temperatura mínima e temperatura máxima.

Nome Tipo Description
description

string

Descrição do tipo. Pode ser nulo.
id

string

Identificador de tipo exclusivo que diferencia maiúsculas de minúsculas que é imutável. Pode ser nulo em solicitações de criação ou atualização e, em seguida, o servidor gera a ID. Não é nulo em operações get e delete.
name

string

Nome exclusivo fornecido pelo usuário para o tipo. Mutável, não nulo.
variables

object

Variáveis diferentes associadas ao tipo. Não vazio, não nulo.

TimeSeriesTypeOrError

Resultado de uma operação em lote em um tipo de série temporal específico. O objeto type é definido quando a operação é bem-sucedida e o objeto de erro é definido quando a operação não é bem-sucedida.

Nome Tipo Description
error

TsiErrorBody

Objeto Error – definido quando a operação não for bem-sucedida.
timeSeriesType

TimeSeriesType

Objeto de tipo de série temporal – definido quando a operação for bem-sucedida.

TsiError

Informações sobre um erro de API.

Nome Tipo Description
error

TsiErrorBody

Um erro de API específico com um código de erro e uma mensagem.

TsiErrorBody

Um erro de API específico com um código de erro e uma mensagem.

Nome Tipo Description
code

string

Cadeia de caracteres legível e independente de linguagem que define um código de erro específico do serviço. Esse código serve como um indicador mais específico para o código de erro HTTP especificado na resposta. Pode ser usado para lidar programaticamente com casos de erro específicos.
details

TsiErrorDetails[]

Contém informações de erro adicionais. Pode ser nulo.
innerError

TsiErrorBody

Contém um erro mais específico que restringe a causa. Pode ser nulo.
message

string

Representação legível e independente da linguagem do erro. Ele se destina a auxiliar os desenvolvedores e não é adequado para exposição aos usuários finais.
target

string

Destino do erro específico (por exemplo, o nome da propriedade em erro). Pode ser nulo.

TsiErrorDetails

Informações adicionais de erro.

Nome Tipo Description
code

string

Cadeia de caracteres legível e independente de linguagem que define um código de erro específico do serviço. Esse código serve como um indicador mais específico para o código de erro HTTP especificado na resposta. Pode ser usado para lidar programaticamente com casos de erro específicos.
message

string

Representação legível e independente da linguagem do erro. Ele se destina a auxiliar os desenvolvedores e não é adequado para exposição aos usuários finais.

Tsx

Expressão de série temporal (TSX) escrita como uma única cadeia de caracteres. Exemplos: "$event. Status.String='Good'", "avg($event. Temperatura)". Consulte a documentação sobre como escrever expressões de série temporal.

Nome Tipo Description
tsx

string

Expressão de série temporal (TSX) escrita como uma única cadeia de caracteres. Exemplos: "$event. Status.String='Good'", "avg($event. Temperatura)". Consulte a documentação sobre como escrever expressões de série temporal.

TypesBatchRequest

Solicitação para executar uma única operação em um lote de tipos de série temporal. Exatamente um de "get", "put" ou "delete" deve ser definido.

Nome Tipo Description
delete

TypesRequestBatchGetOrDelete

Definição de quais tipos de série temporal excluir.
get

TypesRequestBatchGetOrDelete

Definição de quais tipos de série temporal retornar.
put

TimeSeriesType[]

Definição de quais tipos de série temporal atualizar ou criar.

TypesBatchResponse

Resposta de uma única operação em um lote de tipos de série temporal. Exatamente um de "get", "put" ou "delete" será definido.

Nome Tipo Description
delete

TsiErrorBody[]

Lista de objetos de erro correspondentes por posição à matriz "delete" na solicitação – nulo quando a operação for bem-sucedida.
get

TimeSeriesTypeOrError[]

Lista de tipos ou objetos de erro correspondentes por posição à matriz "get" na solicitação. O objeto type é definido quando a operação é bem-sucedida e o objeto de erro é definido quando a operação não é bem-sucedida.
put

TimeSeriesTypeOrError[]

Lista de tipos ou objetos de erro correspondentes por posição à matriz "put" na solicitação. O objeto type é definido quando a operação é bem-sucedida e o objeto de erro é definido quando a operação não é bem-sucedida.

TypesRequestBatchGetOrDelete

Solicitar para obter ou excluir tipos de série temporal por IDs ou nomes de tipo. Exatamente um dos "typeIds" ou "names" deve ser definido.

Nome Tipo Description
names

string[]

Lista de nomes de tipos de série temporal a serem retornados ou excluídos.
typeIds

string[]

Lista de IDs de tipos de série temporal a serem retornados ou excluídos.