Device Update - Get File

Referencia

Servicio:: Device Update

Versión de la API:: 2022-10-01

Obtenga un archivo de actualización específico de la versión.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
endpoint	path	True	string url	Device Update para IoT Hub punto de conexión de la cuenta (solo nombre de host, sin protocolo).
fileId	path	True	string	Identificador de archivo.
instanceId	path	True	string	Device Update para IoT Hub identificador de instancia de cuenta.
name	path	True	string	Nombre de actualización.
provider	path	True	string	Proveedor de actualización.
version	path	True	string	Actualizar versión.
api-version	query	True	string	Versión de la API que se va a usar con la solicitud de cliente.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
If-None-Match		string	Define la condición If-None-Match. La operación solo se realizará si la etiqueta ETag del servidor no coincide con este valor.

Respuestas

Nombre	Tipo	Description
200 OK	UpdateFile	Entidad de archivo solicitada.
Other Status Codes	ErrorResponse	Respuesta predeterminada.

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
https://api.adu.microsoft.com/.default	Ámbito de autorización predeterminado.

Ejemplos

DeviceUpdate_GetFile

Solicitud de ejemplo

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

Respuesta de muestra

status code:: 200

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

Definiciones

Nombre	Description
Error	Detalles del error.
ErrorResponse	Respuesta de error común.
InnerError	Objeto que contiene información más específica que el objeto actual sobre el error.
UpdateFile	Actualizar los metadatos del archivo.
UpdateFileBase	Actualice los metadatos básicos del archivo.
UpdateFileDownloadHandler	Controlador de descarga para usar archivos relacionados para descargar el archivo de carga.

Error

Detalles del error.

Nombre	Tipo	Description
code	string	Código de error definido por el servidor.
details	Error[]	Matriz de errores que provocó el error notificado.
innererror	InnerError	Objeto que contiene información más específica que el objeto actual sobre el error.
message	string	Representación legible del error.
occurredDateTime	string	Fecha y hora en UTC cuando se produjo el error.
target	string	Destino del error.

ErrorResponse

Respuesta de error común.

Nombre	Tipo	Description
error	Error	Los detalles del error.

InnerError

Objeto que contiene información más específica que el objeto actual sobre el error.

Nombre	Tipo	Description
code	string	Un código de error más específico que el proporcionado por el error contenedor.
errorDetail	string	Mensaje interno de error o excepción.
innerError	InnerError	Objeto que contiene información más específica que el objeto actual sobre el error.
message	string	Representación legible del error.

UpdateFile

Actualizar los metadatos del archivo.

Nombre	Tipo	Description
downloadHandler	UpdateFileDownloadHandler	Controlador de descarga opcional para usar archivos relacionados para descargar el archivo de carga.
etag	string	ETag de archivo.
fileId	string	Identidad de archivo, generada por el servidor en el momento de la importación.
fileName	string	Nombre de archivo.
hashes	object	Asignación del algoritmo hash a valores hash codificados en base64.
mimeType	string	Tipo MIME de archivo.
properties	object	Propiedades de archivo opcionales (no consumidas por el servicio, pero de paso a través del dispositivo).
relatedFiles	UpdateFileBase[]	Metadatos de archivos relacionados opcionales usados juntos metadatos de DownloadHandler para descargar el archivo de carga.
scanDetails	string	Detalles del examen antimalware.
scanResult	string	Resultado del examen antimalware.
sizeInBytes	integer	Tamaño de archivo en número de bytes.

UpdateFileBase

Actualice los metadatos básicos del archivo.

Nombre	Tipo	Description
fileName	string	Nombre de archivo.
hashes	object	Asignación del algoritmo hash a valores hash codificados en base64.
mimeType	string	Tipo MIME de archivo.
properties	object	Propiedades de archivo opcionales (no consumidas por el servicio, pero de paso a través del dispositivo).
scanDetails	string	Detalles del examen antimalware.
scanResult	string	Resultado del examen antimalware.
sizeInBytes	integer	Tamaño de archivo en número de bytes.

UpdateFileDownloadHandler

Controlador de descarga para usar archivos relacionados para descargar el archivo de carga.

Nombre	Tipo	Description
id	string	Descargue el identificador del controlador.

Compartir a través de