Consultar dados no Azure Time Series Insights Gen2
Nota
O serviço Time Series Insights será desativado em 7 de julho de 2024. Considere migrar os ambientes existentes para soluções alternativas o mais rápido possível. Para obter mais informações sobre a substituição e migração, visite nossa documentação.
O Azure Time Series Insights Gen2 permite a consulta de dados sobre eventos e metadados armazenados no ambiente por meio de APIs de superfície pública. 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. Eles podem ser usados para reunir a lista de ambientes aos quais o chamador tem acesso e metadados do ambiente.
- APIs de Consulta de Modelo de Série Temporal (TSM-Q): Permite criar, ler, atualizar e excluir operações (CRUD) em metadados armazenados no Modelo de Série Temporal do ambiente. Eles podem ser usados para acessar e editar as instâncias, tipos e hierarquias.
- APIs de Consulta de Série Temporal (TSQ): Permite a recuperação de dados de telemetria ou eventos à medida que são gravados do provedor de origem e permite cálculos e agregações de desempenho nos dados usando funções escalares e agregadas avançadas.
O Azure Time Series Insights Gen2 usa uma linguagem de expressão baseada em cadeia de caracteres, TSX (Time Series Expression), para expressar cálculos em Variáveis de Série Temporal.
Visão geral das APIs do Azure Time Series Insights Gen2
As APIs principais a seguir são suportadas.
APIs de ambiente
- Get Environments API: retorna a lista de ambientes que o chamador está autorizado a acessar.
- Get Environments Availability API: retorna a distribuição da contagem de eventos sobre o carimbo de data/hora
$ts
do evento. Essa API ajuda a determinar se há algum evento no ambiente, retornando a contagem de eventos divididos em intervalos de tempo, se houver. - Get Event Schema API: retorna os metadados do esquema de eventos para uma determinada faixa de pesquisa. Essa API ajuda a recuperar todos os metadados e propriedades disponíveis no esquema para uma determinada faixa de pesquisa.
APIs de consulta de modelo de série temporal (TSM-Q)
A maioria dessas APIs oferece suporte à operação de execução em lote para habilitar operações CRUD em 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 o CRUD em tipos de séries temporais e suas variáveis associadas.
- API de hierarquias: habilita o CRUD em hierarquias de séries temporais e seus caminhos de campo associados.
- API de instâncias: habilita o CRUD em instâncias de séries temporais e seus campos de instância associados. Além disso, a API de instâncias suporta as seguintes operações:
APIs de consulta de série temporal (TSQ)
Essas APIs estão disponíveis em ambas as lojas (quente e fria) em nossa solução de armazenamento multicamadas.
Obter API de Eventos: habilita a consulta e a recuperação de eventos brutos e os carimbos de data/hora de eventos associados à medida que são registrados no Azure Time Series Insights Gen2 do provedor de origem. Esta API permite a recuperação de eventos brutos para um determinado ID de Série Temporal e período de pesquisa. Esta API suporta paginação para recuperar o conjunto de dados de resposta completo para a entrada selecionada.
Importante
Como parte das próximas alterações nas regras de nivelamento e fuga de JSON, as matrizes serão armazenadas como tipo Dinâmico. As propriedades de carga útil armazenadas como esse tipo são acessíveis SOMENTE por meio da API Get Events.
API Get Series: Permite a consulta e a recuperação de valores computados e os carimbos de data/hora de eventos associados aplicando 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. Esta API suporta paginação para recuperar o conjunto de dados de resposta completo para a entrada selecionada.
API da série agregada: permite a consulta e a recuperação de valores agregados e dos carimbos de data/hora de intervalo associados aplicando 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. Esta API suporta paginação para recuperar o conjunto de dados de resposta completo para a entrada selecionada.
Para uma extensão e intervalo de pesquisa especificados, 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 contando ticks de época (o número de milissegundos que decorreram desde a época Unix - 1 de janeiro de 1970) e dividindo os ticks pelo tamanho do 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 amostrados do intervalo.
Seleção do tipo de loja
As APIs acima só podem ser executadas em um dos dois tipos de armazenamento (Frio ou Quente) em uma única chamada. Os parâmetros de URL de consulta são usados para especificar o tipo de armazenamento em que a consulta deve ser executada.
Se nenhum parâmetro for especificado, a consulta será executada no Cold Store, por padrão. Se uma consulta abranger um intervalo de tempo sobreposto ao armazenamento Frio e Quente, é recomendável rotear a consulta para o Repositório Frio para obter a melhor experiência, já que o Armazenamento Quente conterá apenas dados parciais.
O Azure Time Series Insights Explorer e o Power BI Connector fazem chamadas para as APIs acima e selecionarão automaticamente o parâmetro storeType correto quando relevante.
Próximos passos
- Leia mais sobre as diferentes variáveis que podem ser definidas no Modelo de Série Temporal.
- Leia mais sobre como consultar dados do Azure Time Series Insights Explorer.