Consulta de dados do Azure Time Series Insights Gen2

  • Artigo

Observação

O serviço TSI (Time Series Insights) não terá mais suporte após março de 2025. Considere migrar os ambientes existentes do TSI para soluções alternativas assim que possível. Para obter mais informações sobre a substituição e a migração, visite nossa documentação.

O Azure Time Series Insights Gen2 permite consultar dados em eventos e metadados armazenados no ambiente por meio de APIs de superfície públicas. Essas APIs também são usadas pelo Azure Time Series Insights TSI Explorer.

Três categorias principais de API estão disponíveis no Azure Time Series Insights Gen2:

  • APIs de ambiente: essas APIs habilitam consultas no próprio ambiente do Azure Time Series Insights Gen2. Elas podem ser usadas para reunir a lista de ambientes a que o chamador tem acesso e metadados do ambiente.
  • APIs TSM-Q (consulta de modelo de série temporal) : habilitam operações CRUD (criação, leitura, atualização e exclusão) em metadados armazenados no modelo de série temporal do ambiente. Elas podem ser utilizadas para acessar e editar instâncias, tipos e hierarquias.
  • APIs TSQ (consulta de série temporal) : habilita a recuperação de dados de telemetria ou eventos conforme são registrados no provedor de origem e permite cálculos e agregações de alto desempenho nos dados usando funções escalares e de agregação avançadas.

O Azure Time Series Insights Gen2 usa uma linguagem de expressão baseada em cadeia de caracteres avançada, a TSX (expressão de série temporal), para expressar cálculos em variáveis de série temporal.

Visão geral das APIs do Azure Time Series Insights Gen2

Há suporte para as APIs principais a seguir.

Visão geral da consulta de série temporal

APIs de ambiente

  • API de Obtenção de Ambientes: retorna a lista de ambientes que o chamador está autorizado a acessar.
  • API de Obtenção da Disponibilidade de Ambientes: retorna a distribuição da contagem de eventos de acordo com o carimbo de data/hora do evento . Essa API ajuda a determinar se há algum evento no ambiente por meio do retorno da contagem de eventos dividida em intervalos de tempo, se existir algum.
  • API de Obtenção de Esquema de Eventos: retorna os metadados do esquema de eventos para um intervalo de pesquisa fornecido. Essa API ajuda a recuperar todos os metadados e as propriedades disponíveis no esquema para determinado período pesquisado.

APIs TSM-Q (Consulta do modelo do Time Series)

A maioria dessas APIs aceita a operação de execução em lote para habilitar operações CRUD de lote em várias entidades do modelo de série temporal:

  • API de Configurações do Modelo: habilita GET e PATCH no tipo padrão e no nome do modelo do ambiente.
  • API de Tipos: habilita CRUD em tipos de série temporal e as variáveis associadas.
  • API Hierarchies: habilita CRUD em hierarquias de série temporal e os caminhos de campo associados.
  • API de Instâncias: habilita CRUD em instâncias de série temporal e os campos de instância associados. Além disso, a API de Instâncias aceita as seguintes operações:
    • Pesquisa: recupera uma lista parcial de ocorrências na pesquisa para instâncias de série temporal com base em atributos de instância.
    • Sugestão: pesquisa e sugere uma lista parcial de ocorrências na pesquisa para instâncias de série temporal com base em atributos de instância.

APIs TSQ (consulta de série temporal)

Essas APIs estão disponíveis nos dois repositórios (warm e cold) em nossa solução de armazenamento em várias camadas.

  • API de Obtenção de Eventos: habilita a consulta e a recuperação de eventos brutos e os carimbos de data/hora do evento associado, pois eles são registrados no Azure Time Series Insights Gen2 do provedor de origem. Essa API permite a recuperação de eventos brutos para uma determinada ID de série temporal e intervalo de pesquisa. Essa API aceita paginação para recuperar o conjunto de dados de resposta completo para a entrada selecionada.

    Importante

    Como parte das alterações futuras nas regras de saída e mesclagem de JSON, as matrizes serão armazenadas como um tipo Dinâmico. As propriedades de payload armazenadas como esse tipo SÓ podem ser acessadas por meio da API Get Events.

  • API de Obtenção da Série: habilita a consulta e a recuperação de valores computados e os carimbos de data/hora do evento associado por meio da aplicação de cálculos definidos por variáveis em eventos brutos. Essas variáveis podem ser definidas no modelo de série temporal ou fornecidas embutidas na consulta. Essa API aceita paginação para recuperar o conjunto de dados de resposta completo para a entrada selecionada.

  • API de Agregação de Série: habilita a consulta e a recuperação de valores agregados e os carimbos de data/hora do intervalo associado por meio da aplicação de cálculos definidos por variáveis em eventos brutos. Essas variáveis podem ser definidas no modelo de série temporal ou fornecidas embutidas na consulta. Essa API aceita paginação para recuperar o conjunto de dados de resposta completo para a entrada selecionada.

    Para um intervalo e período de pesquisa especificado, essa API retorna uma resposta agregada por intervalo por variável para uma ID de série temporal. O número de intervalos no conjunto de dados de resposta é calculado por meio da contagem de tiques de época (o número de milissegundos decorridos desde a época do UNIX – 1º de janeiro de 1970) e da divisão dos tiques pelo tamanho do período de intervalo especificado na consulta.

    Os carimbos de data/hora retornados no conjunto de respostas são dos limites do intervalo esquerdo, não dos eventos de amostra do intervalo.

Selecionar o tipo de repositório

As APIs acima só podem ser executadas em um dos dois tipos de armazenamento (cold ou warm) em uma única chamada. Os parâmetros de URL de consulta são usados para especificar o tipo de repositório no qual a consulta deve ser executada.

Se nenhum parâmetro for especificado, a consulta será executada no repositório cold, por padrão. Se uma consulta abranger um intervalo de tempo que sobrepõe um repositório cold e warm, é recomendável rotear a consulta para o repositório cold para ter a melhor experiência, uma vez que o repositório warm conterá apenas dados parciais.

O Gerenciador do Time Series Insights do Azure e o conector do Power BI fazem chamadas para as APIs acima e selecionarão automaticamente o parâmetro storeType correto, quando for relevante.

Próximas etapas