Device Update - Get File

Servizio:
Device Update
Versione API:
2022-10-01

Ottenere un file di aggiornamento specifico dalla versione.

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
endpoint
 path True

string (url)

Aggiornamento del dispositivo per l'endpoint dell'account dell'hub IoT (solo nome host, nessun protocollo).
fileId
 path True

string

Identificatore di file.
instanceId
 path True

string

Identificatore dell'istanza dell'account dell'hub IoT aggiornamento del dispositivo.
name
 path True

string

Aggiornare il nome.
provider
 path True

string

Provider di aggiornamento.
version
 path True

string

Aggiornare la versione.
api-version
 query True

string

minLength: 1

Versione dell'API da usare per questa operazione.

Intestazione della richiesta

Nome Necessario Tipo Descrizione
If-None-Match

string

Definisce la condizione If-None-Match. L'operazione verrà eseguita solo se l'ETag nel server non corrisponde a questo valore.

Risposte

Nome Tipo Descrizione
200 OK

UpdateFile

La richiesta ha avuto esito positivo.
Other Status Codes

ErrorResponse

Risposta di errore imprevista.

Sicurezza

OAuth2Auth

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome Descrizione
https://api.adu.microsoft.com/.default

Esempio

DeviceUpdate_GetFile

Esempio di richiesta

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

Risposta di esempio

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

Definizioni

Nome Descrizione
Error

Dettagli errore.
ErrorResponse

Risposta di errore comune.
InnerError

Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.
UpdateFile

Aggiornare i metadati del file.
UpdateFileBase

Aggiornare i metadati di base del file.
UpdateFileDownloadHandler

Gestore di download per l'utilizzo di file correlati per scaricare il file di payload.

Error

Oggetto

Dettagli errore.

Nome Tipo Descrizione
code

string

Codice di errore definito dal server.
details

Error[]

Matrice di errori che hanno causato l'errore segnalato.
innererror

InnerError

Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.
message

string

Rappresentazione leggibile dell'errore.
occurredDateTime

string (date-time)

Data e ora in formato UTC in cui si è verificato l'errore.
target

string

Destinazione dell'errore.

ErrorResponse

Oggetto

Risposta di errore comune.

Nome Tipo Descrizione
error

Error

Dettagli dell'errore.

InnerError

Oggetto

Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.

Nome Tipo Descrizione
code

string

Codice di errore più specifico di quello fornito dall'errore contenitore.
errorDetail

string

Messaggio di errore interno o eccezione.
innerError

InnerError

Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.
message

string

Rappresentazione leggibile dell'errore.

UpdateFile

Oggetto

Aggiornare i metadati del file.

Nome Tipo Descrizione
downloadHandler

UpdateFileDownloadHandler

Gestore di download facoltativo per l'utilizzo di file correlati per scaricare il file di payload.
etag

string

File ETag.
fileId

string

Identità file, generata dal server in fase di importazione.
fileName

string

Nome file.
hashes

object

Mapping dell'algoritmo hash ai valori hash con codifica Base64.
mimeType

string

Tipo MIME del file.
properties

object

Proprietà di file facoltative (non utilizzate dal servizio ma pass-through al dispositivo).
relatedFiles

UpdateFileBase[]

Metadati dei file correlati facoltativi usati insieme ai metadati downloadHandler per scaricare il file di payload.
scanDetails

string

Dettagli dell'analisi antimalware.
scanResult

string

Risultato dell'analisi antimalware.
sizeInBytes

integer (int64)

Dimensioni del file in numero di byte.

UpdateFileBase

Oggetto

Aggiornare i metadati di base del file.

Nome Tipo Descrizione
fileName

string

Nome file.
hashes

object

Mapping dell'algoritmo hash ai valori hash con codifica Base64.
mimeType

string

Tipo MIME del file.
properties

object

Proprietà di file facoltative (non utilizzate dal servizio ma pass-through al dispositivo).
scanDetails

string

Dettagli dell'analisi antimalware.
scanResult

string

Risultato dell'analisi antimalware.
sizeInBytes

integer (int64)

Dimensioni del file in numero di byte.

UpdateFileDownloadHandler

Oggetto

Gestore di download per l'utilizzo di file correlati per scaricare il file di payload.

Nome Tipo Descrizione
id

string

Identificatore del gestore di download.