Devices - Create Or Update

Odwołanie

Usługa:: Azure Data Manager for Agriculture

Wersja interfejsu API:: 2023-11-01-preview

Tworzenie jednostki urządzenia.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
deviceId	path	True	string	Identyfikator zasobu urządzenia.
endpoint	path	True	string uri	Nazwa hosta przestrzeni nazw, np. admaInstanceName.farmbeats.azure.net
sensorPartnerId	path	True	string	Identyfikator partnera czujnika.
api-version	query	True	string	Żądana wersja interfejsu API

Nagłówek żądania

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

Nazwa	Wymagane	Typ	Opis
Authorization	True	string	Podaj prawidłowy token elementu nośnego dla autoryzowanych wywołań interfejsu API. Pamiętaj, że może być konieczne wyczyszczenie pamięci podręcznej przeglądarki, jeśli wcześniej próbowano wykonać nieuwierzytelnione wywołania.

Treść żądania

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

Nazwa	Typ	Opis
description	string	Tekstowy opis zasobu.
deviceDataModelId	string	Identyfikator skojarzonego modelu danych urządzenia.
hardwareId	string	Identyfikator sprzętu urządzenia.
integrationId	string	Identyfikator integracji dla urządzenia.
location	Location	Location model class (Klasa modelu lokalizacji).
name	string	Nazwa identyfikującego zasób.
parentDeviceId	string	Identyfikator urządzenia nadrzędnego dla tego urządzenia.
properties		Kolekcja par klucz-wartość, która należy do zasobu. Każda para nie może mieć klucza większego niż 50 znaków i nie może mieć wartości większej niż 150 znaków. Uwaga: dla zasobu można podać maksymalnie 25 par wartości klucza, a obsługiwane są tylko wartości ciągu, liczb i daty/godziny (rrrr-MM-ddTHH:mm:ssZ).
reportingIntervalInSeconds	integer	Interwał, w którym urządzenie wysyła dane w sekundach.
status	string	Stan zasobu.
type	string	Typ urządzenia.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	Device	Powodzenie
201 Created	Device	Utworzone
Other Status Codes	ErrorResponse	Błąd Nagłówki x-ms-error-code: string

Nazwa

Typ

Opis

200 OK

Device

Powodzenie

201 Created

Device

Utworzone

Other Status Codes

ErrorResponse

Błąd

Nagłówki

x-ms-error-code: string

Zabezpieczenia

Authorization

Podaj prawidłowy token elementu nośnego dla autoryzowanych wywołań interfejsu API. Pamiętaj, że może być konieczne wyczyszczenie pamięci podręcznej przeglądarki, jeśli wcześniej próbowano wykonać nieuwierzytelnione wywołania.

Typ: apiKey
W: header

Przykłady

Devices_CreateOrUpdate

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:: 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
  }
}

Kod stanu:: 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
  }
}

Definicje

Nazwa	Opis
Device	Model interfejsu API urządzenia.
Error	Błąd usługi Azure AgPlatform.
ErrorResponse	Odpowiedź na błąd z usługi Azure AgPlatform. Zobacz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses dokument referencyjny ErrorResponse.
InnerError	Błąd wewnętrzny zawierający listę błędów. Zobacz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object dokumentację dotyczącą błędu wewnętrznego.
Location	Location model class (Klasa modelu lokalizacji).

Device

Model interfejsu API urządzenia.

Nazwa	Typ	Opis
createdBy	string	Utworzony przez identyfikator użytkownika/dzierżawy.
createdDateTime	string	Data i godzina utworzenia zasobu, format próbki: rrrr-MM-ddTHH:mm:ssZ.
description	string	Tekstowy opis zasobu.
deviceDataModelId	string	Identyfikator skojarzonego modelu danych urządzenia.
eTag	string	Wartość ETag w celu zaimplementowania optymistycznej współbieżności.
hardwareId	string	Identyfikator sprzętu urządzenia.
id	string	Identyfikator zasobu.
integrationId	string	Identyfikator integracji dla urządzenia.
location	Location	Location model class (Klasa modelu lokalizacji).
modifiedBy	string	Zmodyfikowane przez identyfikator użytkownika/dzierżawy.
modifiedDateTime	string	Data i godzina ostatniej modyfikacji zasobu, format próbki: rrrr-MM-ddTHH:mm:ssZ.
name	string	Nazwa identyfikującego zasób.
parentDeviceId	string	Identyfikator urządzenia nadrzędnego dla tego urządzenia.
properties		Kolekcja par klucz-wartość, która należy do zasobu. Każda para nie może mieć klucza większego niż 50 znaków i nie może mieć wartości większej niż 150 znaków. Uwaga: dla zasobu można podać maksymalnie 25 par wartości klucza, a obsługiwane są tylko wartości ciągu, liczb i daty/godziny (rrrr-MM-ddTHH:mm:ssZ).
reportingIntervalInSeconds	integer	Interwał, w którym urządzenie wysyła dane w sekundach.
sensorPartnerId	string	Identyfikator skojarzonego partnera czujnika.
status	string	Stan zasobu.
type	string	Typ urządzenia.

Error

Błąd usługi Azure AgPlatform.

Nazwa	Typ	Opis
code	string	Zdefiniowany przez serwer zestaw kodów błędów.
details	Error[]	Tablica szczegółów dotyczących określonych błędów, które doprowadziły do tego zgłoszonego błędu.
innererror	InnerError	Błąd wewnętrzny zawierający listę błędów. Zobacz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object dokumentację dotyczącą błędu wewnętrznego.
message	string	Czytelna dla człowieka reprezentacja błędu.
target	string	Element docelowy błędu.

ErrorResponse

Odpowiedź na błąd z usługi Azure AgPlatform. Zobacz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses dokument referencyjny ErrorResponse.

Nazwa	Typ	Opis
error	Error	Błąd usługi Azure AgPlatform.
traceId	string	Unikatowy identyfikator śledzenia.

InnerError

Błąd wewnętrzny zawierający listę błędów. Zobacz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object dokumentację dotyczącą błędu wewnętrznego.

Nazwa	Typ	Opis
code	string	Określony kod błędu niż został dostarczony przez błąd zawierający.
innererror	InnerError	Błąd wewnętrzny zawierający listę błędów. Zobacz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object dokumentację dotyczącą błędu wewnętrznego.

Location

Location model class (Klasa modelu lokalizacji).

Nazwa	Typ	Opis
latitude	number	Szerokość geograficzna lokalizacji.
longitude	number	Długość geograficzna lokalizacji.

Udostępnij za pośrednictwem

Devices - Create Or Update

Parametry identyfikatora URI

Nagłówek żądania

Treść żądania

Odpowiedzi

Zabezpieczenia

Authorization

Przykłady

Devices_CreateOrUpdate

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

Device

Error

ErrorResponse

InnerError

Location

Dodatkowe zasoby