Devices - Get Properties

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

Hämta enhetsegenskaper
Hämta alla egenskapsvärden för en enhet efter enhets-ID.

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

URI-parametrar

Name I Obligatorisk Typ Description
baseDomain
 path True

string

Basdomänen för alla Azure IoT Central-tjänstbegäranden.
deviceId
 path True

string

Unikt ID för enheten.
subdomain
 path True

string

Programmets underdomän.
api-version
 query True

string

Den version av API:et som anropas.

Svar

Name Typ Description
200 OK

DeviceProperties

Klart
Other Status Codes

Error

Ett felsvar som togs emot från IoT Central-tjänsten.

Headers

x-ms-error-code: string

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name Description
user_impersonation personifiera ditt användarkonto

Exempel

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

Definitioner

Name Description
Error

Svarsfeldefinitionen.
ErrorDetails

Information om felet.

Error

Svarsfeldefinitionen.

Name Typ Description
error

ErrorDetails

Felinformation för aktuell begäran.

ErrorDetails

Information om felet.

Name Typ Description
code

string

Felkod.
message

string

Information om felmeddelanden.
requestId

string

Korrelations-ID för aktuell begäran.
time

string

Tiden då felbegäran misslyckades.