Device Management - List Devices

Layanan:: Device Update

Versi API:: 2022-10-01

Mendapatkan daftar perangkat yang tersambung ke Device Update for IoT Hub.

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

Dengan parameter opsional:

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

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.
filter	query		string	Membatasi kumpulan perangkat yang dikembalikan. Anda dapat memfilter GroupId, DeviceClassId, atau GroupId dan DeploymentStatus. Gunakan DeploymentStatus eq null untuk mengkueri perangkat tanpa status penyebaran (yang belum pernah disebarkan).

Respons

Nama	Jenis	Deskripsi
200 OK	DevicesList	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_ListDevices

Permintaan sampel

HTTP

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

Respon sampel

Kode status:: 200

{
  "value": [
    {
      "deviceId": "device1",
      "deviceClassId": "deviceClassId1",
      "lastAttemptedUpdate": {
        "updateId": {
          "provider": "provider1",
          "name": "name1",
          "version": "2.0.0.0"
        }
      },
      "deploymentStatus": "Failed",
      "installedUpdate": {
        "updateId": {
          "provider": "provider1",
          "name": "name1",
          "version": "1.0.0.0"
        }
      },
      "onLatestUpdate": false,
      "lastDeploymentId": "myDeployment123"
    },
    {
      "deviceId": "device2",
      "deviceClassId": "deviceClassId2",
      "lastAttemptedUpdate": {
        "updateId": {
          "provider": "provider2",
          "name": "name2",
          "version": "1.0.0.0"
        }
      },
      "deploymentStatus": "Succeeded",
      "installedUpdate": {
        "updateId": {
          "provider": "provider2",
          "name": "name2",
          "version": "1.0.0.0"
        }
      },
      "onLatestUpdate": true,
      "lastDeploymentId": "myDeployment234"
    }
  ]
}

Definisi

Nama	Deskripsi
Device	Metadata perangkat.
DeviceDeploymentState	Status penyebaran.
DevicesList	Daftar perangkat.
Error	Detail kesalahan.
ErrorResponse	Respons kesalahan umum.
InnerError	Objek yang berisi informasi yang lebih spesifik daripada objek saat ini tentang kesalahan.
InstallResult	Hasil penginstalan pembaruan dan langkah apa pun yang dihasilkan di bawahnya.
StepResult	Hasil langkah di bawah pembaruan.
UpdateId	Memperbarui pengidentifikasi.
UpdateInfo	Perbarui informasi.

Device

Objek

Metadata perangkat.

Nama	Jenis	Deskripsi
deploymentStatus	DeviceDeploymentState	Status perangkat dalam penyebaran terakhirnya.
deviceClassId	string	Identitas kelas perangkat.
deviceId	string	Identitas perangkat.
groupId	string	Identitas grup perangkat.
installedUpdate	UpdateInfo	Pembaruan yang saat ini diinstal pada perangkat.
lastAttemptedUpdate	UpdateInfo	Pembaruan yang terakhir kali dicoba diinstal oleh perangkat.
lastDeploymentId	string	Pengidentifikasi penyebaran untuk penyebaran terakhir ke perangkat
lastInstallResult	InstallResult	Hasil penginstalan terakhir.
moduleId	string	Identitas modul perangkat.
onLatestUpdate	boolean	Bendera Boolean yang menunjukkan apakah pembaruan terbaru (pembaruan yang paling kompatibel untuk kelas dan grup perangkat perangkat) diinstal pada perangkat

DeviceDeploymentState

Enumerasi

Status penyebaran.

Nilai	Deskripsi
Succeeded	Penyebaran telah selesai dengan sukses.
InProgress	Penyebaran sedang berlangsung.
Canceled	Penyebaran dibatalkan.
Failed	Penyebaran telah selesai dengan kegagalan.

DevicesList

Objek

Daftar perangkat.

Nama	Jenis	Deskripsi
nextLink	string (uri)	Tautan ke halaman item berikutnya
value	Device[]	Item Perangkat 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.

InstallResult

Objek

Hasil penginstalan pembaruan dan langkah apa pun yang dihasilkan di bawahnya.

Nama	Jenis	Deskripsi
extendedResultCode	integer (int32)	Menginstal kode hasil yang diperluas
resultCode	integer (int32)	Pasang kode hasil.
resultDetails	string	String yang berisi detail lebih lanjut tentang hasil penginstalan
stepResults	StepResult[]	Array hasil langkah

StepResult

Objek

Hasil langkah di bawah pembaruan.

Nama	Jenis	Deskripsi
description	string	Deskripsi langkah.
extendedResultCode	integer (int32)	Menginstal kode hasil yang diperluas
resultCode	integer (int32)	Pasang kode hasil.
resultDetails	string	String yang berisi detail lebih lanjut tentang hasil penginstalan
update	UpdateInfo	Pembaruan yang diinstal langkah ini jika berjenis referensi.

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.