Model Settings - Update

Ссылка

Service:: Time Series Insights

API Version:: 2020-07-31

Обновляет параметры модели временных рядов — имя модели или идентификатор типа по умолчанию.

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

Параметры URI

Name	In	Required	Type	Description
environmentFqdn	path	True	string	Полное доменное имя среды, например 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com. Это доменное имя можно получить из ответа API get Environments, портал Azure или Azure Resource Manager.
api-version	query	True	string	Версия API, используемая с клиентским запросом. Сейчас поддерживается версия 2020-07-31.

Заголовок запроса

Name	Required	Type	Description
x-ms-client-request-id		string	Необязательный идентификатор запроса клиента. Служба записывает это значение. Позволяет службе отслеживать операции между службами и позволяет клиенту обращаться в службу поддержки в отношении конкретного запроса.
x-ms-client-session-id		string	Необязательный идентификатор сеанса клиента. Служба записывает это значение. Позволяет службе отслеживать группу связанных операций между службами и позволяет клиенту обращаться в службу поддержки в отношении определенной группы запросов.

Текст запроса

Name	Type	Description
defaultTypeId	string	Идентификатор типа по умолчанию модели, к которой автоматически принадлежат новые экземпляры.
name	string	Отображаемое имя модели, отображаемое в пользовательском интерфейсе и изменяемое пользователем. Начальное значение — DefaultModel.

Ответы

Name	Type	Description
200 OK	ModelSettingsResponse	Успешная операция возвращает новые полные параметры модели. Headers x-ms-request-id: string
Other Status Codes	TsiError	Непредвиденная ошибка. Headers x-ms-request-id: string

Name

Type

Description

200 OK

ModelSettingsResponse

Успешная операция возвращает новые полные параметры модели.

Headers

x-ms-request-id: string

Other Status Codes

TsiError

Непредвиденная ошибка.

Headers

x-ms-request-id: string

Безопасность

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	олицетворения учетной записи пользователя

Примеры

ModelSettingsUpdateName

Sample Request

HTTP

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

{
  "name": "Thermostats"
}

Sample Response

Status code:: 200

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

Определения

ModelSettingsResponse	Ответ, содержащий параметры модели полных временных рядов, которые включают имя модели, свойства идентификатора временных рядов и идентификатор типа по умолчанию.
TimeSeriesIdProperty	Определение одного свойства, которое можно использовать в свойствах идентификатора временных рядов, определенных во время создания среды.
TimeSeriesIdPropertyTypes	Тип свойства. В настоящее время поддерживается только string.
TimeSeriesModelSettings	Параметры модели временных рядов, включая имя модели, свойства идентификатора временных рядов и идентификатор типа по умолчанию.
TsiError	Сведения об ошибке API.
TsiErrorBody	Конкретная ошибка API с кодом ошибки и сообщением.
TsiErrorDetails	Дополнительные сведения об ошибке.
UpdateModelSettingsRequest	Запрос на обновление параметров модели. Необходимо задать одно из значений name или defaultTypeId.

ModelSettingsResponse

Ответ, содержащий параметры модели полных временных рядов, которые включают имя модели, свойства идентификатора временных рядов и идентификатор типа по умолчанию.

Name	Type	Description
modelSettings	TimeSeriesModelSettings	Параметры модели, включая имя модели, свойства идентификатора временных рядов и идентификатор типа по умолчанию.

TimeSeriesIdProperty

Определение одного свойства, которое можно использовать в свойствах идентификатора временных рядов, определенных во время создания среды.

Name	Type	Description
name	string	Имя свойства.
type	TimeSeriesIdPropertyTypes	Тип свойства. В настоящее время поддерживается только string.

TimeSeriesIdPropertyTypes

Тип свойства. В настоящее время поддерживается только string.

Name	Type	Description
String	string

TimeSeriesModelSettings

Параметры модели временных рядов, включая имя модели, свойства идентификатора временных рядов и идентификатор типа по умолчанию.

Name	Type	Description
defaultTypeId	string	Идентификатор типа по умолчанию модели, к которой автоматически принадлежат новые экземпляры временных рядов.
name	string	Отображаемое имя модели временных рядов, отображаемое в пользовательском интерфейсе. Примеры: "Датчики температуры", "MyDevices".
timeSeriesIdProperties	TimeSeriesIdProperty[]	Свойства идентификатора временных рядов, определенные во время создания среды.

TsiError

Сведения об ошибке API.

Name	Type	Description
error	TsiErrorBody	Конкретная ошибка API с кодом ошибки и сообщением.

TsiErrorBody

Конкретная ошибка API с кодом ошибки и сообщением.

Name	Type	Description
code	string	Удобочитаемая по языку строка, определяющая код ошибки для конкретной службы. Этот код служит более конкретным индикатором для кода ошибки HTTP, указанного в ответе. Может использоваться для программной обработки конкретных случаев ошибок.
details	TsiErrorDetails[]	Содержит дополнительные сведения об ошибке. Может принимать значение NULL.
innerError	TsiErrorBody	Содержит более конкретную ошибку, которая сужает причину. Может принимать значение NULL.
message	string	Удобочитаемое, независимое от языка представление ошибки. Он предназначен как помощь разработчикам и не подходит для воздействия на конечных пользователей.
target	string	Целевой объект конкретной ошибки (например, имя свойства в ошибке). Может принимать значение NULL.

TsiErrorDetails

Дополнительные сведения об ошибке.

Name	Type	Description
code	string	Удобочитаемая по языку строка, определяющая код ошибки для конкретной службы. Этот код служит более конкретным индикатором для кода ошибки HTTP, указанного в ответе. Может использоваться для программной обработки конкретных случаев ошибок.
message	string	Удобочитаемое, независимое от языка представление ошибки. Он предназначен как помощь разработчикам и не подходит для воздействия на конечных пользователей.

UpdateModelSettingsRequest

Запрос на обновление параметров модели. Необходимо задать одно из значений name или defaultTypeId.

Name	Type	Description
defaultTypeId	string	Идентификатор типа по умолчанию модели, к которой автоматически принадлежат новые экземпляры.
name	string	Отображаемое имя модели, отображаемое в пользовательском интерфейсе и изменяемое пользователем. Начальное значение — DefaultModel.