你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Azure 时序见解 Gen2 模型 API

概述

使 时序模型 (实例层次结构类型) 的三个组件都具有相应的 REST API,这些 API 支持 CREATEREADUPDATEDELETE、分页和/或批处理操作。

  • 实例 API 支持分页 GET 操作、批量 CREATEREADUPDATEDELETE 操作、搜索和关键字 (keyword) 搜索操作建议。
  • 层次结构 API 支持分页 GET 操作以及批量 CREATEREADUPDATEDELETE 操作。
  • 类型 API 支持分页 GET 操作以及批量 CREATEREADUPDATEDELETE 操作。

第四个 API 为时序模型设置提供 REST 支持:

  • 模型设置 API 支持时序模型配置设置的 HTTP GETUPDATE 操作。 有关 时序模型 以及 实例层次结构类型 定义的详细信息,请阅读时序模型。

实例 API

实例 API 允许对时序实例执行 CREATEREADUPDATEDELETE 操作:

  • 获取实例 API 返回与请求匹配的所有时序实例。

  • 管理实例 API 支持对实例执行批处理操作。 针对此 API 的所有操作都是 HTTP POST 操作。 每个操作都接受一个有效负载。 有效负载是 JSON 对象。 此对象定义单个属性。 属性键是 API 允许的操作的名称。 支持的操作包括 PUTUPDATEDELETE

  • 这些 API 支持发现时序实例:

    • 建议 将在搜索实例时启用自动完成方案。
    • 搜索 有助于根据提供的关键字标识实例。

    提示

    阅读下面的 搜索查询功能

层次结构 API

层次结构 API 对时序层次结构启用 CREATEREADUPDATEDELETE

API 说明
获取层次结构 API 返回与请求匹配的所有时序层次结构。
管理层次结构 API 对层次结构启用批处理操作。 针对此 API 的所有操作都是 HTTP POST 操作。 每个操作都接受一个有效负载。 有效负载是 JSON 对象。 此对象定义单个属性。 属性键是 API 允许的操作的名称。 支持的操作包括 PUTUPDATEDELETE

类型 API

类型 API 对时序类型及其关联的变量启用 CREATEREADUPDATEDELETE

API 说明
获取类型 API 返回所有时序类型及其关联的变量。
帖子类型 API 对类型启用批处理操作。 针对此 API 的所有操作都是 HTTP POST 操作。 每个操作都接受一个有效负载。 有效负载是 JSON 对象。 此对象定义单个属性。 属性键是 API 允许的操作的名称。 支持的操作包括 PUTUPDATEDELETE

模型设置 API

模型设置 API 通过 TimeSeriesIds 在环境中自动创建的模型上启用 CREATEREADUPDATEDELETE

API 说明
获取模型设置 API 返回 TimeSeriesIds 环境中自动创建的模型。
更新模型设置 API 使用请求中提供的新值在 TimeSeriesIds 环境中汇报模型。

搜索功能

通配符搜索

我们支持在单个字词内进行单字符通配符搜索, (不支持在短语搜索) 中搜索。

单个字符

若要执行单个字符通配符搜索,请使用 ? 符号。 单字符通配符搜索查找与替换了单个字符的字符串匹配的字词。

若要搜索 texttest,请搜索: te?t

多个字符

若要执行多字符通配符搜索,请使用 * 符号。 多字符通配符搜索查找零个或多个字符。

若要搜索 testteststester,请使用搜索: test*

还可以在字词中间使用通配符搜索。 若要搜索 dryer,可以使用搜索: dr*r

布尔运算符

布尔运算符允许通过逻辑运算符组合字词。 我们支持将 ANDOR+-、 和 NOT 作为布尔运算符。

重要

  • 布尔运算符必须位于所有 CAPS 中。
  • 必须使用空格将布尔运算符与搜索子句分开。
  • dryer AND washer 有效,但无效 dryer ANDwasher

AND 运算符

AND 运算符匹配同时存在于单个文档文本中的任意位置的文档。

若要搜索包含 dryer washer 的文档, foo bar 请使用搜索: dryer washer AND foo bar

注意

&&符号可用于代替运算符 AND

OR 运算符

OR 运算符链接两个术语,如果文档中存在任何一个术语,则查找匹配的文档。 OR 运算符是默认的连词运算符。 这意味着,如果两个字词之间没有布尔运算符,则使用 OR 运算符。

若要搜索包含 dryer washer 或 仅 dryer 使用以下任一搜索的文档:

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

注意

||符号可用于代替运算符 OR

+ 运算符

+或 必需运算符要求符号后面的+字词存在于单个文档的字段中的某个位置。

若要搜索必须包含 dryer 且可能包含 washer 的文档,请使用搜索: +dryer washer

- 运算符

-或 禁止运算符排除符号后-包含术语的文档。

若要搜索包含 dryer washer 但不包含 foo bar 的文档,请使用搜索: dryer washer -foo bar

NOT

NOT 运算符排除包含 后NOT一词的文档。

若要搜索包含 dryer washer 但不包含 foo bar 的文档,请使用搜索: dryer washer NOT foo bar

NOT 运算符不能只与一个术语一起使用。

以下搜索将不返回任何结果: NOT dryer washer

注意

!符号可用于代替运算符 NOT

  • 它必须紧接在排除的搜索词之前。
  • dryer !washer 有效,但无效 dryer ! washer

另请参阅

  • 有关应用程序注册和 Azure Active Directory 编程模型的详细信息,请参阅 面向开发人员的 Azure Active Directory

  • 若要了解请求和身份验证参数,请阅读 身份验证和授权

  • 帮助测试 HTTP 请求和响应的工具包括:

  • 菲德勒 此免费的 Web 调试代理可以截获 REST 请求,因此你可以诊断 HTTP 请求和响应消息。

  • JWT.io。 可以使用此工具快速转储持有者令牌中的声明,然后验证其内容。

  • Postman。 这是一个免费的 HTTP 请求和响应测试工具,用于调试 REST API。

  • 查看 Gen2 文档,详细了解 Azure 时序见解 Gen2