Device Update - Get File

Referentie

Service:: Device Update

API-versie:: 2022-10-01

Haal een specifiek updatebestand op uit de versie.

GET https://{endpoint}/deviceUpdate/{instanceId}/updates/providers/{provider}/names/{name}/versions/{version}/files/{fileId}?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).
fileId	path	True	string	Bestands-id.
instanceId	path	True	string	De apparaatupdate voor IoT Hub accountinstantie-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	UpdateFile	De aangevraagde bestandsentiteit.
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_GetFile

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:: 200

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

Definities

Name	Description
Error	Foutdetails.
ErrorResponse	Veelvoorkomende foutreactie.
InnerError	Een object met specifiekere informatie dan het huidige object over de fout.
UpdateFile	Metagegevens van bestanden bijwerken.
UpdateFileBase	Basismetagegevens van het bestand bijwerken.
UpdateFileDownloadHandler	Downloadhandler voor het gebruik van gerelateerde bestanden om het nettoladingbestand te downloaden.

Error

Foutdetails.

Name	Type	Description
code	string	Door de server gedefinieerde foutcode.
details	Error[]	Een matrix met 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 de fout die is opgegeven.
errorDetail	string	De interne fout of het 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.

UpdateFile

Metagegevens van bestanden bijwerken.

Name	Type	Description
downloadHandler	UpdateFileDownloadHandler	Optionele downloadhandler voor het gebruik van gerelateerde bestanden om een nettoladingbestand te downloaden.
etag	string	Bestand ETag.
fileId	string	Bestandsidentiteit, gegenereerd door de server tijdens het importeren.
fileName	string	Bestandsnaam.
hashes	object	Toewijzing van hash-algoritme aan base64 gecodeerde hashwaarden.
mimeType	string	MIME-type bestand.
properties	object	Optionele bestandseigenschappen (niet gebruikt door service, maar passthrough naar apparaat).
relatedFiles	UpdateFileBase[]	Optionele metagegevens van gerelateerde bestanden die samen worden gebruikt DownloadHandler-metagegevens om het nettoladingbestand te downloaden.
scanDetails	string	Antimalwarescandetails.
scanResult	string	Resultaat van antimalwarescan.
sizeInBytes	integer	Bestandsgrootte in aantal bytes.

UpdateFileBase

Basismetagegevens van het bestand bijwerken.

Name	Type	Description
fileName	string	Bestandsnaam.
hashes	object	Toewijzing van hash-algoritme aan base64 gecodeerde hashwaarden.
mimeType	string	MIME-type bestand.
properties	object	Optionele bestandseigenschappen (niet gebruikt door service, maar passthrough naar apparaat).
scanDetails	string	Antimalwarescandetails.
scanResult	string	Resultaat van antimalwarescan.
sizeInBytes	integer	Bestandsgrootte in aantal bytes.

UpdateFileDownloadHandler

Downloadhandler voor het gebruik van gerelateerde bestanden om het nettoladingbestand te downloaden.

Name	Type	Description
id	string	Handler-id downloaden.

Delen via