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

Devices - Get

Service:

Azure Data Manager for Agriculture

API Version:

2023-11-01-preview

获取设备实体。

GET {endpoint}/sensor-partners/{sensorPartnerId}/devices/{deviceId}?api-version=2023-11-01-preview

URI 参数

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

请求头

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

响应

名称	类型	说明
200 OK	Device	Success
Other Status Codes	ErrorResponse	错误 Headers x-ms-error-code: string

安全性

Authorization

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

Type: apiKey
In: header

示例

Devices_Get

Sample Request

HTTP

GET {endpoint}/sensor-partners/sp1/devices/d124?api-version=2023-11-01-preview

Sample Response

Status code:

200

{
  "deviceDataModelId": "ddm124",
  "integrationId": "string",
  "type": "device",
  "hardwareId": "HD156",
  "reportingIntervalInSeconds": 10,
  "location": {
    "latitude": 23.5,
    "longitude": 42.7
  },
  "sensorPartnerId": "sp1",
  "id": "d124",
  "status": "new device",
  "createdDateTime": "2022-01-24T06:22:41Z",
  "modifiedDateTime": "2022-01-24T06:22:43Z",
  "eTag": "04010fd5-0000-0700-0000-61ee45b30000",
  "name": "my device",
  "description": "description goes here",
  "properties": {
    "key1": "value1",
    "key2": 123.45
  }
}

定义

名称	说明
Device	设备 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 。
Location	位置模型类。

Device

设备 API 模型。

名称	类型	说明
createdBy	string	由用户/租户 ID 创建。
createdDateTime	string	创建资源的日期时间，示例格式：yyyy-MM-ddTHH:mm:ssZ。
description	string	资源的文本说明。
deviceDataModelId	string	关联的设备数据模型的 ID。
eTag	string	用于实现乐观并发的 ETag 值。
hardwareId	string	设备 hardwareId。
id	string	资源的 ID。
integrationId	string	设备的集成 ID。
location	Location	位置模型类。
modifiedBy	string	由用户/租户 ID 修改。
modifiedDateTime	string	上次修改资源的日期时间，示例格式：yyyy-MM-ddTHH:mm:ssZ。
name	string	用于标识资源的名称。
parentDeviceId	string	此设备的父设备 ID。
properties		属于资源的键值对的集合。 每对的键不能超过 50 个字符，并且值不能大于 150 个字符。 注意：最多可以为资源提供 25 个键值对，并且仅支持字符串、数字和日期时间 (yyyy-MM-ddTHH：mm：ssZ) 值。
reportingIntervalInSeconds	integer	设备发送数据的间隔（以秒为单位）。
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 。

Location

位置模型类。

名称	类型	说明
latitude	number	位置的纬度。
longitude	number	位置的经度。