Partager via

Updates - Import Update

Service:
Device Update
Version d'API:
2020-09-01

Importez la nouvelle version de mise à jour.

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

Paramètres URI

Nom Dans Obligatoire Type Description
accountEndpoint
 path True

string

Point de terminaison de compte.
instanceId
 path True

string

Identificateur d’instance de compte.
action
 query True

ImportAction

Importer l’action de mise à jour.

Corps de la demande

Nom Obligatoire Type Description
files True

FileImportMetadata[]

Une ou plusieurs propriétés de fichier de mise à jour telles que le nom de fichier et l’URL source.
importManifest True

ImportManifestMetadata

Importez des métadonnées de manifeste telles que l’URL source, la taille de fichier/hachage, etc.

Réponses

Nom Type Description
202 Accepted

Demande d’importation de mise à jour acceptée ; L’emplacement de l’opération en arrière-plan pour suivre l’état est spécifié dans Operation-Location en-tête de réponse.

En-têtes

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

Trop de demandes ; il existe une limite de débit sur le nombre d’opérations pouvant être exécutées dans un délai et il existe également une limite quant au nombre d’opérations d’importation et de suppression simultanées d’arrière-plan qui peuvent être exécutées.

Sécurité

azure_auth_implicit

Flux implicite OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Étendues

Nom Description
user_impersonation emprunter l’identité de votre compte d’utilisateur

azure_auth_code

Flux AccessCode OAuth2 Azure Active Directory

Type: oauth2
Flux: accessCode
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
URL du jeton: https://login.microsoftonline.com/common/oauth2/v2.0/token

Étendues

Nom Description
user_impersonation emprunter l’identité de votre compte d’utilisateur

azure_auth_application

Flux d’application OAuth2 Azure Active Directory

Type: oauth2
Flux: application
URL du jeton: https://login.microsoftonline.com/common/oauth2/v2.0/token

Étendues

Nom Description
.default étendue des informations d’identification du client

azure_auth_password

Flux de mot de passe OAuth2 Azure Active Directory

Type: oauth2
Flux: password
URL du jeton: https://login.microsoftonline.com/common/oauth2/v2.0/token

Étendues

Nom Description
user_impersonation emprunter l’identité de votre compte d’utilisateur

Exemples

Updates_ImportUpdate

Exemple de requête

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"
    }
  ]
}

Exemple de réponse

Code d’état:
202 
Location: /deviceupdate/instanceId/v2/updates/operations/e4491c54-916f-443d-9094-bcca546ace2f
Operation-Location: /deviceupdate/instanceId/v2/updates/operations/e4491c54-916f-443d-9094-bcca546ace2f
Code d’état:
429

Définitions

Nom Description
FileImportMetadata

Métadonnées décrivant un fichier de mise à jour.
ImportAction

Importer l’action de mise à jour.
ImportManifestMetadata

Métadonnées décrivant le manifeste d’importation, document qui décrit les fichiers et d’autres métadonnées sur une version de mise à jour.
ImportUpdateInput

Importer les métadonnées d’entrée de mise à jour.

FileImportMetadata

Object

Métadonnées décrivant un fichier de mise à jour.

Nom Type Description
filename

string

Mettez à jour le nom de fichier tel que spécifié dans le manifeste d’importation.
url

string

Emplacement d’objet blob Azure à partir duquel le fichier de mise à jour peut être téléchargé par Device Update pour IoT Hub. Il s’agit généralement d’une URL d’objet blob protégée par SAP en lecture seule avec une expiration définie sur au moins 4 heures.

ImportAction

Énumération

Importer l’action de mise à jour.

Valeur Description
import

Action d’importation.

ImportManifestMetadata

Object

Métadonnées décrivant le manifeste d’importation, document qui décrit les fichiers et d’autres métadonnées sur une version de mise à jour.

Nom Type Description
hashes

object

Objet JSON contenant le ou les hachages du fichier. Au moins SHA256 hash est requis. Cet objet peut être considéré comme un ensemble de paires clé-valeur où la clé est l’algorithme de hachage, et la valeur est le hachage du fichier calculé à l’aide de cet algorithme.
sizeInBytes

integer (int64)

Taille du fichier en nombre d’octets.
url

string

Emplacement d’objet blob Azure à partir duquel le manifeste d’importation peut être téléchargé par Device Update pour IoT Hub. Il s’agit généralement d’une URL d’objet blob protégée par SAP en lecture seule avec une expiration définie sur au moins 4 heures.

ImportUpdateInput

Object

Importer les métadonnées d’entrée de mise à jour.

Nom Type Description
files

FileImportMetadata[]

Une ou plusieurs propriétés de fichier de mise à jour telles que le nom de fichier et l’URL source.
importManifest

ImportManifestMetadata

Importez des métadonnées de manifeste telles que l’URL source, la taille de fichier/hachage, etc.