Device Management - List Best Updates For Group

Layanan:

Device Update

Versi API:

2022-10-01

Dapatkan pembaruan terbaik yang tersedia untuk grup perangkat dan hitungan berapa banyak perangkat yang membutuhkan setiap pembaruan.

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

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).
groupId	path	True	string	Pengidentifikasi grup.
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.

Respons

Nama	Jenis	Deskripsi
200 OK	DeviceClassSubgroupUpdatableDevicesList	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_ListBestUpdatesForGroup

Permintaan sampel

HTTP

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

Respon sampel

Kode status:

200

{
  "value": [
    {
      "groupId": "group1",
      "deviceClassId": "deviceClassId1",
      "update": {
        "updateId": {
          "provider": "provider1",
          "name": "name1",
          "version": "1.0.0.0"
        }
      },
      "deviceCount": 100
    },
    {
      "groupId": "group1",
      "deviceClassId": "deviceClassId2",
      "update": {
        "updateId": {
          "provider": "provider2",
          "name": "name2",
          "version": "2.0.0.0"
        }
      },
      "deviceCount": 200
    }
  ]
}

Definisi

Nama	Deskripsi
DeviceClassSubgroupUpdatableDevices	Subgrup kelas perangkat, informasi pembaruan, dan jumlah perangkat yang pembaruannya berlaku.
DeviceClassSubgroupUpdatableDevicesList	Daftar perangkat yang dapat diperbarui untuk subgrup kelas perangkat.
Error	Detail kesalahan.
ErrorResponse	Respons kesalahan umum.
InnerError	Objek yang berisi informasi yang lebih spesifik daripada objek saat ini tentang kesalahan.
UpdateId	Memperbarui pengidentifikasi.
UpdateInfo	Perbarui informasi.

DeviceClassSubgroupUpdatableDevices

Objek

Subgrup kelas perangkat, informasi pembaruan, dan jumlah perangkat yang pembaruannya berlaku.

Nama	Jenis	Deskripsi
deviceClassId	string	Id kelas perangkat subgrup kelas perangkat
deviceCount	integer (int32)	Jumlah total perangkat yang pembaruannya berlaku.
groupId	string	Id grup
update	UpdateInfo	Perbarui informasi.

DeviceClassSubgroupUpdatableDevicesList

Objek

Daftar perangkat yang dapat diperbarui untuk subgrup kelas perangkat.

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

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.

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.

UpdateId

Objek

Memperbarui pengidentifikasi.

Nama	Jenis	Deskripsi
name	string	Perbarui nama.
provider	string	Perbarui penyedia.
version	string	Perbarui versi.

UpdateInfo

Objek

Perbarui informasi.

Nama	Jenis	Deskripsi
description	string	Perbarui deskripsi.
friendlyName	string	Nama pembaruan yang mudah diingat.
updateId	UpdateId	Memperbarui pengidentifikasi.