Device Update - Get Operation Status

Serviço:

Device Update

Versão da API:

2022-10-01

Obter o estado da operação.

GET https://{endpoint}/deviceUpdate/{instanceId}/updates/operations/{operationId}?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).
instanceId	path	True	string	O identificador da instância da conta de Hub IoT Atualização de Dispositivos.
operationId	path	True	string	Identificador de operaçã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	UpdateOperation	Estado da operação. Cabeçalhos Retry-After: string
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_GetOperationStatus

Pedido de amostra

HTTP

GET https://contoso.api.adu.microsoft.com/deviceUpdate/blue/updates/operations/e4491c54-916f-443d-9094-bcca546ace2f?api-version=2022-10-01

Resposta da amostra

Código de estado:

200

{
  "operationId": "e4491c54-916f-443d-9094-bcca546ace2f",
  "status": "Succeeded",
  "update": {
    "updateId": {
      "provider": "microsoft",
      "name": "adu",
      "version": "1.0.0.0"
    },
    "friendlyName": "Microsoft ADU v1"
  },
  "resourceLocation": "/deviceUpdate/blue/updates/providers/microsoft/names/adu/versions/1.0.0.0?api-version=2022-10-01",
  "traceId": "2b881ef9deaf5d45b0a716ca5b4145ec",
  "createdDateTime": "2020-04-22T21:00:53.2548897+00:00",
  "lastActionDateTime": "2020-04-22T21:01:43.9401420+00:00",
  "etag": "\"a0f7b6f2-3f6c-4eb6-8a59-2f5411c23888\""
}

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.
OperationStatus	Estado da operação.
UpdateId	Identificador de atualização.
UpdateInfo	Atualizar informações.
UpdateOperation	Metadados de operação.

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.

OperationStatus

Estado da operação.

Name	Tipo	Description
Failed	string	A operação em segundo plano terminou com a falha.
NotStarted	string	Operação em segundo plano criada, mas ainda não iniciada.
Running	string	A operação em segundo plano está atualmente em execução.
Succeeded	string	A operação em segundo plano foi concluída com êxito.

UpdateId

Identificador de atualização.

Name	Tipo	Description
name	string	Nome da atualização.
provider	string	Atualizar fornecedor.
version	string	Atualizar versão.

UpdateInfo

Atualizar informações.

Name	Tipo	Description
description	string	Descrição da atualização.
friendlyName	string	Nome de atualização amigável.
updateId	UpdateId	Identificador de atualização.

UpdateOperation

Metadados de operação.

Name	Tipo	Description
createdDateTime	string	Data e hora em UTC quando a operação foi criada.
error	Error	Erro de operação encontrado, se existir.
etag	string	Operação ETag.
lastActionDateTime	string	Data e hora em UTC em que o estado da operação foi atualizado pela última vez.
operationId	string	ID da Operação.
resourceLocation	string	Localização da atualização importada quando a operação é efetuada com êxito.
status	OperationStatus	Estado da operação.
traceId	string	Identidade de correlação de operações que pode ser utilizada por Suporte da Microsoft para resolução de problemas.
update	UpdateInfo	A atualização a ser importada ou eliminada. Para importação, esta propriedade só será preenchida depois de o manifesto de importação ser processado com êxito.