Devices - Create Or Update

Referencia

Service:: Azure Data Manager for Agriculture

API Version:: 2023-11-01-preview

Hozzon létre egy eszközentitást.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
deviceId	path	True	string	Az eszközerőforrás azonosítója.
endpoint	path	True	string uri	A névtér gazdagépneve, például admaInstanceName.farmbeats.azure.net
sensorPartnerId	path	True	string	Az érzékelőpartner azonosítója.
api-version	query	True	string	A kért API-verzió

Kérelem fejléce

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

Name	Kötelező	Típus	Description
Authorization	True	string	Adjon meg érvényes tulajdonosi jogkivonatot az engedélyezett API-hívásokhoz. Vegye figyelembe, hogy előfordulhat, hogy törölnie kell a böngésző gyorsítótárát, ha korábban nem hitelesített hívásokat próbált meg.

Kérelem törzse

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

Name	Típus	Description
description	string	Az erőforrás szöveges leírása.
deviceDataModelId	string	A társított eszközadat-modell azonosítója.
hardwareId	string	Eszköz hardverazonosítója.
integrationId	string	Az eszköz integrációs azonosítója.
location	Location	Helymodell-osztály.
name	string	Név az erőforrás azonosításához.
parentDeviceId	string	Az eszköz szülőeszköz-azonosítója.
properties		Az erőforráshoz tartozó kulcsértékpárok gyűjteménye. Minden párnak nem lehet 50 karakternél nagyobb kulcsa, és nem lehet 150 karakternél nagyobb érték. Megjegyzés: Egy erőforráshoz legfeljebb 25 kulcsértékpár adható meg, és csak sztring-, szám- és datetime (ééééé-MM-ddTHH:mm:ssZ) értékek támogatottak.
reportingIntervalInSeconds	integer	Az az időtartam, amikor az eszköz másodpercek alatt adatokat küld.
status	string	Az erőforrás állapota.
type	string	Az eszköz típusa.

Válaszok

Name	Típus	Description
200 OK	Device	Success
201 Created	Device	Létrehozva
Other Status Codes	ErrorResponse	Hiba Headers x-ms-error-code: string

Name

Típus

Description

200 OK

Device

Success

201 Created

Device

Létrehozva

Other Status Codes

ErrorResponse

Hiba

Headers

x-ms-error-code: string

Biztonság

Authorization

Adjon meg érvényes tulajdonosi jogkivonatot az engedélyezett API-hívásokhoz. Vegye figyelembe, hogy előfordulhat, hogy törölnie kell a böngésző gyorsítótárát, ha korábban nem hitelesített hívásokat próbált meg.

Type: apiKey
In: header

Példák

Devices_CreateOrUpdate

Sample Request

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
  }
}

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": "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
  }
}

Status code:: 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
  }
}

Definíciók

Name	Description
Device	Eszköz API-modell.
Error	Az Azure AgPlatform szolgáltatás hibája.
ErrorResponse	Hibaválasz az Azure AgPlatform szolgáltatástól. Lásd https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses : ErrorResponse referenciadokumentum.
InnerError	Belső hiba, amely a hibák listáját tartalmazza. Lásd https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object : InnerError referenciadokumentum.
Location	Helymodell-osztály.

Device

Eszköz API-modell.

Name	Típus	Description
createdBy	string	A felhasználó/bérlő azonosítója hozza létre.
createdDateTime	string	Az erőforrás létrehozásának dátum-időpontja, mintaformátum: yyyy-MM-ddTHH:mm:ssZ.
description	string	Az erőforrás szöveges leírása.
deviceDataModelId	string	A társított eszközadat-modell azonosítója.
eTag	string	Az ETag értéke az optimista egyidejűség megvalósításához.
hardwareId	string	Eszköz hardverazonosítója.
id	string	Az erőforrás azonosítója.
integrationId	string	Az eszköz integrációs azonosítója.
location	Location	Helymodell-osztály.
modifiedBy	string	Módosítva a felhasználó/bérlő azonosítója alapján.
modifiedDateTime	string	Az erőforrás utolsó módosításának dátuma, mintaformátum: yyyy-MM-ddTHH:mm:ssZ.
name	string	Név az erőforrás azonosításához.
parentDeviceId	string	Az eszköz szülőeszköz-azonosítója.
properties		Az erőforráshoz tartozó kulcsértékpárok gyűjteménye. Minden párnak nem lehet 50 karakternél nagyobb kulcsa, és nem lehet 150 karakternél nagyobb érték. Megjegyzés: Egy erőforráshoz legfeljebb 25 kulcsértékpár adható meg, és csak sztring-, szám- és datetime (ééééé-MM-ddTHH:mm:ssZ) értékek támogatottak.
reportingIntervalInSeconds	integer	Az az időtartam, amikor az eszköz másodpercek alatt adatokat küld.
sensorPartnerId	string	A társított érzékelőpartner azonosítója.
status	string	Az erőforrás állapota.
type	string	Az eszköz típusa.

Error

Az Azure AgPlatform szolgáltatás hibája.

Name	Típus	Description
code	string	Kiszolgáló által definiált hibakódok.
details	Error[]	A jelentett hibához vezető konkrét hibák részleteinek tömbje.
innererror	InnerError	Belső hiba, amely a hibák listáját tartalmazza. Lásd https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object : InnerError referenciadokumentum.
message	string	A hiba emberi olvasásra alkalmas ábrázolása.
target	string	A hiba célja.

ErrorResponse

Hibaválasz az Azure AgPlatform szolgáltatástól. Lásd https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses : ErrorResponse referenciadokumentum.

Name	Típus	Description
error	Error	Az Azure AgPlatform szolgáltatás hibája.
traceId	string	Egyedi nyomkövetési azonosító.

InnerError

Belső hiba, amely a hibák listáját tartalmazza. Lásd https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object : InnerError referenciadokumentum.

Name	Típus	Description
code	string	Konkrét hibakód, mint amelyet a hiba tartalmazott.
innererror	InnerError	Belső hiba, amely a hibák listáját tartalmazza. Lásd https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object : InnerError referenciadokumentum.

Location

Helymodell-osztály.

Name	Típus	Description
latitude	number	A hely szélessége.
longitude	number	A hely hosszúsága.

Megosztás a következőn keresztül:

Devices - Create Or Update

URI-paraméterek

Kérelem fejléce

Kérelem törzse

Válaszok

Biztonság

Authorization

Példák

Devices_CreateOrUpdate

Sample Request

Sample Response

Definíciók

Device

Error

ErrorResponse

InnerError

Location

További források