Device Update - Get File

Dienst:
Device Update
API-Version:
2022-10-01

Rufen Sie eine bestimmte Updatedatei aus der Version ab.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
endpoint
 path True

string (url)

Geräteupdate für IoT Hub-Kontoendpunkt (nur Hostname, kein Protokoll).
fileId
 path True

string

Dateibezeichner.
instanceId
 path True

string

Der Geräteupdate für IoT Hub-Kontoinstanzbezeichner.
name
 path True

string

Updatename.
provider
 path True

string

Updateanbieter.
version
 path True

string

Updateversion.
api-version
 query True

string

minLength: 1

Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungsheader

Name Erforderlich Typ Beschreibung
If-None-Match

string

Definiert die If-None-Match-Bedingung. Der Vorgang wird nur ausgeführt, wenn das ETag auf dem Server nicht mit diesem Wert übereinstimmt.

Antworten

Name Typ Beschreibung
200 OK

UpdateFile

Die Anforderung ist erfolgreich.
Other Status Codes

ErrorResponse

Unerwartete Fehlerantwort.

Sicherheit

OAuth2Auth

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name Beschreibung
https://api.adu.microsoft.com/.default

Beispiele

DeviceUpdate_GetFile

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:
200 
{
  "fileId": "abc123",
  "fileName": "1v5uww1q.my2",
  "sizeInBytes": 1862311,
  "hashes": {
    "sha256": "OVokcktf61lQXs17MzJCsM98lk48H1Wu1hy7Sp6lLfI="
  },
  "mimeType": "application/BuildAsync-s4jwikgq.44h",
  "etag": "\"26bd8eba-4bb2-4960-a357-ca4d60b5fb4b\""
}

Definitionen

Name Beschreibung
Error

Fehlerdetails.
ErrorResponse

Häufige Fehlerantwort.
InnerError

Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.
UpdateFile

Aktualisieren von Dateimetadaten.
UpdateFileBase

Aktualisieren sie grundlegende Metadaten für Dateien.
UpdateFileDownloadHandler

Downloadhandler für die Verwendung verwandter Dateien zum Herunterladen der Nutzlastdatei.

Error

Objekt

Fehlerdetails.

Name Typ Beschreibung
code

string

Serverdefinierter Fehlercode.
details

Error[]

Ein Array von Fehlern, die zu dem gemeldeten Fehler geführt haben.
innererror

InnerError

Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.
message

string

Eine lesbare Darstellung des Fehlers.
occurredDateTime

string (date-time)

Datum und Uhrzeit in UTC, wenn der Fehler aufgetreten ist.
target

string

Das Ziel des Fehlers.

ErrorResponse

Objekt

Häufige Fehlerantwort.

Name Typ Beschreibung
error

Error

Die Fehlerdetails.

InnerError

Objekt

Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.

Name Typ Beschreibung
code

string

Ein spezifischerer Fehlercode als das, was vom enthaltenden Fehler bereitgestellt wurde.
errorDetail

string

Die interne Fehlermeldung oder Ausnahmemeldung.
innerError

InnerError

Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.
message

string

Eine lesbare Darstellung des Fehlers.

UpdateFile

Objekt

Aktualisieren von Dateimetadaten.

Name Typ Beschreibung
downloadHandler

UpdateFileDownloadHandler

Optionaler Downloadhandler für die Verwendung verwandter Dateien zum Herunterladen der Nutzlastdatei.
etag

string

Datei-ETag.
fileId

string

Dateiidentität, die zur Importzeit vom Server generiert wird.
fileName

string

Dateiname.
hashes

object

Zuordnung des Hashingalgorithmus zu base64-codierten Hashwerten.
mimeType

string

Datei-MIME-Typ.
properties

object

Optionale Dateieigenschaften (nicht vom Dienst genutzt, sondern an das Gerät übergeben).
relatedFiles

UpdateFileBase[]

Optionale verwandte Dateimetadaten, die zusammen DownloadHandler-Metadaten zum Herunterladen der Nutzlastdatei verwendet werden.
scanDetails

string

Details zur Antischadsoftwareüberprüfung.
scanResult

string

Anti-Malware-Scanergebnis.
sizeInBytes

integer (int64)

Dateigröße in Bytezahl.

UpdateFileBase

Objekt

Aktualisieren sie grundlegende Metadaten für Dateien.

Name Typ Beschreibung
fileName

string

Dateiname.
hashes

object

Zuordnung des Hashingalgorithmus zu base64-codierten Hashwerten.
mimeType

string

Datei-MIME-Typ.
properties

object

Optionale Dateieigenschaften (nicht vom Dienst genutzt, sondern an das Gerät übergeben).
scanDetails

string

Details zur Antischadsoftwareüberprüfung.
scanResult

string

Anti-Malware-Scanergebnis.
sizeInBytes

integer (int64)

Dateigröße in Bytezahl.

UpdateFileDownloadHandler

Objekt

Downloadhandler für die Verwendung verwandter Dateien zum Herunterladen der Nutzlastdatei.

Name Typ Beschreibung
id

string

Downloadhandlerbezeichner.