Devices - Get

Service:

IoT Central

API Version:

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 todos os pedidos de serviço do Azure IoT Central.
deviceId	path	True	string	ID exclusivo do dispositivo.
subdomain	path	True	string	O subdomínio da aplicação.
api-version	query	True	string	A versão da API que está a ser chamada.

Respostas

Name	Tipo	Description
200 OK	Device	Com êxito
Other Status Codes	Error	Uma resposta de erro recebida do Serviço Central do IoT. Headers x-ms-error-code: string

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	representar a sua conta de utilizador

Exemplos

Get device by ID

Sample Request

HTTP

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

Sample Response

Status code:

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

A definição do dispositivo.

Name	Tipo	Description
displayName	string	Nome a apresentar do dispositivo.
enabled	boolean	Se a ligação do dispositivo ao IoT Central foi ativada.
etag	string	ETag utilizada para evitar conflitos nas atualizações de dispositivos.
id	string	ID exclusivo do dispositivo.
organizations	string[]	Lista de IDs da organização dos quais o dispositivo faz parte, apenas uma organização é suportada atualmente, várias organizações serão suportadas em breve.
provisioned	boolean	Se foram alocados recursos para o dispositivo.
simulated	boolean	Se o dispositivo está simulado.
template	string	A definição do modelo de dispositivo para o dispositivo.

Error

A definição de erro de resposta.

Name	Tipo	Description
error	ErrorDetails	Detalhes do erro do pedido atual.

ErrorDetails

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 do pedido atual.
time	string	A hora em que o pedido de erro falhou.