Devices - Create Or Update

Referenz

Dienst:: Azure Data Manager for Agriculture

API-Version:: 2023-11-01-preview

Erstellen Sie eine Geräteentität.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
deviceId	path	True	string	ID der Geräteressource.
endpoint	path	True	string uri	Der Hostname des Namespace, z. B. admaInstanceName.farmbeats.azure.net
sensorPartnerId	path	True	string	Id des Sensorpartners.
api-version	query	True	string	Die angeforderte API-Version

Anforderungsheader

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

Name	Erforderlich	Typ	Beschreibung
Authorization	True	string	Geben Sie ein gültiges Bearertoken für autorisierte API-Aufrufe an. Beachten Sie, dass Sie möglicherweise Ihren Browsercache löschen müssen, wenn Sie zuvor nicht authentifizierte Aufrufe ausprobiert haben.

Anforderungstext

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

Name	Typ	Beschreibung
description	string	Textbeschreibung der Ressource.
deviceDataModelId	string	ID des zugeordneten Gerätedatenmodells.
hardwareId	string	GerätehardwareId.
integrationId	string	Integrations-ID für das Gerät.
location	Location	Klasse des Standortmodells.
name	string	Der Name zur Identifizierung der Ressource.
parentDeviceId	string	Übergeordnete Geräte-ID für dieses Gerät.
properties		Eine Sammlung von Schlüsselwertpaaren, die zur Ressource gehören. Jedes Paar darf keinen Schlüssel größer als 50 Zeichen haben und darf keinen Wert größer als 150 Zeichen haben. Hinweis: Für eine Ressource können maximal 25 Schlüsselwertpaare bereitgestellt werden, und es werden nur Zeichenfolgen-, Zahlen- und Datetime-Werte (JJJJ-MM-ddTHH:mm:ssZ) unterstützt.
reportingIntervalInSeconds	integer	Intervall, in dem das Gerät Daten in Sekunden sendet.
status	string	Status der Ressource.
type	string	Typ des Geräts.

Antworten

Name	Typ	Beschreibung
200 OK	Device	Erfolg
201 Created	Device	Erstellt
Other Status Codes	ErrorResponse	Fehler Header x-ms-error-code: string

Name

Typ

Beschreibung

200 OK

Device

Erfolg

201 Created

Device

Erstellt

Other Status Codes

ErrorResponse

Fehler

Header

x-ms-error-code: string

Sicherheit

Authorization

Geben Sie ein gültiges Bearertoken für autorisierte API-Aufrufe an. Beachten Sie, dass Sie möglicherweise Ihren Browsercache löschen müssen, wenn Sie zuvor nicht authentifizierte Aufrufe ausprobiert haben.

Typ: apiKey
In: header

Beispiele

Devices_CreateOrUpdate

Beispielanforderung

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

Beispiel für eine Antwort

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

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

Definitionen

Name	Beschreibung
Device	Geräte-API-Modell.
Error	Ein Fehler des Azure AgPlatform-Diensts.
ErrorResponse	Eine Fehlerantwort des Azure AgPlatform-Diensts. Weitere Informationen finden Sie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses unter ErrorResponse-Referenzdokument.
InnerError	Innerer Fehler, der eine Fehlerliste enthält. Weitere Informationen finden Sie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object unter InnerError-Referenzdokument.
Location	Klasse des Standortmodells.

Device

Geräte-API-Modell.

Name	Typ	Beschreibung
createdBy	string	Erstellt von Benutzer-/Mandanten-ID.
createdDateTime	string	Datum und Uhrzeit der Erstellung der Ressource, Beispielformat: jjjj-MM-ttTHH:mm:ssZ.
description	string	Textbeschreibung der Ressource.
deviceDataModelId	string	ID des zugeordneten Gerätedatenmodells.
eTag	string	Der ETag-Wert, um eine optimistische Parallelität zu implementieren.
hardwareId	string	GerätehardwareId.
id	string	Id der Ressource.
integrationId	string	Integrations-ID für das Gerät.
location	Location	Klasse des Standortmodells.
modifiedBy	string	Geändert durch Benutzer-/Mandanten-ID.
modifiedDateTime	string	Datum und Uhrzeit der letzten Änderung der Ressource, Beispielformat: jjjj-MM-ttTHH:mm:ssZ.
name	string	Der Name zur Identifizierung der Ressource.
parentDeviceId	string	Übergeordnete Geräte-ID für dieses Gerät.
properties		Eine Sammlung von Schlüsselwertpaaren, die zur Ressource gehören. Jedes Paar darf keinen Schlüssel größer als 50 Zeichen haben und darf keinen Wert größer als 150 Zeichen haben. Hinweis: Für eine Ressource können maximal 25 Schlüsselwertpaare bereitgestellt werden, und es werden nur Zeichenfolgen-, Zahlen- und Datetime-Werte (JJJJ-MM-ddTHH:mm:ssZ) unterstützt.
reportingIntervalInSeconds	integer	Intervall, in dem das Gerät Daten in Sekunden sendet.
sensorPartnerId	string	Id des zugeordneten Sensorpartners.
status	string	Status der Ressource.
type	string	Typ des Geräts.

Error

Ein Fehler des Azure AgPlatform-Diensts.

Name	Typ	Beschreibung
code	string	Vom Server definierte Gruppe von Fehlercodes.
details	Error[]	Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben.
innererror	InnerError	Innerer Fehler, der eine Fehlerliste enthält. Weitere Informationen finden Sie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object unter InnerError-Referenzdokument.
message	string	Lesbare Darstellung des Fehlers.
target	string	Ziel des Fehlers.

ErrorResponse

Eine Fehlerantwort des Azure AgPlatform-Diensts. Weitere Informationen finden Sie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses unter ErrorResponse-Referenzdokument.

Name	Typ	Beschreibung
error	Error	Ein Fehler des Azure AgPlatform-Diensts.
traceId	string	Eindeutige Ablaufverfolgungs-ID.

InnerError

Innerer Fehler, der eine Fehlerliste enthält. Weitere Informationen finden Sie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object unter InnerError-Referenzdokument.

Name	Typ	Beschreibung
code	string	Spezifischer Fehlercode als vom enthaltenden Fehler bereitgestellt wurde.
innererror	InnerError	Innerer Fehler, der eine Fehlerliste enthält. Weitere Informationen finden Sie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object unter InnerError-Referenzdokument.

Location

Klasse des Standortmodells.

Name	Typ	Beschreibung
latitude	number	Der Breitengrad des Standorts.
longitude	number	Der Längengrad des Standorts.

Freigeben über

Devices - Create Or Update

URI-Parameter

Anforderungsheader

Anforderungstext

Antworten

Sicherheit

Authorization

Beispiele

Devices_CreateOrUpdate

Beispielanforderung

Beispiel für eine Antwort

Definitionen

Device

Error

ErrorResponse

InnerError

Location

Zusätzliche Ressourcen