Device Management - Get Group

Odwołanie

Service:: Device Update

API Version:: 2021-06-01-preview

Pobiera właściwości grupy.

GET https://{endpoint}/deviceupdate/{instanceId}/management/groups/{groupId}?api-version=2021-06-01-preview

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
endpoint	path	True	string	Punkt końcowy konta.
groupId	path	True	string	Tożsamość grupy.
instanceId	path	True	string	Identyfikator wystąpienia konta.
api-version	query	True	string	Wersja interfejsu API do użycia z żądaniem klienta.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	Group	Właściwości grupy.
Other Status Codes	ErrorResponse	Domyślna odpowiedź.

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

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

DeviceManagement_GetGroup

Sample Request

HTTP

GET https://contoso.api.adu.microsoft.com/deviceupdate/blue/management/groups/group1?api-version=2021-06-01-preview

Sample Response

Status code:: 200

{
  "groupId": "MyGroup",
  "groupType": "DeviceClassIdAndIoTHubTag",
  "tags": [
    "MyAduGroup"
  ],
  "createdDateTime": "2020-07-01T12:13:14.0000000Z",
  "deviceClassId": "DeviceClassId",
  "deviceCount": 149
}

Definicje

Nazwa	Opis
Error	Szczegóły błędu.
ErrorResponse	Typowa odpowiedź na błąd.
Group	Szczegóły grupy.
GroupType	Obsługiwane typy grup.
InnerError	Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.

Error

Szczegóły błędu.

Nazwa	Typ	Opis
code	string	Kod błędu zdefiniowany przez serwer.
details	Error[]	Tablica błędów, które doprowadziły do zgłoszonego błędu.
innererror	InnerError	Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.
message	string	Czytelna dla człowieka reprezentacja błędu.
occurredDateTime	string	Data i godzina w formacie UTC, kiedy wystąpił błąd.
target	string	Element docelowy błędu.

ErrorResponse

Typowa odpowiedź na błąd.

Nazwa	Typ	Opis
error	Error	Szczegóły błędu.

Group

Szczegóły grupy.

Nazwa	Typ	Opis
createdDateTime	string	Data i godzina utworzenia aktualizacji.
deploymentId	string	Identyfikator wdrożenia dla grupy.
deviceClassId	string	Identyfikator klasy urządzenia dla grupy.
deviceCount	integer	Liczba urządzeń w grupie.
groupId	string	Tożsamość grupy.
groupType	GroupType	Typ grupy.
tags	string[]	IoT Hub tagów.

GroupType

Obsługiwane typy grup.

Nazwa	Typ	Opis
DefaultDeviceClassId	string	Domyślna grupa oparta na parametrze deviceClassId— wszystkie urządzenia w grupie nie mają tagów, ale są częścią tego samego identyfikatora deviceClassId. Wszystkie urządzenia będą częścią jednej z tych grup, dopóki użytkownik nie oznaczy ich w celu dołączenia do innej grupy.
DeviceClassIdAndIoTHubTag	string	DeviceClassId IoT Hub grupy opartej na tagach, wszystkie urządzenia w grupie są zgodne z tymi samymi aktualizacjami i współużytkują tag i deviceClassId.
InvalidDeviceClassIdAndIoTHubTag	string	Nieprawidłowa nazwa deviceClassId IoT Hub grupy opartej na tagach, wszystkie urządzenia w grupie nie są zgodne z identyfikatorem deviceClassId prawidłowej grupy, do której zostały oznaczone jako przyłączone.

InnerError

Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.

Nazwa	Typ	Opis
code	string	Bardziej szczegółowy kod błędu niż podany przez błąd zawierający.
errorDetail	string	Wewnętrzny błąd lub komunikat o wyjątku.
innerError	InnerError	Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.
message	string	Czytelna dla człowieka reprezentacja błędu.