Compartilhar via

Device Update - Get Operation Status

  • Referência
Serviço:
Device Update
Versão da API:
2022-10-01

Recuperar status de operação.

GET https://{endpoint}/deviceUpdate/{instanceId}/updates/operations/{operationId}?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).
instanceId
 path True

string

A Atualização de Dispositivo para Hub IoT identificador de instância da conta.
operationId
 path True

string

Identificador de operaçã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

UpdateOperation

Status da operação.

Cabeçalhos

Retry-After: string
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_GetOperationStatus

Solicitação de exemplo

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

Resposta de exemplo

Código de status:
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

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

Status da operação.
UpdateId

Atualizar identificador.
UpdateInfo

Atualizar informações.
UpdateOperation

Metadados de operação.

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 do erro.
occurredDateTime

string

Data e hora em UTC em que 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 o 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 do erro.

OperationStatus

Status da operação.

Nome Tipo Description
Failed

string

Operação em segundo plano concluída com falha.
NotStarted

string

Operação em segundo plano criada, mas ainda não iniciada.
Running

string

A operação em segundo plano está em execução no momento.
Succeeded

string

Operação em segundo plano concluída com êxito.

UpdateId

Atualizar identificador.

Nome Tipo Description
name

string

Nome da atualização.
provider

string

Atualizar provedor.
version

string

Atualizar versão.

UpdateInfo

Atualizar informações.

Nome Tipo Description
description

string

Descrição da atualização.
friendlyName

string

Nome da atualização amigável.
updateId

UpdateId

Atualizar identificador.

UpdateOperation

Metadados de operação.

Nome Tipo Description
createdDateTime

string

Data e hora em UTC em que a operação foi criada.
error

Error

Erro de operação encontrado, se houver.
etag

string

Operação ETag.
lastActionDateTime

string

Data e hora em UTC em que a operação status foi atualizada pela última vez.
operationId

string

ID da Operação.
resourceLocation

string

Local da atualização importada quando a operação for bem-sucedida.
status

OperationStatus

Status da operação.
traceId

string

Identidade de correlação de operação que pode ser usada por Suporte da Microsoft para solução de problemas.
update

UpdateInfo

A atualização que está sendo importada ou excluída. Para importação, essa propriedade só será preenchida depois que o manifesto de importação for processado com êxito.