Time Series Types - List

Referência

Service:: Time Series Insights

API Version:: 2020-07-31

Obtém tipos de série temporal em páginas.

GET https://{environmentFqdn}/timeseries/types?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. Atualmente, a versão com suporte é "2020-07-31".

Cabeçalho da solicitação

Nome	Tipo	Description
x-ms-continuation	string	Token de continuação da página anterior de resultados para recuperar a próxima página dos resultados em chamadas que dão suporte à paginação. Para obter os resultados da primeira página, especifique o token de continuação nula como valor de parâmetro. O token de continuação retornado será nulo se todos os resultados tiverem sido retornados e não houver nenhuma próxima página de resultados.
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 os 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 opcional da sessão do cliente. 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.

Respostas

Nome	Tipo	Description
200 OK	GetTypesPage	Operação com êxito. Headers x-ms-request-id: string
Other Status Codes	TsiError	Erro inesperado. Headers x-ms-request-id: string

Nome

Tipo

Description

200 OK

GetTypesPage

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

TypesListPage1

TypesListPage2

TypesListPage3

TypesListPage1

Sample Request

HTTP

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

Sample Response

Status code:: 200

{
  "types": [
    {
      "id": "1be09af9-f089-4d6b-9f0b-48018b5f7393",
      "name": "DefaultType",
      "description": "My Default type",
      "variables": {
        "EventCount": {
          "kind": "aggregate",
          "filter": null,
          "aggregation": {
            "tsx": "count()"
          }
        }
      }
    }
  ],
  "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0="
}

TypesListPage2

Sample Request

HTTP

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

Sample Response

Status code:: 200

{
  "types": [
    {
      "id": "9b84e946-7b36-4aa0-9d26-71bf48cb2aff",
      "name": "TurbineSensor",
      "description": "Wind turbine sensor",
      "variables": {
        "Value": {
          "kind": "numeric",
          "value": {
            "tsx": "$event.value.Double"
          },
          "aggregation": {
            "tsx": "avg($value)"
          }
        }
      }
    }
  ],
  "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrASI6MTAwMH0="
}

TypesListPage3

Sample Request

HTTP

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

Sample Response

Status code:: 200

{
  "types": []
}

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 final 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 de um conjunto limitado de valores definidos.
GetTypesPage	Lista parcial de tipos de série temporal retornados em uma única solicitação.
Interpolation	A operação de interpolação a ser executada nos pontos de dados brutos. Atualmente, apenas a amostragem de séries temporais interpoladas é 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 recebem 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.
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.

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 : "numérico" ou "aggregate". Embora "numérico" permita que você especifique o valor do sinal reconstruído e a expressão para agregá-los, o tipo "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 final 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 de um 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 recebem 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 : "numérico" ou "aggregate". Embora "numérico" permita que você especifique o valor do sinal reconstruído e a expressão para agregá-los, o tipo "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.

GetTypesPage

Lista parcial de tipos de série temporal retornados em uma única solicitação.

Nome	Tipo	Description
continuationToken	string	Se retornado, isso significa que os resultados atuais representam um resultado parcial. O token de continuação permite obter a próxima página de resultados. Para obter a próxima página de resultados da consulta, envie a mesma solicitação com o parâmetro de token de continuação no cabeçalho HTTP "x-ms-continuation".
types	TimeSeriesType[]	Lista parcial de tipos de série temporal retornados em uma única solicitação. Pode estar vazio se o servidor não puder preencher a página com mais tipos nesta solicitação ou se não houver mais tipos quando o token de continuação for nulo.

Interpolation

A operação de interpolação a ser executada nos pontos de dados brutos. Atualmente, apenas a amostragem de séries temporais interpoladas é 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 final 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 kind é "numeric" é usada para representar a agregação que precisa ser executada na expressão $value. Isso requer que $value sejam especificados e só podem 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, apenas a amostragem de séries temporais interpoladas é 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 : "numérico" ou "aggregate". Embora "numérico" permita que você especifique o valor do sinal reconstruído e a expressão para agregá-los, o tipo "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 recebem 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 mapeia. 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.

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 independente de idioma e legível por humanos do erro. Ele se destina como um auxílio aos 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 independente de idioma e legível por humanos do erro. Ele se destina como um auxílio aos 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.

Compartilhar via

Time Series Types - List

Parâmetros de URI

Cabeçalho da solicitação

Respostas

Segurança

azure_auth

Scopes

Exemplos

TypesListPage1

Sample Request

Sample Response

TypesListPage2

Sample Request

Sample Response

TypesListPage3

Sample Request

Sample Response

Definições

AggregateVariable

Boundary

CategoricalVariable

GetTypesPage

Interpolation

InterpolationKind

NumericVariable

TimeSeriesAggregateCategory

TimeSeriesDefaultCategory

TimeSeriesType

TsiError

TsiErrorBody

TsiErrorDetails

Tsx

Recursos adicionais