Device Update - List Updates
Obtenez la liste de toutes les mises à jour qui ont été importées dans Device Update pour IoT Hub.
GET https://{endpoint}/deviceUpdate/{instanceId}/updates?api-version=2022-10-01
GET https://{endpoint}/deviceUpdate/{instanceId}/updates?api-version=2022-10-01&search={search}&filter={filter}
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, aucun protocole). |
instance
|
path | True |
string |
Identificateur de instance de compte Device Update pour IoT Hub. |
api-version
|
query | True |
string |
Version de l’API à utiliser avec la demande cliente. |
filter
|
query |
string |
Facultatif pour filtrer les mises à jour par la propriété isDeployable. |
|
search
|
query |
string |
Mises à jour de demande correspondant à une expression de recherche en texte libre. |
Réponses
Nom | Type | Description |
---|---|---|
200 OK |
Toutes les mises à jour importées ou la liste vide s’il n’y en a pas. |
|
Other Status Codes |
Réponse par défaut. |
Sécurité
azure_auth
Flux OAuth2 Azure Active Directory
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Nom | Description |
---|---|
https://api.adu.microsoft.com/.default | Étendue d’autorisation par défaut. |
Exemples
DeviceUpdate_ListUpdates
Sample Request
GET https://contoso.api.adu.microsoft.com/deviceUpdate/blue/updates?api-version=2022-10-01
Sample Response
{
"value": [
{
"updateId": {
"provider": "microsoft",
"name": "adu",
"version": "1.0.0.0"
},
"description": "Example update.",
"compatibility": [
{
"deviceManufacturer": "Microsoft",
"deviceModel": "Toaster"
}
],
"instructions": {
"steps": [
{
"description": "pre-install script",
"handler": "microsoft/script:1",
"handlerProperties": {
"arguments": "--pre-install"
},
"files": [
"configure.sh"
]
},
{
"type": "reference",
"updateId": {
"provider": "microsoft",
"name": "sensor",
"version": "1.0"
}
}
]
},
"manifestVersion": "5.0",
"importedDateTime": "2020-04-22T21:01:43.8408797+00:00",
"createdDateTime": "2019-09-12T00:00:00.0000000+00:00",
"etag": "\"3fed3378-0c67-47d2-b796-296962c66cbb\""
}
]
}
Définitions
Nom | Description |
---|---|
Error |
Détails de l’erreur. |
Error |
Réponse d’erreur courante. |
Inner |
Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur. |
Instructions | |
Step |
Mettre à jour l’instruction d’installation. |
Step |
Type d’étape. |
Update |
Mettre à jour les métadonnées. |
Update |
Mettre à jour l’identificateur. |
Update |
Liste des mises à jour. |
Error
Détails de l’erreur.
Nom | Type | Description |
---|---|---|
code |
string |
Code d’erreur défini par le serveur. |
details |
Error[] |
Tableau d’erreurs ayant conduit à l’erreur signalée. |
innererror |
Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur. |
|
message |
string |
Représentation lisible par l’homme 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 |
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 contenante. |
errorDetail |
string |
Message d’erreur ou d’exception interne. |
innerError |
Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur. |
|
message |
string |
Représentation lisible par l’homme de l’erreur. |
Instructions
Nom | Type | Description |
---|---|---|
steps |
Step[] |
Collection d’étapes d’installation. |
Step
Mettre à jour l’instruction d’installation.
Nom | Type | Valeur par défaut | Description |
---|---|---|---|
description |
string |
Description de l’étape. |
|
files |
string[] |
Collection de noms de fichiers à passer au gestionnaire pendant l’exécution. Obligatoire si le type d’étape est inline. |
|
handler |
string |
Identité du gestionnaire qui exécutera cette étape. Obligatoire si le type d’étape est inline. |
|
handlerProperties |
object |
Paramètres à passer au gestionnaire pendant l’exécution. |
|
type | inline |
Type d’étape. |
|
updateId |
Identité de mise à jour enfant référencée. Obligatoire si le type d’étape est référence. |
StepType
Type d’étape.
Nom | Type | Description |
---|---|---|
inline |
string |
|
reference |
string |
Update
Mettre à jour les métadonnées.
Nom | Type | Valeur par défaut | Description |
---|---|---|---|
compatibility |
object[] |
Liste des informations de compatibilité des mises à jour. |
|
createdDateTime |
string |
Date et heure utc de création de la mise à jour. |
|
description |
string |
Mettre à jour la description spécifiée par le créateur. |
|
etag |
string |
Mettre à jour ETag. |
|
friendlyName |
string |
Nom de mise à jour conviviale spécifié par l’importateur. |
|
importedDateTime |
string |
Date et heure UTC auxquelles la mise à jour a été importée. |
|
installedCriteria |
string |
Chaîne interprétée par le client Device Update pour déterminer si la mise à jour est installée sur l’appareil. Déconseillé dans le schéma de manifeste d’importation le plus récent. |
|
instructions |
Mettre à jour les instructions d’installation. |
||
isDeployable |
boolean |
True |
Indique si la mise à jour peut être déployée sur un appareil par elle-même. |
manifestVersion |
string |
Version de schéma du manifeste utilisé pour importer la mise à jour. |
|
referencedBy |
Update |
Liste des identités de mise à jour qui font référence à cette mise à jour. |
|
scanResult |
string |
Mettre à jour le résultat de l’analyse d’agrégation (calculé à partir des résultats de l’analyse du fichier de charge utile). |
|
updateId |
Identité de la mise à jour. |
||
updateType |
string |
Type de mise à jour. Déconseillé dans le schéma de manifeste d’importation le plus récent. |
UpdateId
Mettre à jour l’identificateur.
Nom | Type | Description |
---|---|---|
name |
string |
Mettre à jour le nom. |
provider |
string |
Mettre à jour le fournisseur. |
version |
string |
Mettre à jour la version. |
UpdateList
Liste des mises à jour.
Nom | Type | Description |
---|---|---|
nextLink |
string |
Lien vers la page suivante des éléments. |
value |
Update[] |
Collection d’éléments paginables. |