Compartilhar via

Devices - Get

  • Referência
Serviço:
IoT Central
Versão da API:
2022-07-31

obter um dispositivo por ID;
Obtenha detalhes sobre um dispositivo existente por ID do dispositivo.

GET https://{subdomain}.{baseDomain}/api/devices/{deviceId}?api-version=2022-07-31

Parâmetros de URI

Nome Em Obrigatório Tipo Description
baseDomain
 path True

string

O domínio base para todas as solicitações de serviço do Azure IoT Central.
deviceId
 path True

string

ID exclusiva do dispositivo.
subdomain
 path True

string

O subdomínio do aplicativo.
api-version
 query True

string

A versão da API que está sendo chamada.

Respostas

Nome Tipo Description
200 OK

Device

Êxito
Other Status Codes

Error

Uma resposta de erro recebida do Serviço Central do IoT.

Cabeçalhos

x-ms-error-code: string

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
user_impersonation representar sua conta de usuário

Exemplos

Get device by ID

Solicitação de exemplo

GET https://appsubdomain.azureiotcentral.com/api/devices/CheckoutThermostat?api-version=2022-07-31

Resposta de exemplo

Código de status:
200 
{
  "id": "CheckoutThermostat",
  "etag": "eyJoZWFkZXIiOiJcIjAyMDA4YzMyLTAwMDAtMGQwMC0wMDAwLTVkOTY4YjdhMDAwMFwiIn0",
  "displayName": "CheckoutThermostat",
  "template": "dtmi:contoso:testDeviceTemplate;1",
  "simulated": true,
  "provisioned": true,
  "enabled": true,
  "organizations": [
    "seattle"
  ]
}

Definições

Nome Description
Device

A definição do dispositivo.
Error

A definição de erro de resposta.
ErrorDetails

As informações detalhadas do erro.

Device

Objeto

A definição do dispositivo.

Nome Tipo Description
displayName

string

Nome de exibição do dispositivo.
enabled

boolean

Se a conexão do dispositivo com o IoT Central foi habilitada.
etag

string

ETag usada para evitar conflitos em atualizações de dispositivo.
id

string

ID exclusiva do dispositivo.
organizations

string[]

Lista de IDs da organização das quais o dispositivo faz parte, apenas uma organização tem suporte hoje, várias organizações terão suporte em breve.
provisioned

boolean

Se os recursos foram alocados para o dispositivo.
simulated

boolean

Se o dispositivo é simulado.
template

string

A definição do modelo de dispositivo para o dispositivo.

Error

Objeto

A definição de erro de resposta.

Nome Tipo Description
error

ErrorDetails

Detalhes do erro da solicitação atual.

ErrorDetails

Objeto

As informações detalhadas do erro.

Nome Tipo Description
code

string

Código de erro.
message

string

Detalhes da mensagem de erro.
requestId

string

ID de correlação para a solicitação atual.
time

string (date-time-rfc1123)

A hora em que a solicitação de erro falhou.