Device Management - List Deployments For Device Class Subgroup

Layanan:: Device Update

Versi API:: 2022-10-01

Mendapatkan daftar penyebaran untuk subgrup kelas perangkat.

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

Dengan parameter opsional:

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
deviceClassId	path	True	string	Pengidentifikasi kelas perangkat.
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.
orderby	query		string	Memerintahkan set penyebaran yang dikembalikan. Anda dapat memesan berdasarkan tanggal mulai.

Respons

Nama	Jenis	Deskripsi
200 OK	DeploymentsList	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_ListDeploymentsForDeviceClassSubgroup

Permintaan sampel

HTTP

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

Respon sampel

Kode status:: 200

{
  "value": [
    {
      "deploymentId": "deploymentId1",
      "groupId": "TestGroup",
      "startDateTime": "2020-07-01T12:13:14Z",
      "update": {
        "updateId": {
          "provider": "provider1",
          "name": "name1",
          "version": "1.0.0.0"
        }
      },
      "rollbackPolicy": {
        "update": {
          "updateId": {
            "provider": "provider1",
            "name": "name1",
            "version": "0.9.0"
          }
        },
        "failure": {
          "devicesFailedPercentage": 50,
          "devicesFailedCount": 100
        }
      },
      "isCanceled": false,
      "isRetried": false,
      "isCloudInitiatedRollback": false
    },
    {
      "deploymentId": "deploymentId2",
      "groupId": "TestGroup",
      "startDateTime": "2020-08-01T12:13:14Z",
      "update": {
        "updateId": {
          "provider": "provider2",
          "name": "name2",
          "version": "2.0.0.0"
        }
      },
      "rollbackPolicy": {
        "update": {
          "updateId": {
            "provider": "provider2",
            "name": "name2",
            "version": "1.0.0.0"
          }
        },
        "failure": {
          "devicesFailedPercentage": 20,
          "devicesFailedCount": 150
        }
      },
      "isCanceled": false,
      "isRetried": false,
      "isCloudInitiatedRollback": false
    }
  ]
}

Definisi

Nama	Deskripsi
CloudInitiatedRollbackPolicy	Kebijakan pembatalan untuk penyebaran
CloudInitiatedRollbackPolicyFailure	Kondisi kegagalan untuk memulai kebijakan pembatalan
Deployment	Metadata penyebaran.
DeploymentsList	Daftar penyebaran.
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.

CloudInitiatedRollbackPolicy

Objek

Kebijakan pembatalan untuk penyebaran

Nama	Jenis	Deskripsi
failure	CloudInitiatedRollbackPolicyFailure	Kondisi kegagalan untuk memulai kebijakan pembatalan.
update	UpdateInfo	Perbarui untuk digulung balik.

CloudInitiatedRollbackPolicyFailure

Objek

Kondisi kegagalan untuk memulai kebijakan pembatalan

Nama	Jenis	Deskripsi
devicesFailedCount	integer (int32)	Jumlah perangkat yang gagal.
devicesFailedPercentage	integer (int32)	Persentase perangkat yang gagal.

Deployment

Objek

Metadata penyebaran.

Nama	Jenis	Deskripsi
deploymentId	string	Pengidentifikasi penyebaran yang disediakan pemanggil. Ini tidak boleh lebih panjang dari 73 karakter, harus semua huruf kecil, dan tidak boleh berisi '&', '^', '[', ']', '{', '}', '\|', '<', '>', garis miring, garis miring, atau tanda kutip ganda. Tampilan Pembaruan di sumber daya portal Azure IoT Hub menghasilkan GUID untuk deploymentId saat Anda membuat penyebaran.
deviceClassSubgroups	string[]	Subgrup kelas perangkat yang kompatibel dengan penyebaran dan penyebaran subgrup telah dibuat. Ini tidak disediakan oleh pemanggil selama CreateOrUpdateDeployment tetapi secara otomatis ditentukan oleh Pembaruan Perangkat
groupId	string	Identitas grup untuk perangkat yang disebarkan dimaksudkan untuk diperbarui.
isCanceled	boolean	Bendera Boolean yang menunjukkan apakah penyebaran dibatalkan.
isCloudInitiatedRollback	boolean	Bendera Boolean menunjukkan apakah penyebaran adalah penyebaran pembatalan.
isRetried	boolean	Bendera Boolean menunjukkan apakah penyebaran telah dicoba kembali.
rollbackPolicy	CloudInitiatedRollbackPolicy	Kebijakan pembatalan untuk penyebaran.
startDateTime	string (date-time)	Tanggalwaktu mulai penyebaran.
update	UpdateInfo	Perbarui informasi untuk pembaruan dalam penyebaran.

DeploymentsList

Objek

Daftar penyebaran.

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