Sensors - Create Or Update

參考

服務:: Azure Data Manager for Agriculture

API 版本:: 2023-11-01-preview

建立感測器實體。

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

URI 參數

名稱	位於	必要	類型	Description
endpoint	path	True	string uri	命名空間的主機名，例如 admaInstanceName.farmbeats.azure.net
sensorId	path	True	string	感測器資源的標識碼。
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
depthInMeters	number[]	以公尺為單位的每個感測器量值深度。如同 2m、4m、6m 的感測器濕度。
description	string	資源的文字描述。
deviceId	string	相關聯裝置的標識碼。
hardwareId	string	相關聯硬體的標識碼。
integrationId	string	裝置的整合標識碼。
location	Location	位置模型類別。
name	string	用於識別資源的名稱。
port	Port	儲存埠值的架構。
properties		屬於資源的索引鍵值組集合。每個配對不能有大於 50 個字元的索引鍵，而且不能有大於 150 個字元的值。注意：最多可以針對資源提供 25 個索引鍵值組，而且只支援字串、數位和日期時間 (yyyy-MM-ddTHH：mm：ssZ) 值。
sensorDataModelId	string	相關聯感測器數據模型的標識碼。
status	string	資源的狀態。
type	string	感測器的類型。

回應

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

名稱

類型

Description

200 OK

Sensor

成功

201 Created

Sensor

建立時間

Other Status Codes

ErrorResponse

[錯誤]

標題

x-ms-error-code: string

安全性

Authorization

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

類型: apiKey
位於: header

範例

Sensors_CreateOrUpdate

範例要求

HTTP

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

{
  "sensorDataModelId": "sdm124",
  "integrationId": "string",
  "hardwareId": "SMHD 456",
  "deviceId": "d124",
  "type": "SM",
  "location": {
    "latitude": 23.5,
    "longitude": 42.7
  },
  "port": {
    "name": "measure",
    "type": "digital"
  },
  "status": "sm created",
  "name": "my new sm",
  "description": "description for sensor goes here",
  "properties": {
    "key1": "value1",
    "key2": 123.45
  }
}

範例回覆

狀態碼:: 200

{
  "sensorDataModelId": "sdm124",
  "integrationId": "string",
  "hardwareId": "SMHD-456",
  "deviceId": "d124",
  "type": "SM",
  "location": {
    "latitude": 23.5,
    "longitude": 42.7
  },
  "port": {
    "name": "measure",
    "type": "digital"
  },
  "sensorPartnerId": "sp1",
  "id": "s124",
  "status": "sm created",
  "createdDateTime": "2022-01-24T06:27:05Z",
  "modifiedDateTime": "2022-01-24T06:27:05Z",
  "eTag": "040139eb-0000-0700-0000-61ee46b90000",
  "name": "my new sm",
  "description": "description for sensor goes here",
  "properties": {
    "key1": "value1",
    "key2": 123.45
  }
}

狀態碼:: 201

{
  "sensorDataModelId": "sdm124",
  "integrationId": "string",
  "hardwareId": "SMHD-456",
  "deviceId": "d124",
  "type": "SM",
  "location": {
    "latitude": 23.5,
    "longitude": 42.7
  },
  "port": {
    "name": "measure",
    "type": "digital"
  },
  "sensorPartnerId": "sp1",
  "id": "s124",
  "status": "sm created",
  "createdDateTime": "2022-01-24T06:27:05Z",
  "modifiedDateTime": "2022-01-24T06:27:05Z",
  "eTag": "040139eb-0000-0700-0000-61ee46b90000",
  "name": "my new sm",
  "description": "description for sensor goes here",
  "properties": {
    "key1": "value1",
    "key2": 123.45
  }
}

定義

名稱	Description
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	位置模型類別。
Port	儲存埠值的架構。
Sensor	感測器 API 模型。

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	位置的經度。

Port

儲存埠值的架構。

名稱	類型	Description
name	string	埠的名稱。
type	string	埠數位/類比的類型。

Sensor

感測器 API 模型。

名稱	類型	Description
createdBy	string	由使用者/租使用者標識碼建立。
createdDateTime	string	建立資源的日期時間，範例格式：yyyy-MM-ddTHH:mm:ssZ。
depthInMeters	number[]	以公尺為單位的每個感測器量值深度。如同 2m、4m、6m 的感測器濕度。
description	string	資源的文字描述。
deviceId	string	相關聯裝置的標識碼。
eTag	string	要實作開放式並行存取的ETag值。
hardwareId	string	相關聯硬體的標識碼。
id	string	資源的標識碼。
integrationId	string	裝置的整合標識碼。
location	Location	位置模型類別。
modifiedBy	string	由使用者/租使用者標識碼修改。
modifiedDateTime	string	上次修改資源的日期時間，範例格式：yyyy-MM-ddTHH:mm:ssZ。
name	string	用於識別資源的名稱。
port	Port	儲存埠值的架構。
properties		屬於資源的索引鍵值組集合。每個配對不能有大於 50 個字元的索引鍵，而且不能有大於 150 個字元的值。注意：最多可以針對資源提供 25 個索引鍵值組，而且只支援字串、數位和日期時間 (yyyy-MM-ddTHH：mm：ssZ) 值。
sensorDataModelId	string	相關聯感測器數據模型的標識碼。
sensorPartnerId	string	相關聯感測器夥伴的標識碼。
status	string	資源的狀態。
type	string	感測器的類型。

共用方式為

Sensors - Create Or Update

URI 參數

要求標頭

要求本文

回應

安全性

Authorization

範例

Sensors_CreateOrUpdate

範例要求

範例回覆

定義

Error

ErrorResponse

InnerError

Location

Port

Sensor

其他資源