Device Groups - Get

Szerezze be az eszközcsoportot azonosító alapján.

GET https://{subdomain}.{baseDomain}/api/deviceGroups/{deviceGroupId}?api-version=2022-06-30-preview

URI-paraméterek

Name In Required Type Description
baseDomain
path True
  • string

Az azure IoT Central-szolgáltatáskérések alaptartománya.

deviceGroupId
path True
  • string

Az eszközcsoport egyedi azonosítója.

Regex pattern: ^[a-zA-Z0-9_-]*$

subdomain
path True
  • string

Az alkalmazás altartománya.

api-version
query True
  • string

A meghívott API verziója.

Válaszok

Name Type Description
200 OK

Siker

Other Status Codes

Hibaválasz érkezett az IoT Central-szolgáltatástól.

Headers

  • x-ms-error-code: string

Biztonság

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 felhasználói fiók megszemélyesítése

Példák

Get device group by ID

Sample Request

GET https://appsubdomain.azureiotcentral.com/api/deviceGroups/475cad48-b7ff-4a09-b51e-1a9021385453?api-version=2022-06-30-preview

Sample Response

{
  "id": "475cad48-b7ff-4a09-b51e-1a9021385453",
  "displayName": "DeviceGroupEntry1",
  "description": "This is a default device group containing all the devices for this particular Device Template.",
  "filter": "SELECT * FROM devices WHERE $template = \"dtmi:modelDefinition:dtdlv2\" AND $provisioned = true",
  "organizations": [
    "seattle"
  ]
}

Definíciók

DeviceGroup

Az eszközcsoport definíciója.

Error

A válaszhiba definíciója.

ErrorDetails

A hiba részletes információi.

DeviceGroup

Az eszközcsoport definíciója.

Name Type Description
description
  • string

Az eszközcsoport rövid összefoglalása.

displayName
  • string

Az eszközcsoport megjelenítendő neve.

etag
  • string

Az eszközcsoport-frissítések ütközésének megakadályozására szolgáló eTag.

filter
  • string

Lekérdezés, amely meghatározza, hogy mely eszközök legyenek ebben a csoportban, lekérdezési nyelv referenciája.

id
  • string

Az eszközcsoport egyedi azonosítója.

organizations
  • string[]

Az eszközcsoport szervezeti azonosítóinak listája, jelenleg csak egy szervezet támogatott, és hamarosan több szervezet is támogatott lesz.

Error

A válaszhiba definíciója.

Name Type Description
error

Az aktuális kérelem hibaadatai.

ErrorDetails

A hiba részletes információi.

Name Type Description
code
  • string

Hibakód.

message
  • string

A hibaüzenet részletei.

requestId
  • string

Az aktuális kérés korrelációs azonosítója.

time
  • string

A hibakérés meghiúsult időpontja.