Device Update - Get File

Odwołanie

Usługa:: Device Update

Wersja interfejsu API:: 2022-10-01

Pobierz określony plik aktualizacji z wersji.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
endpoint	path	True	string url	Aktualizacja urządzenia dla punktu końcowego konta IoT Hub (tylko nazwa hosta, bez protokołu).
fileId	path	True	string	Identyfikator pliku.
instanceId	path	True	string	Aktualizacja urządzenia dla identyfikatora wystąpienia konta IoT Hub.
name	path	True	string	Zaktualizuj nazwę.
provider	path	True	string	Aktualizuj dostawcę.
version	path	True	string	Aktualizacja wersji.
api-version	query	True	string	Wersja interfejsu API do użycia z żądaniem klienta.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
If-None-Match		string	Definiuje warunek If-None-Match. Operacja zostanie wykonana tylko wtedy, gdy element ETag na serwerze nie jest zgodny z tą wartością.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	UpdateFile	Żądana jednostka pliku.
Other Status Codes	ErrorResponse	Odpowiedź domyślna.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
https://api.adu.microsoft.com/.default	Domyślny zakres autoryzacji.

Przykłady

DeviceUpdate_GetFile

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:: 200

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

Definicje

Nazwa	Opis
Error	Szczegóły błędu.
ErrorResponse	Typowa odpowiedź na błąd.
InnerError	Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.
UpdateFile	Aktualizowanie metadanych pliku.
UpdateFileBase	Aktualizowanie podstawowych metadanych pliku.
UpdateFileDownloadHandler	Procedura obsługi pobierania na potrzeby pobierania pliku ładunku przy użyciu powiązanych plików.

Error

Szczegóły błędu.

Nazwa	Typ	Opis
code	string	Kod błędu zdefiniowany przez serwer.
details	Error[]	Tablica błędów, które doprowadziły do zgłoszonego błędu.
innererror	InnerError	Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.
message	string	Czytelna dla człowieka reprezentacja błędu.
occurredDateTime	string	Data i godzina w formacie UTC, kiedy wystąpił błąd.
target	string	Element docelowy błędu.

ErrorResponse

Typowa odpowiedź na błąd.

Nazwa	Typ	Opis
error	Error	Szczegóły błędu.

InnerError

Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.

Nazwa	Typ	Opis
code	string	Bardziej szczegółowy kod błędu niż podany przez błąd zawierający.
errorDetail	string	Błąd wewnętrzny lub komunikat o wyjątku.
innerError	InnerError	Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.
message	string	Czytelna dla człowieka reprezentacja błędu.

UpdateFile

Aktualizowanie metadanych pliku.

Nazwa	Typ	Opis
downloadHandler	UpdateFileDownloadHandler	Opcjonalna procedura obsługi pobierania na potrzeby pobierania plików pokrewnych do pobierania pliku ładunku.
etag	string	Plik ETag.
fileId	string	Tożsamość pliku wygenerowana przez serwer w czasie importowania.
fileName	string	Nazwa pliku.
hashes	object	Mapowanie algorytmu tworzenia skrótów na wartości skrótu zakodowane w formacie Base64.
mimeType	string	Typ MIME pliku.
properties	object	Opcjonalne właściwości pliku (nieużytowane przez usługę, ale przekazywane do urządzenia).
relatedFiles	UpdateFileBase[]	Opcjonalne powiązane metadane plików używane razem metadane programu DownloadHandler do pobierania pliku ładunku.
scanDetails	string	Szczegóły skanowania przed złośliwym oprogramowaniem.
scanResult	string	Wynik skanowania przed złośliwym oprogramowaniem.
sizeInBytes	integer	Rozmiar pliku w liczbie bajtów.

UpdateFileBase

Aktualizowanie podstawowych metadanych pliku.

Nazwa	Typ	Opis
fileName	string	Nazwa pliku.
hashes	object	Mapowanie algorytmu tworzenia skrótów na wartości skrótu zakodowane w formacie Base64.
mimeType	string	Typ MIME pliku.
properties	object	Opcjonalne właściwości pliku (nieużytowane przez usługę, ale przekazywane do urządzenia).
scanDetails	string	Szczegóły skanowania przed złośliwym oprogramowaniem.
scanResult	string	Wynik skanowania przed złośliwym oprogramowaniem.
sizeInBytes	integer	Rozmiar pliku w liczbie bajtów.

UpdateFileDownloadHandler

Procedura obsługi pobierania na potrzeby pobierania pliku ładunku przy użyciu powiązanych plików.

Nazwa	Typ	Opis
id	string	Pobierz identyfikator programu obsługi.

Udostępnij za pośrednictwem