Device Management - Get Update Compliance

Layanan:: Device Update

Versi API:: 2022-10-01

Mendapatkan perincian berapa banyak perangkat pada pembaruan terbaru mereka, memiliki pembaruan baru yang tersedia, atau sedang berlangsung menerima pembaruan baru.

GET https://{endpoint}/deviceUpdate/{instanceId}/management/updateCompliance?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).
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	UpdateCompliance	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_GetUpdateCompliance

Permintaan sampel

HTTP

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

Respon sampel

Kode status:: 200

{
  "totalDeviceCount": 302204,
  "onLatestUpdateDeviceCount": 256873,
  "newUpdatesAvailableDeviceCount": 36265,
  "updatesInProgressDeviceCount": 9066
}

Definisi

Nama	Deskripsi
Error	Detail kesalahan.
ErrorResponse	Respons kesalahan umum.
InnerError	Objek yang berisi informasi yang lebih spesifik daripada objek saat ini tentang kesalahan.
UpdateCompliance	Memperbarui informasi kepatuhan.

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.

UpdateCompliance

Objek

Memperbarui informasi kepatuhan.

Nama	Jenis	Deskripsi
newUpdatesAvailableDeviceCount	integer (int32)	Jumlah perangkat dengan pembaruan yang lebih baru yang tersedia.
onLatestUpdateDeviceCount	integer (int32)	Jumlah perangkat pada pembaruan terbaru.
totalDeviceCount	integer (int32)	Jumlah total perangkat.
updatesInProgressDeviceCount	integer (int32)	Jumlah perangkat dengan pembaruan sedang berlangsung.