Device Groups - Get

Pobierz grupę urządzeń według identyfikatora.

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

Parametry identyfikatora URI

Name In Required Type Description
baseDomain
path True
  • string

Domena podstawowa dla wszystkich żądań obsługi usługi Azure IoT Central.

deviceGroupId
path True
  • string

Unikatowy identyfikator grupy urządzeń.

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

subdomain
path True
  • string

Poddomena aplikacji.

api-version
query True
  • string

Wywoływana wersja interfejsu API.

Odpowiedzi

Name Type Description
200 OK

Powodzenie

Other Status Codes

Odebrano odpowiedź o błędzie z usługi IoT Central.

Headers

  • x-ms-error-code: string

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

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

Scopes

Name Description
user_impersonation personifikacja konta użytkownika

Przykłady

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

Definicje

DeviceGroup

Definicja grupy urządzeń.

Error

Definicja błędu odpowiedzi.

ErrorDetails

Szczegółowe informacje o błędzie.

DeviceGroup

Definicja grupy urządzeń.

Name Type Description
description
  • string

Krótkie podsumowanie grupy urządzeń.

displayName
  • string

Nazwa wyświetlana grupy urządzeń.

etag
  • string

Element ETag używany do zapobiegania konfliktom w aktualizacjach grupy urządzeń.

filter
  • string

Zapytanie definiujące, które urządzenia powinny znajdować się w tej grupie, Dokumentacja języka zapytań.

id
  • string

Unikatowy identyfikator grupy urządzeń.

organizations
  • string[]

Lista identyfikatorów organizacji grupy urządzeń, obecnie obsługiwana jest tylko jedna organizacja. Wiele organizacji będzie obsługiwanych wkrótce.

Error

Definicja błędu odpowiedzi.

Name Type Description
error

Szczegóły błędu dla bieżącego żądania.

ErrorDetails

Szczegółowe informacje o błędzie.

Name Type Description
code
  • string

Kod błędu.

message
  • string

Szczegóły komunikatu o błędzie.

requestId
  • string

Identyfikator korelacji dla bieżącego żądania.

time
  • string

Czas niepowodzenia żądania błędu.