Partilhar 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 de dispositivo.

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

Parâmetros do URI

Name Em Necessá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 exclusivo 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

Name Tipo Description
200 OK

Device

Sucesso
Other Status Codes

Error

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

Cabeçalhos

x-ms-error-code: string

Segurança

azure_auth

Azure Ative Directory OAuth2 Flow

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

Âmbitos

Name Description
user_impersonation personificar a sua conta de utilizador

Exemplos

Get device by ID

Pedido de amostra

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

Resposta da amostra

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

Definições

Name Description
Device

A definição do dispositivo.
Error

A definição de erro de resposta.
ErrorDetails

As informações detalhadas do erro.

Device

Object

A definição do dispositivo.

Name 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 usado para evitar conflitos em atualizações de dispositivos.
id

string

ID exclusivo do dispositivo.
organizations

string[]

Lista de IDs da organização da qual o dispositivo faz parte, apenas uma organização é suportada hoje, várias organizações serão suportadas em breve.
provisioned

boolean

Se os recursos foram alocados para o dispositivo.
simulated

boolean

Se o dispositivo é simulado.
template

string

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

Error

Object

A definição de erro de resposta.

Name Tipo Description
error

ErrorDetails

Detalhes do erro para a solicitação atual.

ErrorDetails

Object

As informações detalhadas do erro.

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