Partilhar via

Time Series Types - Execute Batch

  • Referência
Serviço:
Time Series Insights
Versão da API:
2020-07-31

Executa uma operação de obtenção, criação, atualização e eliminação em vários tipos de série temporal.

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

Parâmetros do URI

Name Em Necessário Tipo Description
environmentFqdn
 path True

string

FQDN por ambiente, por exemplo, 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com. Pode obter este nome de domínio a partir da resposta da API Obter Ambientes, portal do Azure ou Resource Manager do Azure.
api-version
 query True

string

Versão da API a utilizar com o pedido de cliente. A versão atualmente suportada é "2020-07-31".

Cabeçalho do Pedido

Name Necessário Tipo Description
x-ms-client-request-id

string

ID de pedido de cliente opcional. O serviço regista este valor. Permite que o serviço rastreia a operação entre serviços e permite que o cliente contacte o suporte relativamente a um pedido específico.
x-ms-client-session-id

string

ID de sessão de cliente opcional. O serviço regista este valor. Permite que o serviço rastreia um grupo de operações relacionadas entre serviços e permite que o cliente contacte o suporte relativamente a um grupo específico de pedidos.

Corpo do Pedido

Name Tipo Description
delete

TypesRequestBatchGetOrDelete

Definição do tipo de série temporal a eliminar.
get

TypesRequestBatchGetOrDelete

Definição do tipo de série temporal a devolver.
put

TimeSeriesType[]

Definição do tipo de série temporal a atualizar ou criar.

Respostas

Name Tipo Description
200 OK

TypesBatchResponse

Operação bem-sucedida.

Cabeçalhos

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

TsiError

Erro inesperado.

Cabeçalhos

x-ms-request-id: string

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name Description
user_impersonation representar a sua conta de utilizador

Exemplos

TypesBatchDeleteByIds
TypesBatchDeleteByNames
TypesBatchGetByIds
TypesBatchGetByNames
TypesBatchPut

TypesBatchDeleteByIds

Pedido de amostra

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

Resposta da amostra

Código de estado:
200 
{
  "delete": [
    null
  ]
}

TypesBatchDeleteByNames

Pedido de amostra

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

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

Resposta da amostra

Código de estado:
200 
{
  "delete": [
    null
  ]
}

TypesBatchGetByIds

Pedido de amostra

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

Resposta da amostra

Código de estado:
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

Pedido de amostra

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

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

Resposta da amostra

Código de estado:
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

Pedido de amostra

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

Resposta da amostra

Código de estado:
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

Name Description
AggregateVariable

A variável agregada representa qualquer cálculo de agregação. As Variáveis de Agregação não suportam a interpolação.
Boundary

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

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

A operação de interpolação a executar nos pontos de dados não processados. Atualmente, só é permitida a amostragem de séries temporizadas interpoladas. Função de agregação permitida - por exemplo: esquerda($value). Pode ser nulo se não tiver de ser aplicada qualquer interpolação.
InterpolationKind

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

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

Categoria utilizada em variáveis categóricas. Uma categoria é definida por "etiqueta" e pelos "valores" atribuídos a esta etiqueta.
TimeSeriesDefaultCategory

Representa a categoria predefinida.
TimeSeriesType

O tipo de série temporal define variáveis ou fórmulas para efetuar cálculos em eventos associados a instâncias de série temporal. Cada instância de série temporal está 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 na temperatura média das variáveis, temperatura mínima e temperatura máxima.
TimeSeriesTypeOrError

Resultado de uma operação de lote num determinado tipo de série temporal. O objeto tipo é 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 específico da API com um código de erro e uma mensagem.
TsiErrorDetails

Informações de erro adicionais.
Tsx

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

Pedido para efetuar uma única operação num lote de tipos de série temporal. Exatamente um de "get", "put" ou "delete" tem de ser definido.
TypesBatchResponse

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

Pedido para obter ou eliminar tipos de série temporal por IDs ou nomes de tipos. É necessário definir exatamente um dos "typeIds" ou "names".

AggregateVariable

A variável agregada representa qualquer cálculo de agregação. As Variáveis de Agregação não suportam a interpolação.

Name Tipo Description
aggregation

Tsx

A expressão de série temporal de agregação quando o tipo é "agregado" é utilizada para representar a agregação que tem de ser executada diretamente com propriedades de eventos como "$event. Temperatura". Por exemplo, a agregação para calcular o intervalo de alterações de temperatura pode ser escrita como: "max($event. Temperatura)-min($event. Temperatura)".
filter

Tsx

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

aggregate

Os valores "kind" permitidos são : "numérico" ou "agregado". Embora "numérico" lhe permita especificar o valor do sinal reconstruído e a expressão para os agregar, o tipo "agregar" permite-lhe agregar diretamente as propriedades do evento sem especificar o valor.

Boundary

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

Name Tipo Description
span

string

CategoricalVariable

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

Name Tipo Description
categories

TimeSeriesAggregateCategory[]

Categoria utilizada em variáveis categóricas. Uma categoria é definida por "etiqueta" e pelos "valores" atribuídos a esta etiqueta.
defaultCategory

TimeSeriesDefaultCategory

Representa a categoria predefinida.
filter

Tsx

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

Interpolation

A variável categórica suporta apenas a interpolação "passo".
kind string:

categorical

Os valores "kind" permitidos são : "numérico" ou "agregado". Embora "numérico" lhe permita especificar o valor do sinal reconstruído e a expressão para os agregar, o tipo "agregar" permite-lhe agregar diretamente as propriedades do evento sem especificar o valor.
value

