Device Management - Get Device Module

Serviço:: Device Update

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

Obtém as propriedades do módulo de dispositivo e o status de implantação mais recente para um módulo de dispositivo conectado à Atualização de Dispositivo para o Hub IoT.

GET https://{endpoint}/deviceUpdate/{instanceId}/management/devices/{deviceId}/modules/{moduleId}?api-version=2022-10-01

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
deviceId	path	True	string	Identificador de dispositivo no Hub IoT do Azure.
endpoint	path	True	string (url)	O ponto de extremidade da conta da Atualização de Dispositivo para Hub IoT (somente nome do host, sem protocolo).
instanceId	path	True	string	O identificador da instância da conta do Device Update para Hub IoT.
moduleId	path	True	string	Identificador do módulo de dispositivo no Hub IoT do Azure.
api-version	query	True	string	Versão da API a ser usada com a solicitação do cliente.

Respostas

Nome	Tipo	Description
200 OK	Device	As propriedades do dispositivo e o status de implantação mais recente.
Other Status Codes	ErrorResponse	Resposta padrão.

Segurança

azure_auth

Fluxo 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

DeviceManagement_GetDevice

Solicitação de exemplo

HTTP

GET https://contoso.api.adu.microsoft.com/deviceUpdate/blue/management/devices/deviceId/modules/moduleId?api-version=2022-10-01

Resposta de exemplo

Código de status:: 200

{
  "deviceId": "device1",
  "moduleId": "module1",
  "deviceClassId": "deviceClassId1",
  "lastAttemptedUpdate": {
    "updateId": {
      "provider": "provider1",
      "name": "name1",
      "version": "2.0.0.0"
    }
  },
  "deploymentStatus": "Failed",
  "installedUpdate": {
    "updateId": {
      "provider": "provider1",
      "name": "name1",
      "version": "1.0.0.0"
    }
  },
  "onLatestUpdate": false,
  "lastInstallResult": {
    "resultCode": 200,
    "extendedResultCode": 0,
    "resultDetails": "",
    "stepResults": [
      {
        "update": {
          "updateId": {
            "provider": "microsoft",
            "name": "peripheralcamera",
            "version": "1.0"
          }
        },
        "resultCode": 200,
        "extendedResultCode": 0,
        "resultDetails": ""
      },
      {
        "update": {
          "updateId": {
            "provider": "microsoft",
            "name": "peripheralspeaker",
            "version": "1.0"
          }
        },
        "resultCode": 200,
        "extendedResultCode": 0,
        "resultDetails": ""
      }
    ]
  }
}

Definições

Nome	Description
Device	Metadados do dispositivo.
DeviceDeploymentState	Estado de implantação.
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.
InstallResult	O resultado da instalação de uma atualização e de qualquer etapa resulta nela.
StepResult	O resultado da etapa em uma atualização.
UpdateId	Identificador de atualização.
UpdateInfo	Atualizar informações.

Device

Objeto

Metadados do dispositivo.

Nome	Tipo	Description
deploymentStatus	DeviceDeploymentState	Estado do dispositivo em sua última implantação.
deviceClassId	string	Identidade da classe de dispositivo.
deviceId	string	Identidade do dispositivo.
groupId	string	Identidade do grupo de dispositivos.
installedUpdate	UpdateInfo	Atualização atualmente instalada no dispositivo.
lastAttemptedUpdate	UpdateInfo	A atualização que o dispositivo tentou instalar pela última vez.
lastDeploymentId	string	O identificador de implantação da última implantação no dispositivo
lastInstallResult	InstallResult	Último resultado da instalação.
moduleId	string	Identidade do módulo do dispositivo.
onLatestUpdate	boolean	Sinalizador booliano que indica se a atualização mais recente (a melhor atualização compatível para a classe de dispositivo e o grupo do dispositivo) está instalada no dispositivo

DeviceDeploymentState

Enumeração

Estado de implantação.

Valor	Description
Succeeded	A implantação foi concluída com êxito.
InProgress	A implantação está em andamento.
Canceled	A implantação foi cancelada.
Failed	A implantação foi concluída com falha.

Error

Objeto

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 ser humano do erro.
occurredDateTime	string (date-time)	Data e hora em UTC quando o erro ocorreu.
target	string	O destino do erro.

ErrorResponse

Objeto

Resposta de erro comum.

Nome	Tipo	Description
error	Error	Os detalhes do erro.

InnerError

Objeto

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 ser humano do erro.

InstallResult

Objeto

O resultado da instalação de uma atualização e de qualquer etapa resulta nela.

Nome	Tipo	Description
extendedResultCode	integer	Instalar o código de resultado estendido
resultCode	integer	Instale o código de resultado.
resultDetails	string	Uma cadeia de caracteres que contém mais detalhes sobre o resultado da instalação
stepResults	StepResult[]	Matriz de resultados da etapa

StepResult

Objeto

O resultado da etapa em uma atualização.

Nome	Tipo	Description
description	string	Descrição da etapa.
extendedResultCode	integer	Instalar o código de resultado estendido
resultCode	integer	Instale o código de resultado.
resultDetails	string	Uma cadeia de caracteres que contém mais detalhes sobre o resultado da instalação
update	UpdateInfo	A atualização que esta etapa instala se for do tipo de referência.

UpdateId

Objeto

Identificador de atualização.

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

UpdateInfo

Objeto

Atualizar informações.

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