通过

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

Model Settings - Update

服务:
Time Series Insights
API 版本:
2020-07-31

更新时序模型设置 - 模型名称或默认类型 ID。

PATCH https://{environmentFqdn}/timeseries/modelSettings?api-version=2020-07-31

URI 参数

名称 在 必需 类型 说明
environmentFqdn
 path True

string

每个环境 FQDN，例如 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com。 可以从 Get Environments API、Azure 门户或 Azure 资源管理器的响应中获取此域名。
api-version
 query True

string

要用于客户端请求的 API 的版本。 当前支持的版本为“2020-07-31”。

请求头

名称 必需 类型 说明
x-ms-client-request-id

string

可选的客户端请求 ID。 服务记录此值。 允许服务跨服务跟踪作，并允许客户联系有关特定请求的支持人员。
x-ms-client-session-id

string

可选的客户端会话 ID。 服务记录此值。 允许服务跨服务跟踪一组相关作，并允许客户联系有关特定请求组的支持人员。

请求正文

名称 类型 说明
defaultTypeId

string

新实例将自动属于的模型的默认类型 ID。
name

string

模型显示名称，显示在 UX 中，可由用户更改。 初始值为“DefaultModel”。

响应

名称 类型 说明
200 OK

ModelSettingsResponse

成功作将返回新的完整模型设置。

标头

x-ms-request-id: string
Other Status Codes

TsiError

意外错误。

标头

x-ms-request-id: string

安全性

azure_auth

Azure Active Directory OAuth2 流

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

ModelSettingsUpdateName

示例请求

PATCH https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/modelSettings?api-version=2020-07-31

{
  "name": "Thermostats"
}

示例响应

状态代码:
200 
{
  "modelSettings": {
    "name": "Thermostats",
    "timeSeriesIdProperties": [
      {
        "name": "DeviceId",
        "type": "String"
      }
    ],
    "defaultTypeId": "5AB70D71-A8CD-410E-B70D-6F04AB9C132C"
  }
}

定义

名称 说明
ModelSettingsResponse

包含完整时序模型设置的响应，包括模型名称、时序 ID 属性和默认类型 ID。
TimeSeriesIdProperty

单个属性的定义，可在环境创建期间定义的时序 ID 属性中使用。
TimeSeriesIdPropertyTypes

属性类型。 目前仅支持“字符串”。
TimeSeriesModelSettings

时序模型设置，包括模型名称、时序 ID 属性和默认类型 ID。
TsiError

有关 API 错误的信息。
TsiErrorBody

具有错误代码和消息的特定 API 错误。
TsiErrorDetails

其他错误信息。
UpdateModelSettingsRequest

请求更新模型设置。 必须设置“name”或“defaultTypeId”之一。

ModelSettingsResponse

Object

包含完整时序模型设置的响应，包括模型名称、时序 ID 属性和默认类型 ID。

名称 类型 说明
modelSettings

TimeSeriesModelSettings

模型设置，包括模型名称、时序 ID 属性和默认类型 ID。

TimeSeriesIdProperty

Object

单个属性的定义，可在环境创建期间定义的时序 ID 属性中使用。

名称 类型 说明
name

string

属性的名称。
type

TimeSeriesIdPropertyTypes

属性类型。 目前仅支持“字符串”。

TimeSeriesIdPropertyTypes

枚举

属性类型。 目前仅支持“字符串”。

值 说明
String

TimeSeriesModelSettings

Object

时序模型设置，包括模型名称、时序 ID 属性和默认类型 ID。

名称 类型 说明
defaultTypeId

string

新时序实例将自动所属的模型的默认类型 ID。
name

string

UX 中显示的时序模型显示名称。 示例：“温度传感器”、“MyDevices”。
timeSeriesIdProperties

TimeSeriesIdProperty[]

在创建环境期间定义的时序 ID 属性。

TsiError

Object

有关 API 错误的信息。

名称 类型 说明
error

TsiErrorBody

具有错误代码和消息的特定 API 错误。

TsiErrorBody

Object

具有错误代码和消息的特定 API 错误。

名称 类型 说明
code

string

独立于语言且可读的字符串，用于定义特定于服务的错误代码。 此代码用作响应中指定的 HTTP 错误代码的更具体的指示器。 可用于以编程方式处理特定错误案例。
details

TsiErrorDetails[]

包含其他错误信息。 可以为 null。
innerError

TsiErrorBody

包含更具体的错误，可缩小原因范围。 可以为 null。
message

string

人为可读的、与语言无关的错误表示形式。 它旨在帮助开发人员，不适合向最终用户公开。
target

string

特定错误的目标（例如，错误中属性的名称）。 可以为 null。

TsiErrorDetails

Object

其他错误信息。

名称 类型 说明
code

string

独立于语言且可读的字符串，用于定义特定于服务的错误代码。 此代码用作响应中指定的 HTTP 错误代码的更具体的指示器。 可用于以编程方式处理特定错误案例。
message

string

人为可读的、与语言无关的错误表示形式。 它旨在帮助开发人员，不适合向最终用户公开。

UpdateModelSettingsRequest

Object

请求更新模型设置。 必须设置“name”或“defaultTypeId”之一。

名称 类型 说明
defaultTypeId

string

新实例将自动属于的模型的默认类型 ID。
name

string

模型显示名称，显示在 UX 中，可由用户更改。 初始值为“DefaultModel”。