Tsx

A expressão de série temporal de valor é utilizada para representar o valor do sinal que vai ser categorizado. Só pode avaliar o tipo "Cadeia" ou "Longo" para variáveis categóricas.

Interpolation

A operação de interpolação a executar nos pontos de dados não processados. Atualmente, só é permitida a amostragem de séries temporizadas interpoladas. Função de agregação permitida - por exemplo: esquerda($value). Pode ser nulo se não tiver de ser aplicada qualquer interpolação.

Name Tipo Description
boundary

Boundary

O intervalo de tempo à esquerda e à direita do intervalo de pesquisa a utilizar para a Interpolação. Isto é útil em cenários em que os pontos de dados estão em falta 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 "Passo".

InterpolationKind

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

Name 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 com a interpolação.

Name Tipo Description
aggregation

Tsx

A expressão de série temporal de agregação quando o tipo é "numérico" é utilizada para representar a agregação que tem de ser efetuada na expressão $value. Isto requer $value a especificar e só pode utilizar $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 a ser considerados para computação. Exemplo: "$event. Status.String='Good'". Opcional.
interpolation

Interpolation

A operação de interpolação a executar nos pontos de dados não processados. Atualmente, só é permitida a amostragem de séries temporizadas interpoladas. Função de agregação permitida - por exemplo: esquerda($value). Pode ser nulo se não tiver de ser aplicada qualquer interpolação.
kind string:

numeric

Os valores "kind" permitidos são : "numérico" ou "agregado". Embora "numérico" lhe permita especificar o valor do sinal reconstruído e a expressão para os agregar, o tipo "agregar" permite-lhe agregar diretamente as propriedades do evento sem especificar o valor.
value

Tsx

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

TimeSeriesAggregateCategory

Categoria utilizada em variáveis categóricas. Uma categoria é definida por "etiqueta" e pelos "valores" atribuídos a esta etiqueta.

Name Tipo Description
label

string

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

object[]

A lista de valores aos quais uma categoria mapeia. Pode ser uma lista exclusiva de cadeia ou lista de longos.

TimeSeriesDefaultCategory

Representa a categoria predefinida.

Name Tipo Description
label

string

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

TimeSeriesType

O tipo de série temporal define variáveis ou fórmulas para efetuar cálculos em eventos associados a instâncias de série temporal. Cada instância de série temporal está 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 na temperatura média das variáveis, temperatura mínima e temperatura máxima.

Name Tipo Description
description

string

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

string

Identificador de tipo exclusivo sensível a maiúsculas e minúsculas imutável. Pode ser nulo ao criar ou atualizar pedidos e, em seguida, o servidor gera o ID. Não é nulo nas operações de obtenção e eliminação.
name

string

Nome exclusivo fornecido pelo utilizador para o tipo. Mutable, não nulo.
variables

object

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

TimeSeriesTypeOrError

Resultado de uma operação de lote num determinado tipo de série temporal. O objeto tipo é definido quando a operação é bem-sucedida e o objeto de erro é definido quando a operação não é bem sucedida.

Name Tipo Description
error

TsiErrorBody

Objeto de erro – definido quando a operação não é bem-sucedida.
timeSeriesType

TimeSeriesType

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

TsiError

Informações sobre um erro de API.

Name Tipo Description
error

TsiErrorBody

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

TsiErrorBody

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

Name Tipo Description
code

string

Cadeia de carateres independente de linguagem e legível por humanos que define um código de erro específico do serviço. Este código serve como um indicador mais específico para o código de erro HTTP especificado na resposta. Pode ser utilizado para processar programaticamente 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 reduz a causa. Pode ser nulo.
message

string

Representação legível por humanos e independente da linguagem do erro. Destina-se a ajudar os programadores e não é adequado para exposição aos utilizadores finais.
target

string

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

TsiErrorDetails

Informações de erro adicionais.

Name Tipo Description
code

string

Cadeia de carateres independente de linguagem e legível por humanos que define um código de erro específico do serviço. Este código serve como um indicador mais específico para o código de erro HTTP especificado na resposta. Pode ser utilizado para processar programaticamente casos de erro específicos.
message

string

Representação legível por humanos e independente da linguagem do erro. Destina-se a ajudar os programadores e não é adequado para exposição aos utilizadores finais.

Tsx

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

Name Tipo Description
tsx

string

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

TypesBatchRequest

Pedido para efetuar uma única operação num lote de tipos de série temporal. Exatamente um de "get", "put" ou "delete" tem de ser definido.

Name Tipo Description
delete

TypesRequestBatchGetOrDelete

Definição do tipo de série temporal a eliminar.
get

TypesRequestBatchGetOrDelete

Definição dos tipos de série temporal a devolver.
put

TimeSeriesType[]

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

TypesBatchResponse

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

Name Tipo Description
delete

TsiErrorBody[]

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

TimeSeriesTypeOrError[]

Lista de tipos ou objetos de erro correspondentes por posição à matriz "obter" no pedido. O objeto tipo é 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" no pedido. O objeto tipo é definido quando a operação é bem-sucedida e o objeto de erro é definido quando a operação não é bem sucedida.

TypesRequestBatchGetOrDelete

Pedido para obter ou eliminar tipos de série temporal por IDs ou nomes de tipos. É necessário definir exatamente um dos "typeIds" ou "names".

Name Tipo Description
names

string[]

Lista de nomes de tipos de série temporal para devolver ou eliminar.
typeIds

string[]

Lista de IDs de tipos de série temporal para devolver ou eliminar.