Devices - Get

Hizmet:

IoT Central

API Sürümü:

2022-07-31

Kimliğe göre cihaz alma
Cihaz kimliğine göre mevcut bir cihazla ilgili ayrıntıları alın.

GET https://{subdomain}.{baseDomain}/api/devices/{deviceId}?api-version=2022-07-31

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
baseDomain	path	True	string	Tüm Azure IoT Central hizmet istekleri için temel etki alanı.
deviceId	path	True	string	Cihazın benzersiz kimliği.
subdomain	path	True	string	Uygulama alt etki alanı.
api-version	query	True	string	Çağrılan API sürümü.

Yanıtlar

Name	Tür	Description
200 OK	Device	Başarılı
Other Status Codes	Error	IoT Central Hizmetinden alınan bir hata yanıtı. Üst Bilgiler x-ms-error-code: string

Güvenlik

azure_auth

Azure Active Directory OAuth2 Flow

Tür: oauth2
Akış: implicit
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/authorize

Kapsamlar

Name	Description
user_impersonation	kullanıcı hesabınızın kimliğine bürünme

Örnekler

Get device by ID

Örnek isteği

HTTP

GET https://appsubdomain.azureiotcentral.com/api/devices/CheckoutThermostat?api-version=2022-07-31

Örnek yanıt

Durum kodu:

200

{
  "id": "CheckoutThermostat",
  "etag": "eyJoZWFkZXIiOiJcIjAyMDA4YzMyLTAwMDAtMGQwMC0wMDAwLTVkOTY4YjdhMDAwMFwiIn0",
  "displayName": "CheckoutThermostat",
  "template": "dtmi:contoso:testDeviceTemplate;1",
  "simulated": true,
  "provisioned": true,
  "enabled": true,
  "organizations": [
    "seattle"
  ]
}

Tanımlar

Name	Description
Device	Cihaz tanımı.
Error	Yanıt hatası tanımı.
ErrorDetails	Hatanın ayrıntılı bilgileri.

Device

Cihaz tanımı.

Name	Tür	Description
displayName	string	Cihazın görünen adı.
enabled	boolean	IoT Central'a cihaz bağlantısının etkinleştirilip etkinleştirilmediği.
etag	string	Cihaz güncelleştirmelerinde çakışmayı önlemek için kullanılan ETag.
id	string	Cihazın benzersiz kimliği.
organizations	string[]	Cihazın parçası olduğu kuruluş kimliklerinin listesi, bugün yalnızca bir kuruluş destekleniyor, yakında birden çok kuruluş desteklenecek.
provisioned	boolean	Kaynakların cihaz için ayrılıp ayrılmadığı.
simulated	boolean	Cihazın simülasyonunun yapılıp yapılmadığı.
template	string	Cihazın cihaz şablonu tanımı.

Error

Yanıt hatası tanımı.

Name	Tür	Description
error	ErrorDetails	Geçerli istek için hata ayrıntıları.

ErrorDetails

Hatanın ayrıntılı bilgileri.

Name	Tür	Description
code	string	Hata kodu.
message	string	Hata iletisi ayrıntıları.
requestId	string	Geçerli istek için bağıntı kimliği.
time	string	Hata isteğinin başarısız olduğu zaman.