Device Management - List Groups

Layanan:: Device Update

Versi API:: 2022-10-01

Mendapatkan daftar semua grup perangkat. Grup $default akan selalu dikembalikan terlebih dahulu.

GET https://{endpoint}/deviceUpdate/{instanceId}/management/groups?api-version=2022-10-01

Dengan parameter opsional:

GET https://{endpoint}/deviceUpdate/{instanceId}/management/groups?api-version=2022-10-01&orderby={orderby}

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
endpoint	path	True	string (url)	Titik akhir akun Device Update for IoT Hub (hanya nama host, tanpa protokol).
instanceId	path	True	string	Pengidentifikasi instans akun Device Update for IoT Hub.
api-version	query	True	string minLength: 1	Versi API yang akan digunakan untuk operasi ini.
orderby	query		string	Mengurutkan kumpulan grup yang dikembalikan. Anda dapat memesan menurut groupId, deviceCount, createdDate, subgroupsWithNewUpdatesAvailableCount, subgroupsWithUpdatesInProgressCount, atau subgroupsOnLatestUpdateCount.

Respons

Nama	Jenis	Deskripsi
200 OK	GroupsList	Permintaan telah berhasil.
Other Status Codes	ErrorResponse	Respons kesalahan tak terduga.

Keamanan

OAuth2Auth

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama	Deskripsi
https://api.adu.microsoft.com/.default

Contoh

DeviceManagement_ListGroups

Permintaan sampel

HTTP

GET https://contoso.api.adu.microsoft.com/deviceUpdate/blue/management/groups?api-version=2022-10-01

Respon sampel

Kode status:: 200

{
  "value": [
    {
      "groupId": "MyGroup1",
      "groupType": "IoTHubTag",
      "createdDateTime": "2020-07-01T12:13:14Z",
      "deviceCount": 100,
      "subgroupsWithNewUpdatesAvailableCount": 2,
      "subgroupsWithUpdatesInProgressCount": 0,
      "subgroupsWithOnLatestUpdateCount": 1,
      "deployments": [
        "deployment1",
        "deployment2"
      ]
    },
    {
      "groupId": "MyGroup2",
      "groupType": "IoTHubTag",
      "createdDateTime": "2020-08-01T12:13:14Z",
      "deviceCount": 200,
      "subgroupsWithNewUpdatesAvailableCount": 1,
      "subgroupsWithUpdatesInProgressCount": 1,
      "subgroupsWithOnLatestUpdateCount": 1,
      "deployments": [
        "deployment3",
        "deployment4"
      ]
    }
  ]
}

Definisi

Nama	Deskripsi
Error	Detail kesalahan.
ErrorResponse	Respons kesalahan umum.
Group	Detail grup.
GroupsList	Daftar grup.
GroupType	Jenis grup yang didukung.
InnerError	Objek yang berisi informasi yang lebih spesifik daripada objek saat ini tentang kesalahan.

Error

Objek

Detail kesalahan.

Nama	Jenis	Deskripsi
code	string	Kode kesalahan yang ditentukan server.
details	Error[]	Array kesalahan yang menyebabkan kesalahan yang dilaporkan.
innererror	InnerError	Objek yang berisi informasi yang lebih spesifik daripada objek saat ini tentang kesalahan.
message	string	Representasi kesalahan yang dapat dibaca manusia.
occurredDateTime	string (date-time)	Tanggal dan waktu dalam UTC ketika kesalahan terjadi.
target	string	Target kesalahan.

ErrorResponse

Objek

Respons kesalahan umum.

Nama	Jenis	Deskripsi
error	Error	Detail kesalahan.

Group

Objek

Detail grup.

Nama	Jenis	Deskripsi
createdDateTime	string	Tanggal dan waktu saat pembaruan dibuat.
deployments	string[]	Id penyebaran aktif untuk grup
deviceCount	integer (int32)	Jumlah perangkat dalam grup.
groupId	string	Identitas grup. Ini dibuat dari nilai tag ADUGroup di perangkat/modul kembar Iot Hub atau $default untuk perangkat tanpa tag.
groupType	GroupType	Jenis grup.
subgroupsWithNewUpdatesAvailableCount	integer (int32)	Jumlah subgrup dengan pembaruan baru yang tersedia.
subgroupsWithOnLatestUpdateCount	integer (int32)	Jumlah subgrup dengan perangkat pada pembaruan terbaru.
subgroupsWithUpdatesInProgressCount	integer (int32)	Jumlah subgrup dengan pembaruan sedang berlangsung.

GroupsList

Objek

Daftar grup.

Nama	Jenis	Deskripsi
nextLink	string (uri)	Tautan ke halaman item berikutnya
value	Group[]	Item Grup di halaman ini

GroupType

Enumerasi

Jenis grup yang didukung.

Nilai	Deskripsi
IoTHubTag	Grup berbasis tag IoT Hub, semua perangkat dalam grup berbagi nilai tag ADUGroup.
DefaultNoTag	Grup default untuk perangkat yang tidak diberi tag.

InnerError

Objek

Objek yang berisi informasi yang lebih spesifik daripada objek saat ini tentang kesalahan.

Nama	Jenis	Deskripsi
code	string	Kode kesalahan yang lebih spesifik daripada yang disediakan oleh kesalahan yang berisi.
errorDetail	string	Pesan kesalahan internal atau pengecualian.
innerError	InnerError	Objek yang berisi informasi yang lebih spesifik daripada objek saat ini tentang kesalahan.
message	string	Representasi kesalahan yang dapat dibaca manusia.