Device Update - Get File

Referência

Serviço:: Device Update

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

Obtenha um arquivo 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 de URI

Nome	Em	Obrigatório	Tipo	Description
endpoint	path	True	string url	A Atualização de Dispositivo para Hub IoT ponto de extremidade da conta (somente nome do host, sem protocolo).
fileId	path	True	string	Identificador de arquivo.
instanceId	path	True	string	O identificador de instância da atualização de dispositivo para Hub IoT conta.
name	path	True	string	Nome da atualização.
provider	path	True	string	Atualizar provedor.
version	path	True	string	Atualizar versão.
api-version	query	True	string	Versão da API a ser usada com a solicitação do cliente.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
If-None-Match		string	Define a condição If-None-Match. A operação será executada somente se a ETag no servidor não corresponder a esse valor.

Respostas

Nome	Tipo	Description
200 OK	UpdateFile	A entidade de arquivo solicitada.
Other Status Codes	ErrorResponse	Resposta padrão.

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory

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

Escopos

Nome	Description
https://api.adu.microsoft.com/.default	Escopo de autorização padrão.

Exemplos

DeviceUpdate_GetFile

Solicitação de exemplo

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 de exemplo

Código de status:: 200

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

Definições

Nome	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 arquivo.
UpdateFileBase	Atualizar metadados básicos do arquivo.
UpdateFileDownloadHandler	Baixe o manipulador para utilizar arquivos relacionados para baixar o arquivo de conteúdo.

Error

Detalhes do erro.

Nome	Tipo	Description
code	string	Código de erro definido pelo servidor.
details	Error[]	Uma matriz de erros que levou ao erro relatado.
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 pelo homem do erro.
occurredDateTime	string	Data e hora em UTC quando o erro ocorreu.
target	string	O destino do erro.

ErrorResponse

Resposta de erro comum.

Nome	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.

Nome	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 pelo homem do erro.

UpdateFile

Atualizar metadados de arquivo.

Nome	Tipo	Description
downloadHandler	UpdateFileDownloadHandler	Manipulador de download opcional para utilizar arquivos relacionados para baixar o arquivo de conteúdo.
etag	string	Arquivo ETag.
fileId	string	Identidade do arquivo, gerada pelo servidor no momento da importação.
fileName	string	Nome do arquivo.
hashes	object	Mapeamento do algoritmo de hash para valores de hash codificados em base64.
mimeType	string	Tipo MIME de arquivo.
properties	object	Propriedades de arquivo opcionais (não consumidas pelo serviço, mas passagem para o dispositivo).
relatedFiles	UpdateFileBase[]	Metadados de arquivos relacionados opcionais usados juntos para baixar os metadados do DownloadHandler para baixar o arquivo de conteúdo.
scanDetails	string	Detalhes de verificação antimalware.
scanResult	string	Resultado da verificação antimalware.
sizeInBytes	integer	Tamanho do arquivo em número de bytes.

UpdateFileBase

Atualizar metadados básicos do arquivo.

Nome	Tipo	Description
fileName	string	Nome do arquivo.
hashes	object	Mapeamento do algoritmo de hash para valores de hash codificados em base64.
mimeType	string	Tipo MIME de arquivo.
properties	object	Propriedades de arquivo opcionais (não consumidas pelo serviço, mas passagem para o dispositivo).
scanDetails	string	Detalhes de verificação antimalware.
scanResult	string	Resultado da verificação antimalware.
sizeInBytes	integer	Tamanho do arquivo em número de bytes.

UpdateFileDownloadHandler

Baixe o manipulador para utilizar arquivos relacionados para baixar o arquivo de conteúdo.

Nome	Tipo	Description
id	string	Baixar o identificador do manipulador.

Compartilhar via