Device Update - Get File

Référence

Service:: Device Update

Version d'API:: 2022-10-01

Obtenez un fichier de mise à jour spécifique à partir de la version.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
endpoint	path	True	string url	Device Update pour IoT Hub point de terminaison de compte (nom d’hôte uniquement, pas de protocole).
fileId	path	True	string	Identificateur de fichier.
instanceId	path	True	string	Identificateur de instance device Update pour IoT Hub compte.
name	path	True	string	Nom de la mise à jour.
provider	path	True	string	Fournisseur de mise à jour.
version	path	True	string	Mettre à jour la version.
api-version	query	True	string	Version de l’API à utiliser avec la demande du client.

En-tête de la demande

Nom	Obligatoire	Type	Description
If-None-Match		string	Définit la condition If-None-Match. L’opération est effectuée uniquement si l’ETag sur le serveur ne correspond pas à cette valeur.

Réponses

Nom	Type	Description
200 OK	UpdateFile	Entité de fichier demandée.
Other Status Codes	ErrorResponse	Réponse par défaut.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

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

Étendues

Nom	Description
https://api.adu.microsoft.com/.default	Étendue d’autorisation par défaut.

Exemples

DeviceUpdate_GetFile

Exemple de requête

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

Exemple de réponse

Code d’état:: 200

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

Définitions

Nom	Description
Error	Détails de l’erreur.
ErrorResponse	Réponse d’erreur courante.
InnerError	Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur.
UpdateFile	Mettez à jour les métadonnées du fichier.
UpdateFileBase	Mettez à jour les métadonnées de base du fichier.
UpdateFileDownloadHandler	Gestionnaire de téléchargement pour l’utilisation de fichiers associés pour télécharger le fichier de charge utile.

Error

Détails de l’erreur.

Nom	Type	Description
code	string	Code d’erreur défini par le serveur.
details	Error[]	Tableau d’erreurs qui ont conduit à l’erreur signalée.
innererror	InnerError	Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur.
message	string	Représentation lisible de l’erreur.
occurredDateTime	string	Date et heure UTC auxquelles l’erreur s’est produite.
target	string	Cible de l’erreur.

ErrorResponse

Réponse d’erreur courante.

Nom	Type	Description
error	Error	Détails de l’erreur.

InnerError

Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur.

Nom	Type	Description
code	string	Code d’erreur plus spécifique que celui fourni par l’erreur contenant.
errorDetail	string	Message d’erreur ou d’exception interne.
innerError	InnerError	Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur.
message	string	Représentation lisible de l’erreur.

UpdateFile

Mettez à jour les métadonnées du fichier.

Nom	Type	Description
downloadHandler	UpdateFileDownloadHandler	Gestionnaire de téléchargement facultatif pour l’utilisation de fichiers associés pour télécharger le fichier de charge utile.
etag	string	Fichier ETag.
fileId	string	Identité de fichier, générée par le serveur au moment de l’importation.
fileName	string	Nom du fichier.
hashes	object	Mappage de l’algorithme de hachage aux valeurs de hachage encodées en base64.
mimeType	string	Type MIME de fichier.
properties	object	Propriétés de fichier facultatives (non consommées par le service, mais pass-through à l’appareil).
relatedFiles	UpdateFileBase[]	Métadonnées de fichiers connexes facultatives utilisées ensemble métadonnées DownloadHandler pour télécharger le fichier de charge utile.
scanDetails	string	Détails de l’analyse anti-programme malveillant.
scanResult	string	Résultat de l’analyse anti-programme malveillant.
sizeInBytes	integer	Taille du fichier, en nombre d’octets.

UpdateFileBase

Mettez à jour les métadonnées de base du fichier.

Nom	Type	Description
fileName	string	Nom du fichier.
hashes	object	Mappage de l’algorithme de hachage aux valeurs de hachage encodées en base64.
mimeType	string	Type MIME de fichier.
properties	object	Propriétés de fichier facultatives (non consommées par le service, mais pass-through à l’appareil).
scanDetails	string	Détails de l’analyse anti-programme malveillant.
scanResult	string	Résultat de l’analyse anti-programme malveillant.
sizeInBytes	integer	Taille du fichier, en nombre d’octets.

UpdateFileDownloadHandler

Gestionnaire de téléchargement pour l’utilisation de fichiers associés pour télécharger le fichier de charge utile.

Nom	Type	Description
id	string	Télécharger l’identificateur du gestionnaire.

Partager via