Partilhar via

APIs de Modelo do Azure Time Series Insights Gen2

  • Artigo

Descrição Geral

Cada um dos três componentes que fazem um Modelo de Série Temporal (instâncias, hierarquias e tipos) têm APIs REST correspondentes que suportam operações CREATE, READ, UPDATE e DELETE, paginadas e/ou em lotes.

  • A API de Instância suporta operações GET paginadas, operações CREATE, READ, UPDATE e DELETE paginadas, pesquisa e sugestões de palavras-chave para operações de pesquisa.
  • A API de Hierarquia suporta operações GET paginadas e operações CREATE, READ, UPDATE e DELETE paginadas.
  • A API de Tipo suporta operações GET paginadas e operações CREATE, READ, UPDATE e DELETE paginadas.

Uma quarta API fornece suporte REST para definições do Modelo de Série Temporal:

  • A API de Definições de Modelo suporta operações HTTP GET e UPDATE para definições de configuração do Modelo de Série Temporal. Leia o Modelo de Série Temporal para obter informações detalhadas sobre o Modelo de Série Temporal e definições de instância, hierarquia e tipo .

API de Instâncias

A API de Instâncias permite que as operações CREATE, READ, UPDATE e DELETE sejam executadas em Instâncias de Série Temporal:

  • A API Get Instances devolve todas as Instâncias de Série Temporal que correspondem ao pedido.

  • A API Gerir Instâncias permite operações em lotes em instâncias. Todas as operações nesta API são operações HTTP POST . Cada operação aceita um payload. O payload é um objeto JSON. Este objeto define uma única propriedade. A chave de propriedade é o nome de uma operação permitida pela API. As operações suportadas são PUT, UPDATE e DELETE.

  • Estas APIs permitem a deteção de Instâncias de Série Temporal:

    • Sugerir ativará cenários de preenchimento automático ao procurar uma instância.
    • A pesquisa ajuda a identificar as instâncias com base nas palavras-chave fornecidas.

    Dica

    Leia mais sobre as funcionalidades de consulta de Pesquisa abaixo.

API hierarquias

A API Hierarquias permite CRIAR, LER, ATUALIZAR e ELIMINAR em Hierarquias de Série Temporal.

API Descrição
Obter API de Hierarquias Devolve todas as Hierarquias de Série Temporal que correspondem ao pedido.
Gerir APIs de Hierarquias Ativa operações em lotes em hierarquias. Todas as operações nesta API são operações HTTP POST . Cada operação aceita um payload. O payload é um objeto JSON. Este objeto define uma única propriedade. A chave de propriedade é o nome de uma operação que a API permite. As operações suportadas são PUT, UPDATE e DELETE.

API de Tipos

A API de Tipos permite CRIAR, LER, ATUALIZAR e ELIMINAR em Tipos de Série Temporal e as respetivas variáveis associadas.

API Descrição
Obter API de Tipos Devolve todos os Tipos de Série Temporal e as variáveis associadas.
API de Tipos de Publicação Ativa operações em lotes em tipos. Todas as operações nesta API são operações HTTP POST . Cada operação aceita um payload. O payload é um objeto JSON. Este objeto define uma única propriedade. A chave de propriedade é o nome de uma operação que a API permite. As operações suportadas são PUT, UPDATE e DELETE.

API de Definições de Modelo

A API de Definições de Modelo permite CRIAR, LER, ATUALIZAR e ELIMINAR em modelos criados automaticamente no ambiente por TimeSeriesIds.

API Descrição
Obter API de Definições de Modelo Devolve o modelo criado automaticamente no ambiente para TimeSeriesIds.
Atualizar API de Definições de Modelo Atualizações o modelo no ambiente para TimeSeriesIds com os novos valores fornecidos no pedido.

Funcionalidades de pesquisa

Pesquisas de carateres universais

Suportamos pesquisas de carateres universais de carateres únicos e múltiplos dentro de termos únicos (não em pesquisas de expressões).

Caráter único

Para efetuar uma pesquisa de carateres universais de um único caráter, utilize o ? símbolo . A pesquisa de caráter universal de caráter único procura termos que correspondam à cadeia com o caráter único substituído.

Para procurar ou texttest, pesquise: te?t.

Múltiplos carateres

Para efetuar uma pesquisa de carateres universais de múltiplos carateres, utilize o * símbolo . As pesquisas de carateres universais múltiplos procuram zero ou mais carateres.

Para procurar test, testsou tester, utilize a pesquisa: test*.

Também pode utilizar as pesquisas de carateres universais a meio de um termo. Para procurar dryer, pode utilizar a pesquisa: dr*r.

Operadores Booleanos

Os operadores booleanos permitem que os termos sejam combinados através de operadores lógicos. Suportamos OPERADORES E, OR, +, -E NÃO como operadores booleanos.

Importante

  • Os operadores booleanos têm de estar em ALL CAPS.
  • Os operadores booleanos têm de ser separados das cláusulas de pesquisa através de espaços em branco.
  • dryer AND washer é válido, mas não dryer ANDwasher.

Operador AND

O operador AND corresponde a documentos em que ambos os termos existem no texto de um único documento.

Para procurar documentos que contenham dryer washer e foo bar utilizem a pesquisa: dryer washer AND foo bar.

Nota

O símbolo && pode ser utilizado em vez do operador E.

Operador OR

O operador OR liga dois termos e localiza um documento correspondente se existir um dos termos num documento. O operador OR é o operador de conjunção predefinido. Isto significa que, se não existir nenhum operador booleano entre dois termos, é utilizado o operador OR .

Para procurar documentos que contenham ou dryer washer utilize qualquer dryer uma das seguintes pesquisas:

  1. 'dryer washer' dryer
  2. 'dryer washer' OR dryer

Nota

O símbolo || pode ser utilizado em vez do operador OU.

+ Operador

O + operador ou necessário requer que o termo após o + símbolo exista algures num campo de um único documento.

Para procurar documentos que têm de conter dryer e podem conter washer , utilize a pesquisa: +dryer washer.

- Operador

O - operador de proibição ou exclui documentos que contenham o termo após o - símbolo.

Para procurar documentos que contenham dryer washer , mas não foo bar utilizem a pesquisa: dryer washer -foo bar.

NOT

O operador NOT exclui os documentos que contêm o termo após NOT.

Para procurar documentos que contenham dryer washer , mas não foo bar utilizem a pesquisa: dryer washer NOT foo bar.

O operador NOT não pode ser utilizado com apenas um termo.

A pesquisa seguinte não devolverá resultados: NOT dryer washer.

Nota

O símbolo ! pode ser utilizado em vez do operador NÃO.

  • Tem de preceder imediatamente o termo de pesquisa excluído.
  • dryer !washer é válido, mas não dryer ! washer.

Ver também

  • Para obter mais informações sobre o registo de aplicações e o modelo de programação do Azure Active Directory, veja Azure Active Directory para programadores.

  • Para saber mais sobre os parâmetros de pedido e autenticação, leia Autenticação e autorização.

  • As ferramentas que ajudam a testar pedidos e respostas HTTP incluem:

  • Fiddler. Este proxy de depuração web gratuito pode intercetar os seus pedidos REST, para que possa diagnosticar o pedido HTTP e as mensagens de resposta.

  • JWT.io. Pode utilizar esta ferramenta para capturar rapidamente as afirmações no token de portador e, em seguida, validar os respetivos conteúdos.

  • Postman. Esta é uma ferramenta de teste de resposta e pedido HTTP gratuita para depurar APIs REST.

  • Saiba mais sobre Azure Time Series Insights Gen2 ao rever a documentação da Gen2.