Share via

Updates - Get File

  • Reference
Service:
Device Update
API Version:
2020-09-01

Get a specific update file from the version.

GET https://{accountEndpoint}/deviceupdate/{instanceId}/v2/updates/providers/{provider}/names/{name}/versions/{version}/files/{fileId}

URI Parameters

Name In Required Type Description
accountEndpoint
 path True

string

Account endpoint.
fileId
 path True

string

File identifier.
instanceId
 path True

string

Account instance identifier.
name
 path True

string

Update name.
provider
 path True

string

Update provider.
version
 path True

string

Update version.

Request Header

Name Required Type Description
If-None-Match

string

Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value.

Responses

Name Type Description
200 OK

File

The requested file entity.
404 Not Found

Not found.
429 Too Many Requests

Too many requests; there is a rate limit on how many operations can be executed within a time period.
Other Status Codes

Not modified.

Security

azure_auth_implicit

Azure Active Directory OAuth2 Implicit Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Scopes

Name Description
user_impersonation impersonate your user account

azure_auth_code

Azure Active Directory OAuth2 AccessCode Flow

Type: oauth2
Flow: accessCode
Authorization URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Token URL: https://login.microsoftonline.com/common/oauth2/v2.0/token

Scopes

Name Description
user_impersonation impersonate your user account

azure_auth_application

Azure Active Directory OAuth2 Application Flow

Type: oauth2
Flow: application
Token URL: https://login.microsoftonline.com/common/oauth2/v2.0/token

Scopes

Name Description
.default client credential scope

azure_auth_password

Azure Active Directory OAuth2 Password Flow

Type: oauth2
Flow: password
Token URL: https://login.microsoftonline.com/common/oauth2/v2.0/token

Scopes

Name Description
user_impersonation impersonate your user account

Examples

Updates_GetFile

Sample request

GET https://contoso.api.adu.microsoft.com/deviceupdate/blue/v2/updates/providers/microsoft/names/adu/versions/1.0.0.0/files/abc123

Sample response

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

Definitions

File

Update file metadata.

Name Type Description
etag

string

File ETag.
fileId

string

File identity, generated by server at import time.
fileName

string

File name.
hashes

object

Mapping of hashing algorithm to base64 encoded hash values.
mimeType

string

File MIME type.
sizeInBytes

integer

File size in number of bytes.