Device Update - Get Update

Layanan:

Device Update

Versi API:

2022-10-01

Dapatkan versi pembaruan tertentu.

GET https://{endpoint}/deviceUpdate/{instanceId}/updates/providers/{provider}/names/{name}/versions/{version}?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.
name	path	True	string	Perbarui nama.
provider	path	True	string	Perbarui penyedia.
version	path	True	string	Perbarui versi.
api-version	query	True	string	Versi API yang akan digunakan dengan permintaan klien.

Header Permintaan

Nama	Diperlukan	Jenis	Deskripsi
If-None-Match		string	Menentukan kondisi If-None-Match. Operasi akan dilakukan hanya jika ETag pada server tidak cocok dengan nilai ini.

Respons

Nama	Jenis	Deskripsi
200 OK	Update	Versi pembaruan yang diminta.
Other Status Codes	ErrorResponse	Respons default.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory

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

Cakupan

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

Contoh

DeviceUpdate_GetUpdate

Permintaan sampel

HTTP

GET https://contoso.api.adu.microsoft.com/deviceUpdate/blue/updates/providers/microsoft/names/adu/versions/1.0.0.0?api-version=2022-10-01

Respon sampel

Kode status:

200

{
  "updateId": {
    "provider": "microsoft",
    "name": "adu",
    "version": "1.0.0.0"
  },
  "friendlyName": "Lab Sensor Update v1",
  "description": "Fix for critical vulnerability",
  "compatibility": [
    {
      "deviceManufacturer": "Microsoft",
      "deviceModel": "Toaster"
    }
  ],
  "instructions": {
    "steps": [
      {
        "description": "pre-install script",
        "handler": "microsoft/script:1",
        "handlerProperties": {
          "arguments": "--pre-install"
        },
        "files": [
          "configure.sh"
        ]
      },
      {
        "type": "reference",
        "updateId": {
          "provider": "microsoft",
          "name": "sensor",
          "version": "1.0"
        }
      }
    ]
  },
  "manifestVersion": "5.0",
  "importedDateTime": "2020-04-22T21:01:43.8408797+00:00",
  "createdDateTime": "2019-09-12T00:00:00.0000000+00:00",
  "etag": "\"3fed3378-0c67-47d2-b796-296962c66cbb\""
}

Definisi

Nama	Deskripsi
Error	Detail kesalahan.
ErrorResponse	Respons kesalahan umum.
InnerError	Objek yang berisi informasi yang lebih spesifik daripada objek saat ini tentang kesalahan.
Instructions
Step	Perbarui langkah instruksi penginstalan.
StepType	Jenis langkah.
Update	Perbarui metadata.
UpdateId	Memperbarui pengidentifikasi.

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.

Instructions

Objek

Nama	Jenis	Deskripsi
steps	Step[]	Kumpulan langkah-langkah penginstalan.

Step

Objek

Perbarui langkah instruksi penginstalan.

Nama	Jenis	Nilai default	Deskripsi
description	string minLength: 1 maxLength: 64		Deskripsi langkah.
files	string[]		Kumpulan nama file yang akan diteruskan ke handler selama eksekusi. Diperlukan jika jenis langkah sebaris.
handler	string minLength: 1 maxLength: 32		Identitas handler yang akan menjalankan langkah ini. Diperlukan jika jenis langkah sebaris.
handlerProperties	object		Parameter yang akan diteruskan ke handler selama eksekusi.
type	StepType	inline	Jenis langkah.
updateId	UpdateId		Identitas pembaruan anak yang dirujuk. Diperlukan jika jenis langkah adalah referensi.

StepType

Enumeration

Jenis langkah.

Nilai	Deskripsi
inline
reference

Update

Objek

Perbarui metadata.

Nama	Jenis	Nilai default	Deskripsi
compatibility	object[]		Daftar informasi kompatibilitas pembaruan.
createdDateTime	string (date-time)		Tanggal dan waktu dalam UTC saat pembaruan dibuat.
description	string minLength: 1 maxLength: 512		Deskripsi pembaruan yang ditentukan oleh pembuat.
etag	string		Perbarui ETag.
friendlyName	string minLength: 1 maxLength: 512		Nama pembaruan ramah yang ditentukan oleh pengimpor.
importedDateTime	string (date-time)		Tanggal dan waktu dalam UTC saat pembaruan diimpor.
installedCriteria	string		String yang ditafsirkan oleh klien Pembaruan Perangkat untuk menentukan apakah pembaruan diinstal pada perangkat. Tidak digunakan lagi dalam skema manifes impor terbaru.
instructions	Instructions		Perbarui instruksi penginstalan.
isDeployable	boolean	True	Apakah pembaruan dapat disebarkan ke perangkat sendiri.
manifestVersion	string		Versi skema manifes yang digunakan untuk mengimpor pembaruan.
referencedBy	UpdateId[]		Daftar identitas pembaruan yang mereferensikan pembaruan ini.
scanResult	string		Perbarui hasil pemindaian agregat (dihitung dari hasil pemindaian file payload).
updateId	UpdateId		Perbarui identitas.
updateType	string		Jenis pembaruan. Tidak digunakan lagi dalam skema manifes impor terbaru.

UpdateId

Objek

Memperbarui pengidentifikasi.

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