Compartir a través de

Updates - Import Update

Servicio:
Device Update
Versión de la API:
2020-09-01

Importe la nueva versión de actualización.

POST https://{accountEndpoint}/deviceupdate/{instanceId}/v2/updates?action=import

Parámetros de identificador URI

Nombre En Requerido Tipo Description
accountEndpoint
 path True

string

Punto de conexión de la cuenta.
instanceId
 path True

string

Identificador de instancia de cuenta.
action
 query True

ImportAction

Importar acción de actualización.

Cuerpo de la solicitud

Nombre Requerido Tipo Description
files True

FileImportMetadata[]

Una o varias propiedades de archivo de actualización, como nombre de archivo y dirección URL de origen.
importManifest True

ImportManifestMetadata

Importe metadatos de manifiesto, como la dirección URL de origen, el tamaño o los hashes de archivo, etc.

Respuestas

Nombre Tipo Description
202 Accepted

Solicitud de importación de actualización aceptada; la ubicación de la operación en segundo plano para realizar el seguimiento del estado se especifica en Operation-Location encabezado de respuesta.

Encabezados

  • Location: string
  • Operation-Location: string
429 Too Many Requests

Demasiadas solicitudes; hay un límite de velocidad sobre cuántas operaciones se pueden ejecutar dentro de un período de tiempo y también hay un límite en el número de operaciones simultáneas de importación y eliminación en segundo plano.

Seguridad

azure_auth_implicit

Flujo implícito de OAuth2 de Azure Active Directory

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

Ámbitos

Nombre Description
user_impersonation suplantar la cuenta de usuario

azure_auth_code

Flujo de código de acceso de OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: accessCode
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Dirección URL del token: https://login.microsoftonline.com/common/oauth2/v2.0/token

Ámbitos

Nombre Description
user_impersonation suplantar la cuenta de usuario

azure_auth_application

Flujo de aplicación de OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: application
Dirección URL del token: https://login.microsoftonline.com/common/oauth2/v2.0/token

Ámbitos

Nombre Description
.default ámbito de credenciales de cliente

azure_auth_password

Flujo de contraseña de OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: password
Dirección URL del token: https://login.microsoftonline.com/common/oauth2/v2.0/token

Ámbitos

Nombre Description
user_impersonation suplantar la cuenta de usuario

Ejemplos

Updates_ImportUpdate

Solicitud de ejemplo

POST https://contoso.api.adu.microsoft.com/deviceupdate/blue/v2/updates?action=import

{
  "importManifest": {
    "url": "http://test.blob.core.windows.net/test/uploadimportMan.json",
    "sizeInBytes": 816,
    "hashes": {
      "sha256": "O19LyyncPe1AGstOdkcmozLV8pSbBdqrE18HdYVohRc="
    }
  },
  "files": [
    {
      "filename": "file1.bin",
      "url": "http://test.blob.core.windows.net/test/upload1v5uww1q"
    },
    {
      "filename": "file2.bin",
      "url": "http://test.blob.core.windows.net/test/uploadkrmn5yw0"
    },
    {
      "filename": "file3.bin",
      "url": "http://test.blob.core.windows.net/test/uploaddq52ky5m"
    }
  ]
}

Respuesta de muestra

status code:
202 
Location: /deviceupdate/instanceId/v2/updates/operations/e4491c54-916f-443d-9094-bcca546ace2f
Operation-Location: /deviceupdate/instanceId/v2/updates/operations/e4491c54-916f-443d-9094-bcca546ace2f
status code:
429

Definiciones

Nombre Description
FileImportMetadata

Metadatos que describen un archivo de actualización.
ImportAction

Importar acción de actualización.
ImportManifestMetadata

Metadatos que describen el manifiesto de importación, un documento que describe los archivos y otros metadatos sobre una versión de actualización.
ImportUpdateInput

Importar metadatos de entrada de actualización.

FileImportMetadata

Object

Metadatos que describen un archivo de actualización.

Nombre Tipo Description
filename

string

Actualice el nombre de archivo tal como se especifica dentro del manifiesto de importación.
url

string

Ubicación del blob de Azure desde la que device Update para IoT Hub puede descargar el archivo de actualización. Normalmente, se trata de una dirección URL de blob protegida por SAS de solo lectura con una expiración establecida en al menos 4 horas.

ImportAction

Enumeración

Importar acción de actualización.

Valor Description
import

Acción de importación.

ImportManifestMetadata

Object

Metadatos que describen el manifiesto de importación, un documento que describe los archivos y otros metadatos sobre una versión de actualización.

Nombre Tipo Description
hashes

object

Objeto JSON que contiene los hash(es) del archivo. Se requiere al menos hash SHA256. Este objeto se puede considerar como un conjunto de pares clave-valor donde la clave es el algoritmo hash y el valor es el hash del archivo calculado mediante ese algoritmo.
sizeInBytes

integer (int64)

Tamaño del archivo en número de bytes.
url

string

Ubicación del blob de Azure desde la que device Update para IoT Hub puede descargar el manifiesto de importación. Normalmente, se trata de una dirección URL de blob protegida por SAS de solo lectura con una expiración establecida en al menos 4 horas.

ImportUpdateInput

Object

Importar metadatos de entrada de actualización.

Nombre Tipo Description
files

FileImportMetadata[]

Una o varias propiedades de archivo de actualización, como nombre de archivo y dirección URL de origen.
importManifest

ImportManifestMetadata

Importe metadatos de manifiesto, como la dirección URL de origen, el tamaño o los hashes de archivo, etc.