Device Update - Get Update

Hizmet:

Device Update

API Sürümü:

2022-10-01

Belirli bir güncelleştirme sürümünü alın.

GET https://{endpoint}/deviceUpdate/{instanceId}/updates/providers/{provider}/names/{name}/versions/{version}?api-version=2022-10-01

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
endpoint	path	True	string (url)	IoT Hub hesabı uç noktası için Cihaz Güncelleştirmesi (yalnızca konak adı, protokol yok).
instanceId	path	True	string	IoT Hub hesap örneği tanımlayıcısı için Cihaz Güncelleştirmesi.
name	path	True	string	Adı güncelleştirin.
provider	path	True	string	Sağlayıcıyı güncelleştirin.
version	path	True	string	Sürümü güncelleştirin.
api-version	query	True	string	İstemci isteğiyle kullanılacak API'nin sürümü.

İstek Başlığı

Name	Gerekli	Tür	Description
If-None-Match		string	If-None-Match koşulunu tanımlar. İşlem yalnızca sunucudaki ETag bu değerle eşleşmiyorsa gerçekleştirilir.

Yanıtlar

Name	Tür	Description
200 OK	Update	İstenen güncelleştirme sürümü.
Other Status Codes	ErrorResponse	Varsayılan yanıt.

Güvenlik

azure_auth

Azure Active Directory OAuth2 Akışı

Tür: oauth2
Akış: implicit
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/authorize

Kapsamlar

Name	Description
https://api.adu.microsoft.com/.default	Varsayılan yetkilendirme kapsamı.

Örnekler

DeviceUpdate_GetUpdate

Örnek isteği

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

Örnek yanıt

Durum kodu:

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\""
}

Tanımlar

Name	Description
Error	Hata ayrıntıları.
ErrorResponse	Yaygın hata yanıtı.
InnerError	Hatayla ilgili geçerli nesneden daha belirli bilgiler içeren bir nesne.
Instructions
Step	Yükleme yönergesi adımlarını güncelleştirin.
StepType	Adım türü.
Update	Meta verileri güncelleştirin.
UpdateId	Tanımlayıcıyı güncelleştirin.

Error

Object

Hata ayrıntıları.

Name	Tür	Description
code	string	Sunucu tanımlı hata kodu.
details	Error[]	Bildirilen hataya yol açan bir hata dizisi.
innererror	InnerError	Hatayla ilgili geçerli nesneden daha belirli bilgiler içeren bir nesne.
message	string	Hatanın insan tarafından okunabilir bir gösterimi.
occurredDateTime	string (date-time)	Hatanın oluştuğu TARIH ve SAAT UTC.
target	string	Hatanın hedefi.

ErrorResponse

Object

Yaygın hata yanıtı.

Name	Tür	Description
error	Error	Hata ayrıntıları.

InnerError

Object

Hatayla ilgili geçerli nesneden daha belirli bilgiler içeren bir nesne.

Name	Tür	Description
code	string	İçeren hata tarafından sağlanandan daha özel bir hata kodu.
errorDetail	string	İç hata veya özel durum iletisi.
innerError	InnerError	Hatayla ilgili geçerli nesneden daha belirli bilgiler içeren bir nesne.
message	string	Hatanın insan tarafından okunabilir bir gösterimi.

Instructions

Object

Name	Tür	Description
steps	Step[]	Yükleme adımlarının koleksiyonu.

Step

Object

Yükleme yönergesi adımlarını güncelleştirin.

Name	Tür	Default value	Description
description	string minLength: 1 maxLength: 64		Adım açıklaması.
files	string[]		Yürütme sırasında işleyiciye geçirilecek dosya adlarının koleksiyonu. Adım türü satır içiyse gereklidir.
handler	string minLength: 1 maxLength: 32		Bu adımı yürütecek işleyicinin kimliği. Adım türü satır içiyse gereklidir.
handlerProperties	object		Yürütme sırasında işleyiciye geçirilecek parametreler.
type	StepType	inline	Adım türü.
updateId	UpdateId		Başvuruda olunan alt güncelleştirme kimliği. Adım türü başvuruysa gereklidir.

StepType

Listeleme

Adım türü.

Değer	Description
inline
reference

Update

Object

Meta verileri güncelleştirin.

Name	Tür	Default value	Description
compatibility	object[]		Güncelleştirme uyumluluğu bilgilerinin listesi.
createdDateTime	string (date-time)		Güncelleştirmenin oluşturulduğu UTC tarihi ve saati.
description	string minLength: 1 maxLength: 512		Oluşturucu tarafından belirtilen açıklamayı güncelleştirin.
etag	string		ETag'i güncelleştirin.
friendlyName	string minLength: 1 maxLength: 512		İçeri aktarıcı tarafından belirtilen kolay güncelleştirme adı.
importedDateTime	string (date-time)		Güncelleştirmenin içeri aktarıldığı UTC tarihi ve saati.
installedCriteria	string		Güncelleştirmenin cihazda yüklü olup olmadığını belirlemek için Cihaz Güncelleştirmesi istemcisi tarafından yorumlanan dize. En son içeri aktarma bildirimi şemasında kullanım dışı bırakıldı.
instructions	Instructions		Yükleme yönergelerini güncelleştirin.
isDeployable	boolean	True	Güncelleştirmenin bir cihaza kendi başına dağıtılıp dağıtılamayacağı.
manifestVersion	string		Güncelleştirmeyi içeri aktarmak için kullanılan bildirimin şema sürümü.
referencedBy	UpdateId[]		Bu güncelleştirmeye başvuran güncelleştirme kimliklerinin listesi.
scanResult	string		Toplu tarama sonucunu güncelleştirme (yük dosyası tarama sonuçlarından hesaplanır).
updateId	UpdateId		Kimliği güncelleştirin.
updateType	string		Güncelleştirme türü. En son içeri aktarma bildirimi şemasında kullanım dışı bırakıldı.

UpdateId

Object

Tanımlayıcıyı güncelleştirin.

Name	Tür	Description
name	string	Adı güncelleştirin.
provider	string	Sağlayıcıyı güncelleştirin.
version	string	Sürümü güncelleştirin.