APIs do modelo Azure Time Series Insights Gen2

  • Artigo

Visão geral

Cada um dos três componentes que fazem um Modelo de Série Temporal (instâncias, hierarquias e tipos) tem APIs REST correspondentes que dão suporte a operações CREATE, READ, UPDATE e DELETE, paginadas e/ou em lote.

  • A API de Instância dá suporte a operações GET paginadas, operações CREATE, READ, UPDATE e DELETE, pesquisa e sugestões de palavra-chave para operações de pesquisa.
  • A API hierarchy dá suporte a operações GET paginadas e operações CREATE, READ, UPDATE e DELETE em lote.
  • A API de Tipo dá suporte a operações GET paginadas e operações CREATE, READ, UPDATE e DELETE em lote.

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

  • A API de Configurações de Modelo dá suporte a operações HTTP GET e UPDATE para definições de configuração do Modelo de Série Temporal. Leia Modelo de Série Temporal para obter informações detalhadas sobre o Modelo de Série Temporal e as 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 Obter Instâncias retorna todas as Instâncias de Série Temporal que correspondem à solicitação.

  • A API Gerenciar Instâncias habilita operações em lote em instâncias. Todas as operações nessa API são operações HTTP POST . Cada operação aceita uma carga. O conteúdo é um objeto JSON. Esse objeto define uma única propriedade. A chave de propriedade é o nome de uma operação permitida pela API. As operações com suporte são PUT, UPDATE e DELETE.

  • Essas APIs permitem a descoberta de Instâncias de Série Temporal:

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

    Dica

    Leia sobre os recursos de consulta de pesquisa abaixo.

API de hierarquias

A API de Hierarquias habilita CREATE, READ, UPDATE e DELETE em hierarquias de série temporal.

API Descrição
Obter API de Hierarquias Retorna todas as Hierarquias de Série Temporal que correspondem à solicitação.
Gerenciar APIs de Hierarquias Habilita operações em lotes em hierarquias. Todas as operações nessa API são operações HTTP POST . Cada operação aceita uma carga. O conteúdo é um objeto JSON. Esse objeto define uma única propriedade. A chave de propriedade é o nome de uma operação que a API permite. As operações com suporte são PUT, UPDATE e DELETE.

API de tipos

A API types habilita CREATE, READ, UPDATE e DELETE em tipos de série temporal e suas variáveis associadas.

API Descrição
Obter API de Tipos Retorna todos os Tipos de Série Temporal e suas variáveis associadas.
API pós-tipos Habilita operações em lotes em tipos. Todas as operações nessa API são operações HTTP POST . Cada operação aceita uma carga. O conteúdo é um objeto JSON. Esse objeto define uma única propriedade. A chave de propriedade é o nome de uma operação que a API permite. As operações com suporte são PUT, UPDATE e DELETE.

API de Configurações de Modelo

A API de Configurações de Modelo habilita CREATE, READ, UPDATE e DELETE em modelos criados automaticamente no ambiente por TimeSeriesIds.

API Descrição
Obter API de Configurações de Modelo Retorna o modelo criado automaticamente no ambiente para TimeSeriesIds.
Atualizar a API de Configurações de Modelo Atualizações o modelo no ambiente para TimeSeriesIds com os novos valores fornecidos na solicitação.

Recursos de pesquisa

Pesquisas com curinga

Damos suporte a pesquisas curinga de caractere único e múltiplo em termos únicos (não dentro de pesquisas de frases).

Caractere único

Para executar uma pesquisa curinga de caractere único, use o ? símbolo . A pesquisa curinga de caractere único procura termos que correspondam à cadeia de caracteres com o caractere único substituído.

Para pesquisar por ou texttest, pesquise: te?t.

Vários caracteres

Para executar uma pesquisa curinga de vários caracteres, use o * símbolo . Várias pesquisas de caracteres curinga procuram zero ou mais caracteres.

Para pesquisar test, testsou tester, use a pesquisa: test*.

Você também pode usar as pesquisas curinga no meio de um termo. Para pesquisar , dryervocê pode usar a pesquisa: dr*r.

Operadores boolianos

Os operadores boolianos permitem que os termos sejam combinados por meio de operadores lógicos. Damos suporte a AND, OR, +, -e NOT como operadores boolianos.

Importante

  • Os operadores boolianos devem estar em ALL CAPS.
  • Os operadores boolianos devem ser separados das cláusulas de pesquisa usando 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 em qualquer lugar no texto de um único documento.

Para pesquisar documentos que contenham dryer washer e foo bar usem a pesquisa: dryer washer AND foo bar.

Observação

O símbolo && pode ser usado no lugar do operador AND.

Operador OR

O operador OR vincula dois termos e localiza um documento correspondente se um dos termos existir em um documento. O operador OR é o operador de conjunção padrão. Isso significa que, se não houver nenhum operador booliano entre dois termos, o operador OR será usado.

Para pesquisar documentos que contenham dryer washer ou usem apenas dryer qualquer uma das seguintes pesquisas:

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

Observação

O símbolo || pode ser usado no lugar do operador OR.

Operador +

O + operador ou obrigatório requer que o termo após o + símbolo exista em algum lugar em um campo de um único documento.

Para pesquisar documentos que devem conter dryer e podem conter washer , use a pesquisa: +dryer washer.

Operador -

O - operador or prohibit exclui documentos que contêm o termo após o - símbolo.

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

NOT

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

Para pesquisar documentos que contêm dryer washer , mas não foo bar usam a pesquisa: dryer washer NOT foo bar.

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

A pesquisa a seguir não retornará nenhum resultado: NOT dryer washer.

Observação

O símbolo ! pode ser usado no lugar do operador NOT.

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

Confira também

  • Para obter mais informações sobre o registro de aplicativos e o modelo de programação do Azure Active Directory, consulte Azure Active Directory para desenvolvedores.

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

  • As ferramentas que ajudam a testar solicitações e respostas HTTP incluem:

  • Fiddler. Esse proxy de depuração da Web gratuito pode interceptar suas solicitações REST, para que você possa diagnosticar as mensagens de solicitação e resposta HTTP.

  • JWT.io. Você pode usar essa ferramenta para despejar rapidamente as declarações em seu token de portador e, em seguida, validar seu conteúdo.

  • O Postman. Essa é uma ferramenta gratuita de teste de resposta e solicitação HTTP para depuração de APIs REST.

  • Saiba mais sobre Azure Time Series Insights Gen2 examinando a documentação do Gen2.