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

Device Data Models - Create Or Update

Service:

Azure Data Manager for Agriculture

API Version:

2023-11-01-preview

创建设备数据模型实体。

PATCH {endpoint}/sensor-partners/{sensorPartnerId}/device-data-models/{deviceDataModelId}?api-version=2023-11-01-preview

URI 参数

名称	在	必需	类型	说明
deviceDataModelId	path	True	string	设备数据模型的 ID。
endpoint	path	True	string uri	命名空间的主机名，例如 admaInstanceName.farmbeats.azure.net
sensorPartnerId	path	True	string	传感器合作伙伴的 ID。
api-version	query	True	string	请求的 API 版本

请求头

Media Types: "application/merge-patch+json"

名称	必需	类型	说明
Authorization	True	string	请为授权的 API 调用提供有效的持有者令牌。 请注意，如果之前尝试过未经身份验证的调用，则可能需要清除浏览器缓存。

请求正文

Media Types: "application/merge-patch+json"

名称	类型	说明
description	string	资源的文本说明。
manufacturer	string	设备制造商。
name	string	用于标识资源的名称。
ports	Port[]	支持的设备端口列表。
productCode	string	设备 productCode。
properties		属于资源的键值对的集合。 每对的键不能超过 50 个字符，并且值不能大于 150 个字符。 注意：最多可以为资源提供 25 个键值对，并且仅支持字符串、数字和日期时间 (yyyy-MM-ddTHH：mm：ssZ) 值。
status	string	资源的状态。
type	string	设备类型。

响应

名称	类型	说明
200 OK	DeviceDataModel	Success
201 Created	DeviceDataModel	创建
Other Status Codes	ErrorResponse	错误 Headers x-ms-error-code: string

安全性

Authorization

请为授权的 API 调用提供有效的持有者令牌。 请注意，如果之前尝试过未经身份验证的调用，则可能需要清除浏览器缓存。

Type: apiKey
In: header

示例

DeviceDataModels_CreateOrUpdate

Sample Request

HTTP

PATCH {endpoint}/sensor-partners/sp1/device-data-models/ddm124?api-version=2023-11-01-preview

{
  "type": "Node",
  "manufacturer": "Manufacturer1",
  "productCode": "smt123",
  "ports": [
    {
      "name": "sm",
      "type": "Analog"
    }
  ],
  "status": "new",
  "name": "sm-device-model",
  "description": "new device model for soil moisture measurement devices",
  "properties": {
    "key1": "value1",
    "key2": 123.45
  }
}

Sample Response

Status code:

200

{
  "type": "Node",
  "manufacturer": "Manufacturer1",
  "productCode": "smt123",
  "ports": [
    {
      "name": "sm",
      "type": "Analog"
    }
  ],
  "sensorPartnerId": "sp1",
  "id": "ddm124",
  "status": "new",
  "createdDateTime": "2022-01-21T09:52:16Z",
  "modifiedDateTime": "2022-01-21T09:54:08Z",
  "eTag": "7f002a96-0000-0700-0000-61ea82c00000",
  "name": "sm-device-model",
  "description": "new device model for soil moisture measurement devices",
  "properties": {
    "key1": "value1",
    "key2": 123.45
  }
}

Status code:

201

{
  "type": "Node",
  "manufacturer": "Manufacturer1",
  "productCode": "smt123",
  "ports": [
    {
      "name": "sm",
      "type": "Analog"
    }
  ],
  "sensorPartnerId": "sp1",
  "id": "ddm124",
  "status": "new",
  "createdDateTime": "2022-01-21T09:52:16Z",
  "modifiedDateTime": "2022-01-21T09:52:16Z",
  "eTag": "7f00bf76-0000-0700-0000-61ea82500000",
  "name": "sm-device-model",
  "description": "new device model for soil moisture measurement devices",
  "properties": {
    "key1": "value1",
    "key2": 123.45
  }
}

定义

名称	说明
DeviceDataModel	DeviceDataModel API 模型。
Error	Azure AgPlatform 服务出错。
ErrorResponse	来自 Azure AgPlatform 服务的错误响应。 有关 ErrorResponse 参考文档，请参阅 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses 。
InnerError	包含错误列表的内部错误。有关 InnerError 参考文档，请参阅 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object 。
Port	用于存储端口值的架构。

DeviceDataModel

DeviceDataModel API 模型。

名称	类型	说明
createdBy	string	由用户/租户 ID 创建。
createdDateTime	string	创建资源的日期时间，示例格式：yyyy-MM-ddTHH:mm:ssZ。
description	string	资源的文本说明。
eTag	string	用于实现乐观并发的 ETag 值。
id	string	资源的 ID。
manufacturer	string	设备制造商。
modifiedBy	string	由用户/租户 ID 修改。
modifiedDateTime	string	上次修改资源的日期时间，示例格式：yyyy-MM-ddTHH:mm:ssZ。
name	string	用于标识资源的名称。
ports	Port[]	支持的设备端口列表。
productCode	string	设备 productCode。
properties		属于资源的键值对的集合。 每对的键不能超过 50 个字符，并且值不能大于 150 个字符。 注意：最多可以为资源提供 25 个键值对，并且仅支持字符串、数字和日期时间 (yyyy-MM-ddTHH：mm：ssZ) 值。
sensorPartnerId	string	关联的传感器合作伙伴的 ID。
status	string	资源的状态。
type	string	设备类型。

Error

Azure AgPlatform 服务出错。

名称	类型	说明
code	string	服务器定义的错误代码集。
details	Error[]	有关导致此报告错误的特定错误的详细信息数组。
innererror	InnerError	包含错误列表的内部错误。有关 InnerError 参考文档，请参阅 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object 。
message	string	错误的用户可读表示形式。
target	string	错误的目标。

ErrorResponse

来自 Azure AgPlatform 服务的错误响应。 有关 ErrorResponse 参考文档，请参阅 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses 。

名称	类型	说明
error	Error	Azure AgPlatform 服务出错。
traceId	string	唯一跟踪 ID。

InnerError

包含错误列表的内部错误。有关 InnerError 参考文档，请参阅 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object 。

名称	类型	说明
code	string	包含错误提供的特定错误代码。
innererror	InnerError	包含错误列表的内部错误。有关 InnerError 参考文档，请参阅 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object 。

Port

用于存储端口值的架构。

名称	类型	说明
name	string	端口的名称。
type	string	端口数字/模拟的类型。