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 パラメーター

名前	/	必須	型	説明
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 バージョン

要求ヘッダー

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

名前	必須	型	説明
Authorization	True	string	承認された API 呼び出しに対して有効なベアラー トークンを指定してください。 以前に認証されていない呼び出しを試した場合は、ブラウザー キャッシュをクリアする必要がある場合があることに注意してください。

要求本文

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

名前	型	説明
description	string	リソースの説明テキスト。
deviceDataModelId	string	関連付けられているデバイス データ モデルの ID。
hardwareId	string	デバイス hardwareId。
integrationId	string	デバイスの統合 ID。
location	Location	場所モデル クラス。
name	string	リソースを識別する名前
parentDeviceId	string	このデバイスの親デバイス ID。
properties		リソースに属するキー値ペアのコレクション。 各ペアには、50 文字を超えるキーを持つ必要があり、150 文字を超える値を持つ必要があります。 注: リソースには最大 25 個のキー値ペアを指定でき、文字列、数字、datetime (yyyy-MM-ddTHH:mm:ssZ) 値のみがサポートされます。
reportingIntervalInSeconds	integer	デバイスが秒単位でデータを送信する間隔。
status	string	リソースの状態。
type	string	デバイスの種類。

応答

名前	型	説明
200 OK	Device	Success
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
  }
}

定義

名前	説明
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 個のキー値ペアを指定でき、文字列、数字、datetime (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	場所の経度。