Devices - Get Properties

  • Reference
Service:
IoT Central
API Version:
2022-07-31

Získání vlastností zařízení
Získá všechny hodnoty vlastností zařízení podle ID zařízení.

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
baseDomain
 path True

string

Základní doména pro všechny žádosti o službu Azure IoT Central.
deviceId
 path True

string

Jedinečné ID zařízení
subdomain
 path True

string

Subdoména aplikace.
api-version
 query True

string

Verze volaného rozhraní API

Odpovědi

Name Typ Description
200 OK

DeviceProperties

Success
Other Status Codes

Error

Služba IoT Central přijala chybovou odpověď.

Headers

x-ms-error-code: string

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation zosobnění uživatelského účtu

Příklady

Get properties

Sample Request

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

Sample Response

Status code:
200 
{
  "deviceinfo": {
    "manufacturer": "manufacturer",
    "$metadata": {
      "manufacturer": {
        "lastUpdateTime": "2020-07-21T19:06:50.9718608Z"
      },
      "model": {
        "lastUpdateTime": "2020-07-21T19:06:50.9718608Z"
      },
      "swVersion": {
        "lastUpdateTime": "2020-07-21T19:06:50.9718608Z"
      }
    },
    "model": "model",
    "swVersion": "swVersion"
  },
  "settings": {
    "fanSpeed": 12.5,
    "$metadata": {
      "fanSpeed": {
        "desiredValue": 30,
        "desiredVersion": 2,
        "lastUpdateTime": "2020-07-21T19:06:50.9718608Z"
      }
    }
  }
}

Definice

Name Description
Error

Definice chyby odpovědi.
ErrorDetails

Podrobné informace o chybě.

Error

Definice chyby odpovědi.

Name Typ Description
error

ErrorDetails

Podrobnosti o chybě pro aktuální požadavek

ErrorDetails

Podrobné informace o chybě.

Name Typ Description
code

string

Kód chyby
message

string

Podrobnosti o chybové zprávě
requestId

string

ID korelace pro aktuální požadavek.
time

string

Čas, kdy žádost o chybu selhala.