Device Update - Get Update

Referentie

Service:: Device Update

API-versie:: 2022-10-01

Een specifieke updateversie ophalen.

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

URI-parameters

Name	In	Vereist	Type	Description
endpoint	path	True	string url	De Apparaatupdate voor IoT Hub accounteindpunt (alleen hostnaam, geen protocol).
instanceId	path	True	string	De apparaatupdate voor IoT Hub accountexemplaar-id.
name	path	True	string	Naam bijwerken.
provider	path	True	string	Provider bijwerken.
version	path	True	string	Versie bijwerken.
api-version	query	True	string	Versie van de API die moet worden gebruikt met de clientaanvraag.

Aanvraagkoptekst

Name	Vereist	Type	Description
If-None-Match		string	Definieert de voorwaarde If-None-Match. De bewerking wordt alleen uitgevoerd als de ETag op de server niet overeenkomt met deze waarde.

Antwoorden

Name	Type	Description
200 OK	Update	De aangevraagde updateversie.
Other Status Codes	ErrorResponse	Standaardantwoord.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
https://api.adu.microsoft.com/.default	Standaardautorisatiebereik.

Voorbeelden

DeviceUpdate_GetUpdate

Voorbeeldaanvraag

HTTP

GET https://contoso.api.adu.microsoft.com/deviceUpdate/blue/updates/providers/microsoft/names/adu/versions/1.0.0.0?api-version=2022-10-01

Voorbeeldrespons

Statuscode:: 200

{
  "updateId": {
    "provider": "microsoft",
    "name": "adu",
    "version": "1.0.0.0"
  },
  "friendlyName": "Lab Sensor Update v1",
  "description": "Fix for critical vulnerability",
  "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\""
}

Definities

Name	Description
Error	Foutdetails.
ErrorResponse	Veelvoorkomende foutreactie.
InnerError	Een object met specifiekere informatie dan het huidige object over de fout.
Instructions
Step	Installatie-instructiestap bijwerken.
StepType	Staptype.
Update	Metagegevens bijwerken.
UpdateId	Werk de id bij.

Error

Foutdetails.

Name	Type	Description
code	string	Door de server gedefinieerde foutcode.
details	Error[]	Een matrix van fouten die tot de gerapporteerde fout hebben geleid.
innererror	InnerError	Een object met specifiekere informatie dan het huidige object over de fout.
message	string	Een door mensen leesbare weergave van de fout.
occurredDateTime	string	De datum en tijd in UTC waarop de fout is opgetreden.
target	string	Het doel van de fout.

ErrorResponse

Veelvoorkomende foutreactie.

Name	Type	Description
error	Error	De foutdetails.

InnerError

Een object met specifiekere informatie dan het huidige object over de fout.

Name	Type	Description
code	string	Een specifiekere foutcode dan wat is opgegeven door de betreffende fout.
errorDetail	string	Het interne fout- of uitzonderingsbericht.
innerError	InnerError	Een object met specifiekere informatie dan het huidige object over de fout.
message	string	Een door mensen leesbare weergave van de fout.

Instructions

Name	Type	Description
steps	Step[]	Verzameling installatiestappen.

Step

Installatie-instructiestap bijwerken.

Name	Type	Default value	Description
description	string		Beschrijving van stap.
files	string[]		Verzameling bestandsnamen die tijdens de uitvoering aan de handler moeten worden doorgegeven. Vereist als het staptype inline is.
handler	string		Identiteit van handler die deze stap uitvoert. Vereist als het staptype inline is.
handlerProperties	object		Parameters die tijdens de uitvoering aan de handler moeten worden doorgegeven.
type	StepType	inline	Staptype.
updateId	UpdateId		Onderliggende update-identiteit waarnaar wordt verwezen. Vereist als het staptype een verwijzing is.

StepType

Staptype.

Name	Type	Description
inline	string
reference	string

Update

Metagegevens bijwerken.

Name	Type	Default value	Description
compatibility	object[]		Lijst met informatie over updatecompatibiliteit.
createdDateTime	string		De datum en tijd in UTC waarop de update is gemaakt.
description	string		Beschrijving bijwerken die is opgegeven door de maker.
etag	string		ETag bijwerken.
friendlyName	string		Beschrijvende bijwerknaam die is opgegeven door de importeur.
importedDateTime	string		De datum en tijd in UTC waarop de update is geïmporteerd.
installedCriteria	string		Tekenreeks geïnterpreteerd door de Device Update-client om te bepalen of de update op het apparaat is geïnstalleerd. Afgeschaft in het meest recente manifestschema voor importeren.
instructions	Instructions		Installatie-instructies bijwerken.
isDeployable	boolean	True	Of de update zelfstandig op een apparaat kan worden geïmplementeerd.
manifestVersion	string		Schemaversie van het manifest dat wordt gebruikt om de update te importeren.
referencedBy	UpdateId[]		Lijst met update-id's die naar deze update verwijzen.
scanResult	string		Samengeteld scanresultaat bijwerken (berekend op basis van scanresultaten van nettoladingbestanden).
updateId	UpdateId		Identiteit bijwerken.
updateType	string		Updatetype. Afgeschaft in het meest recente manifestschema voor importeren.

UpdateId

Werk de id bij.

Name	Type	Description
name	string	Naam bijwerken.
provider	string	Provider bijwerken.
version	string	Versie bijwerken.

Delen via