Devices - Create Or Update

Başvuru

Hizmet:: Azure Data Manager for Agriculture

API Sürümü:: 2023-11-01-preview

Bir cihaz varlığı oluşturun.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
deviceId	path	True	string	Cihaz kaynağının kimliği.
endpoint	path	True	string uri	Ad alanının ana bilgisayar adı, örneğin admaInstanceName.farmbeats.azure.net
sensorPartnerId	path	True	string	Algılayıcı iş ortağının kimliği.
api-version	query	True	string	İstenen API sürümü

İstek Başlığı

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

Name	Gerekli	Tür	Description
Authorization	True	string	Lütfen yetkili API çağrıları için geçerli bir taşıyıcı belirteci sağlayın. Kimliği doğrulanmamış çağrıları daha önce denediyseniz tarayıcı önbelleğinizi temizlemeniz gerekebileceğini unutmayın.

İstek Gövdesi

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

Name	Tür	Description
description	string	Kaynağın metinsel açıklaması.
deviceDataModelId	string	İlişkili cihaz veri modelinin kimliği.
hardwareId	string	Cihaz donanım Kimliği.
integrationId	string	Cihazın tümleştirme kimliği.
location	Location	Konum modeli sınıfı.
name	string	Kaynağı tanımlamak için ad.
parentDeviceId	string	Bu cihazın üst cihaz kimliği.
properties		Kaynağa ait anahtar değer çiftleri koleksiyonu. Her çiftin 50 karakterden büyük bir anahtarı olmamalıdır ve 150 karakterden büyük bir değere sahip olmamalıdır. Not: Bir kaynak için en fazla 25 anahtar değer çifti sağlanabilir ve yalnızca dize, sayı ve datetime (yyyy-MM-ddTHH:mm:ssZ) değerleri desteklenir.
reportingIntervalInSeconds	integer	Cihazın saniye cinsinden veri gönderme aralığı.
status	string	Kaynağın durumu.
type	string	Cihaz türü.

Yanıtlar

Name	Tür	Description
200 OK	Device	Başarılı
201 Created	Device	Oluşturulan
Other Status Codes	ErrorResponse	Hata Üst Bilgiler x-ms-error-code: string

Name

Tür

Description

200 OK

Device

Başarılı

201 Created

Device

Oluşturulan

Other Status Codes

ErrorResponse

Hata

Üst Bilgiler

x-ms-error-code: string

Güvenlik

Authorization

Lütfen yetkili API çağrıları için geçerli bir taşıyıcı belirteci sağlayın. Kimliği doğrulanmamış çağrıları daha önce denediyseniz tarayıcı önbelleğinizi temizlemeniz gerekebileceğini unutmayın.

Tür: apiKey
İçinde: header

Örnekler

Devices_CreateOrUpdate

Örnek isteği

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

Örnek yanıt

Durum kodu:: 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
  }
}

Durum kodu:: 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
  }
}

Tanımlar

Name	Description
Device	Cihaz API'si modeli.
Error	Azure AgPlatform hizmetinden bir hata.
ErrorResponse	Azure AgPlatform hizmetinden bir hata yanıtı. ErrorResponse başvuru belgesi için bkz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses .
InnerError	Hata listesini içeren iç hata. InnerError başvuru belgesi için bkz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object .
Location	Konum modeli sınıfı.

Device

Cihaz API'si modeli.

Name	Tür	Description
createdBy	string	Kullanıcı/kiracı kimliği tarafından oluşturulur.
createdDateTime	string	Kaynağın oluşturulduğu tarih-saat, örnek biçim: yyyy-MM-ddTHH:mm:ssZ.
description	string	Kaynağın metinsel açıklaması.
deviceDataModelId	string	İlişkili cihaz veri modelinin kimliği.
eTag	string	İyimser eşzamanlılık uygulamak için ETag değeri.
hardwareId	string	Cihaz donanım Kimliği.
id	string	Kaynağın kimliği.
integrationId	string	Cihazın tümleştirme kimliği.
location	Location	Konum modeli sınıfı.
modifiedBy	string	Kullanıcı/kiracı kimliği tarafından değiştirildi.
modifiedDateTime	string	Kaynağın en son değiştirildiği tarih-saat, örnek biçim: yyyy-MM-ddTHH:mm:ssZ.
name	string	Kaynağı tanımlamak için ad.
parentDeviceId	string	Bu cihazın üst cihaz kimliği.
properties		Kaynağa ait anahtar değer çiftleri koleksiyonu. Her çiftin 50 karakterden büyük bir anahtarı olmamalıdır ve 150 karakterden büyük bir değere sahip olmamalıdır. Not: Bir kaynak için en fazla 25 anahtar değer çifti sağlanabilir ve yalnızca dize, sayı ve datetime (yyyy-MM-ddTHH:mm:ssZ) değerleri desteklenir.
reportingIntervalInSeconds	integer	Cihazın saniye cinsinden veri gönderme aralığı.
sensorPartnerId	string	İlişkili algılayıcı iş ortağının kimliği.
status	string	Kaynağın durumu.
type	string	Cihaz türü.

Error

Azure AgPlatform hizmetinden bir hata.

Name	Tür	Description
code	string	Sunucu tanımlı hata kodları kümesi.
details	Error[]	Bu bildirilen hataya yol açan belirli hatalarla ilgili ayrıntılar dizisi.
innererror	InnerError	Hata listesini içeren iç hata. InnerError başvuru belgesi için bkz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object .
message	string	Hatanın insan tarafından okunabilir gösterimi.
target	string	Hatanın hedefi.

ErrorResponse

Azure AgPlatform hizmetinden bir hata yanıtı. ErrorResponse başvuru belgesi için bkz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses .

Name	Tür	Description
error	Error	Azure AgPlatform hizmetinden bir hata.
traceId	string	Benzersiz izleme kimliği.

InnerError

Hata listesini içeren iç hata. InnerError başvuru belgesi için bkz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object .

Name	Tür	Description
code	string	İçeren hata tarafından sağlanandan özel hata kodu.
innererror	InnerError	Hata listesini içeren iç hata. InnerError başvuru belgesi için bkz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object .

Location

Konum modeli sınıfı.

Name	Tür	Description
latitude	number	Konumun enlemi.
longitude	number	Konumun boylamı.

Aracılığıyla paylaş

Devices - Create Or Update

URI Parametreleri

İstek Başlığı

İstek Gövdesi

Yanıtlar

Güvenlik

Authorization

Örnekler

Devices_CreateOrUpdate

Örnek isteği

Örnek yanıt

Tanımlar

Device

Error

ErrorResponse

InnerError

Location

Ek kaynaklar