Device Update - Get File

Referência

Serviço:: Device Update

Versão da API:: 2022-10-01

Obtenha um ficheiro de atualização específico da versão.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
endpoint	path	True	string url	A Atualização de Dispositivos para Hub IoT ponto final da conta (apenas nome do anfitrião, sem protocolo).
fileId	path	True	string	Identificador de ficheiro.
instanceId	path	True	string	O identificador da instância da conta de Hub IoT Atualização de Dispositivos.
name	path	True	string	Nome da atualização.
provider	path	True	string	Atualizar fornecedor.
version	path	True	string	Atualizar versão.
api-version	query	True	string	Versão da API a utilizar com o pedido de cliente.

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
If-None-Match		string	Define a condição If-None-Match. A operação só será efetuada se o ETag no servidor não corresponder a este valor.

Respostas

Name	Tipo	Description
200 OK	UpdateFile	A entidade de ficheiro pedida.
Other Status Codes	ErrorResponse	Resposta predefinida.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
https://api.adu.microsoft.com/.default	Âmbito de autorização predefinido.

Exemplos

DeviceUpdate_GetFile

Pedido de amostra

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

Resposta da amostra

Código de estado:: 200

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

Definições

Name	Description
Error	Detalhes do erro.
ErrorResponse	Resposta de erro comum.
InnerError	Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.
UpdateFile	Atualizar metadados de ficheiro.
UpdateFileBase	Atualizar metadados básicos de ficheiros.
UpdateFileDownloadHandler	Transfira o processador para utilizar ficheiros relacionados para transferir o ficheiro payload.

Error

Detalhes do erro.

Name	Tipo	Description
code	string	Código de erro definido pelo servidor.
details	Error[]	Uma matriz de erros que levou ao erro comunicado.
innererror	InnerError	Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.
message	string	Uma representação legível por humanos do erro.
occurredDateTime	string	Data e hora em UTC em que ocorreu o erro.
target	string	O destino do erro.

ErrorResponse

Resposta de erro comum.

Name	Tipo	Description
error	Error	Os detalhes do erro.

InnerError

Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.

Name	Tipo	Description
code	string	Um código de erro mais específico do que o fornecido pelo erro que contém.
errorDetail	string	O erro interno ou a mensagem de exceção.
innerError	InnerError	Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.
message	string	Uma representação legível por humanos do erro.

UpdateFile

Atualizar metadados de ficheiro.

Name	Tipo	Description
downloadHandler	UpdateFileDownloadHandler	Processador de transferências opcional para utilizar ficheiros relacionados para transferir o ficheiro payload.
etag	string	ETag de Ficheiro.
fileId	string	Identidade de ficheiro, gerada pelo servidor no momento da importação.
fileName	string	Nome do ficheiro.
hashes	object	Mapeamento do algoritmo de hashing para base64 valores de hash codificado.
mimeType	string	Tipo de FICHEIRO MIME.
properties	object	Propriedades de ficheiro opcionais (não consumidas pelo serviço, mas pass-through para o dispositivo).
relatedFiles	UpdateFileBase[]	Metadados de ficheiros relacionados opcionais utilizados em conjunto com metadados downloadHandler para transferir o ficheiro payload.
scanDetails	string	Detalhes da análise antimalware.
scanResult	string	Resultado da análise antimalware.
sizeInBytes	integer	Tamanho do ficheiro em número de bytes.

UpdateFileBase

Atualizar metadados básicos de ficheiros.

Name	Tipo	Description
fileName	string	Nome do ficheiro.
hashes	object	Mapeamento do algoritmo de hashing para base64 valores de hash codificado.
mimeType	string	Tipo de FICHEIRO MIME.
properties	object	Propriedades de ficheiro opcionais (não consumidas pelo serviço, mas pass-through para o dispositivo).
scanDetails	string	Detalhes da análise antimalware.
scanResult	string	Resultado da análise antimalware.
sizeInBytes	integer	Tamanho do ficheiro em número de bytes.

UpdateFileDownloadHandler

Transfira o processador para utilizar ficheiros relacionados para transferir o ficheiro payload.

Name	Tipo	Description
id	string	Transfira o identificador do processador.

Partilhar via