Devices - Create Or Update

服務:

Azure Data Manager for Agriculture

API 版本:

2023-11-01-preview

建立裝置實體。

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

URI 參數

名稱	位於	必要	類型	Description
deviceId	path	True	string	裝置資源的標識碼。
endpoint	path	True	string uri	命名空間的主機名，例如 admaInstanceName.farmbeats.azure.net
sensorPartnerId	path	True	string	感測器合作夥伴的標識碼。
api-version	query	True	string	要求的 API 版本

要求標頭

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

名稱	必要	類型	Description
Authorization	True	string	請為授權的 API 呼叫提供有效的持有人令牌。 請注意，如果您之前嘗試了未驗證的呼叫，您可能需要清除瀏覽器快取。

要求本文

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

名稱	類型	Description
description	string	資源的文字描述。
deviceDataModelId	string	相關聯裝置數據模型的標識碼。
hardwareId	string	裝置 hardwareId。
integrationId	string	裝置的整合標識碼。
location	Location	位置模型類別。
name	string	用於識別資源的名稱。
parentDeviceId	string	此裝置的父裝置標識碼。
properties		屬於資源的索引鍵值組集合。 每個配對的索引鍵不能大於 50 個字元，而且不能有大於 150 個字元的值。 注意：最多可以針對資源提供 25 個索引鍵值組，而且只支援字串、數位和 datetime (yyyy-MM-ddTHH：mm：ssZ) 值。
reportingIntervalInSeconds	integer	裝置以秒為單位傳送數據的間隔。
status	string	資源的狀態。
type	string	裝置類型。

回應

名稱	類型	Description
200 OK	Device	成功
201 Created	Device	建立時間
Other Status Codes	ErrorResponse	[錯誤] 標題 x-ms-error-code: string

安全性

Authorization

請為授權的 API 呼叫提供有效的持有人令牌。 請注意，如果您之前嘗試了未驗證的呼叫，您可能需要清除瀏覽器快取。

類型: apiKey
位於: header

範例

Devices_CreateOrUpdate

範例要求

HTTP

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

{
  "deviceDataModelId": "ddm124",
  "integrationId": "string",
  "type": "device",
  "hardwareId": "HD156",
  "reportingIntervalInSeconds": 10,
  "location": {
    "latitude": 23.5,
    "longitude": 42.7
  },
  "status": "new device",
  "name": "my device",
  "description": "description goes here",
  "properties": {
    "key1": "value1",
    "key2": 123.45
  }
}

範例回覆

狀態碼:

200

{
  "deviceDataModelId": "ddm124",
  "integrationId": "string",
  "type": "device",
  "hardwareId": "HD156",
  "reportingIntervalInSeconds": 10,
  "location": {
    "latitude": 23.5,
    "longitude": 42.7
  },
  "sensorPartnerId": "sp1",
  "id": "d123",
  "status": "new device",
  "createdDateTime": "2022-01-24T06:20:47Z",
  "modifiedDateTime": "2022-01-24T06:21:07Z",
  "eTag": "0401a5cc-0000-0700-0000-61ee45540000",
  "name": "my device",
  "description": "description goes here",
  "properties": {
    "key1": "value1",
    "key2": 123.45
  }
}

狀態碼:

201

{
  "deviceDataModelId": "ddm124",
  "integrationId": "string",
  "type": "device",
  "hardwareId": "HD156",
  "reportingIntervalInSeconds": 10,
  "location": {
    "latitude": 23.5,
    "longitude": 42.7
  },
  "sensorPartnerId": "sp1",
  "id": "d123",
  "status": "new device",
  "createdDateTime": "2022-01-24T06:20:47Z",
  "modifiedDateTime": "2022-01-24T06:20:47Z",
  "eTag": "0401baca-0000-0700-0000-61ee453f0000",
  "name": "my device",
  "description": "description goes here",
  "properties": {
    "key1": "value1",
    "key2": 123.45
  }
}

定義

名稱	Description
Device	裝置 API 模型。
Error	來自 Azure AgPlatform 服務的錯誤。
ErrorResponse	來自 Azure AgPlatform 服務的錯誤回應。 請參閱 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses ErrorResponse 參考檔。
InnerError	包含錯誤清單的內部錯誤。請參閱 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object InnerError 參考檔。
Location	位置模型類別。

Device

裝置 API 模型。

名稱	類型	Description
createdBy	string	由使用者/租使用者標識碼建立。
createdDateTime	string	建立資源的日期時間，範例格式：yyyy-MM-ddTHH:mm:ssZ。
description	string	資源的文字描述。
deviceDataModelId	string	相關聯裝置數據模型的標識碼。
eTag	string	要實作開放式並行存取的ETag值。
hardwareId	string	裝置 hardwareId。
id	string	資源的標識碼。
integrationId	string	裝置的整合標識碼。
location	Location	位置模型類別。
modifiedBy	string	由使用者/租使用者標識碼修改。
modifiedDateTime	string	上次修改資源的日期時間，範例格式：yyyy-MM-ddTHH:mm:ssZ。
name	string	用於識別資源的名稱。
parentDeviceId	string	此裝置的父裝置標識碼。
properties		屬於資源的索引鍵值組集合。 每個配對的索引鍵不能大於 50 個字元，而且不能有大於 150 個字元的值。 注意：最多可以針對資源提供 25 個索引鍵值組，而且只支援字串、數位和 datetime (yyyy-MM-ddTHH：mm：ssZ) 值。
reportingIntervalInSeconds	integer	裝置以秒為單位傳送數據的間隔。
sensorPartnerId	string	相關聯感測器夥伴的標識碼。
status	string	資源的狀態。
type	string	裝置類型。

Error

來自 Azure AgPlatform 服務的錯誤。

名稱	類型	Description
code	string	伺服器定義的錯誤碼集。
details	Error[]	導致此錯誤之特定錯誤的詳細數據陣列。
innererror	InnerError	包含錯誤清單的內部錯誤。請參閱 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object InnerError 參考檔。
message	string	人類可閱讀的錯誤表示法。
target	string	錯誤的目標。

ErrorResponse

來自 Azure AgPlatform 服務的錯誤回應。 請參閱 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses ErrorResponse 參考檔。

名稱	類型	Description
error	Error	來自 Azure AgPlatform 服務的錯誤。
traceId	string	唯一追蹤標識碼。

InnerError

包含錯誤清單的內部錯誤。請參閱 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object InnerError 參考檔。

名稱	類型	Description
code	string	包含的錯誤所提供的特定錯誤碼。
innererror	InnerError	包含錯誤清單的內部錯誤。請參閱 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object InnerError 參考檔。

Location

位置模型類別。

名稱	類型	Description
latitude	number	位置的緯度。
longitude	number	位置的經度。