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 de 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 do URI

Name	Em	Necessá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 o Hub IoT (somente nome do host, sem protocolo).
instanceId	path	True	string	O identificador de instância da conta da Atualização de Dispositivo para o Hub IoT.
moduleId	path	True	string	Identificador do módulo de dispositivo no Hub IoT do Azure.
api-version	query	True	string minLength: 1	A versão da API a utilizar para esta operação.

Respostas

Name	Tipo	Description
200 OK	Device	O pedido foi bem-sucedido.
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Segurança

OAuth2Auth

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

Âmbitos

Name	Description
https://api.adu.microsoft.com/.default

Exemplos

DeviceManagement_GetDeviceModule

Pedido de amostra

HTTP

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

Resposta da amostra

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

Name	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 qualquer etapa resulta nela.
StepResult	O resultado da etapa sob uma atualização.
UpdateId	Atualizar identificador.
UpdateInfo	Atualizar informações.

Device

Object

Metadados do dispositivo.

Name	Tipo	Description
deploymentStatus	DeviceDeploymentState	Estado do dispositivo em sua última implantação.
deviceClassId	string	Identidade da classe do 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 para a última implantação no dispositivo
lastInstallResult	InstallResult	Resultado da última instalação.
moduleId	string	Identidade do módulo do dispositivo.
onLatestUpdate	boolean	Sinalizador booleano que indica se a atualização mais recente (a melhor atualização compatível para a classe e grupo de dispositivos do dispositivo) está instalada no dispositivo

DeviceDeploymentState

Enumeração

Estado de implantação.

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

Error

Object

Detalhes do erro.

Name	Tipo	Description
code	string	Código de erro definido pelo servidor.
details	Error[]	Uma matriz de erros que levaram 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 por humanos do erro.
occurredDateTime	string (date-time)	Data e hora em UTC quando o erro ocorreu.
target	string	O alvo do erro.

ErrorResponse

Object

Resposta de erro comum.

Name	Tipo	Description
error	Error	Os detalhes do erro.

InnerError

Object

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 contido.
errorDetail	string	A mensagem interna de erro ou 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.

InstallResult

Object

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

Name	Tipo	Description
extendedResultCode	integer (int32)	Instalar código de resultado estendido
resultCode	integer (int32)	Instale o código de resultado.
resultDetails	string	Uma cadeia de caracteres contendo mais detalhes sobre o resultado da instalação
stepResults	StepResult[]	Matriz de resultados de etapas

StepResult

Object

O resultado da etapa sob uma atualização.

Name	Tipo	Description
description	string	Descrição do passo.
extendedResultCode	integer (int32)	Instalar código de resultado estendido
resultCode	integer (int32)	Instale o código de resultado.
resultDetails	string	Uma cadeia de caracteres contendo 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

Object

Atualizar identificador.

Name	Tipo	Description
name	string	Nome da atualização.
provider	string	Provedor de atualização.
version	string	Versão de atualização.

UpdateInfo

Object

Atualizar informações.

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