Device Groups - Get

Rufen Sie die Gerätegruppe nach ID ab.

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

URI-Parameter

Name In Required Type Description
baseDomain
path True
  • string

Die Basisdomäne für alle Azure IoT Central-Dienstanforderungen.

deviceGroupId
path True
  • string

Eindeutige ID für die Gerätegruppe.

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

subdomain
path True
  • string

Die Anwendungsdomäne.

api-version
query True
  • string

Die Version der aufgerufenen API.

Antworten

Name Type Description
200 OK

Erfolg

Other Status Codes

Eine Fehlerantwort, die vom IoT Central Service empfangen wurde.

Headers

  • x-ms-error-code: string

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

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

Scopes

Name Description
user_impersonation Identitätswechsel Ihres Benutzerkontos

Beispiele

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

Definitionen

DeviceGroup

Die Gerätegruppendefinition.

Error

Die Antwortfehlerdefinition.

ErrorDetails

Die Detailinformationen des Fehlers.

DeviceGroup

Die Gerätegruppendefinition.

Name Type Description
description
  • string

Kurze Zusammenfassung der Gerätegruppe.

displayName
  • string

Anzeigename der Gerätegruppe.

etag
  • string

ETag wird verwendet, um Konflikte in Gerätegruppenupdates zu verhindern.

filter
  • string

Abfrage, die definiert, welche Geräte in dieser Gruppe enthalten sein sollen, Abfragesprachereferenz.

id
  • string

Eindeutige ID der Gerätegruppe.

organizations
  • string[]

Liste der Organisations-IDs der Gerätegruppe, nur eine Organisation wird heute unterstützt, mehrere Organisationen werden bald unterstützt.

Error

Die Antwortfehlerdefinition.

Name Type Description
error

Fehlerdetails für aktuelle Anforderung.

ErrorDetails

Die Detailinformationen des Fehlers.

Name Type Description
code
  • string

Fehlercode

message
  • string

Details der Fehlermeldung.

requestId
  • string

Korrelations-ID für aktuelle Anforderung.

time
  • string

Fehler bei der Fehleranforderung.