Devices - Get

Servicio:

IoT Central

Versión de la API:

2022-07-31

Obtener un dispositivo por identificador
Obtenga detalles sobre un dispositivo existente por identificador de dispositivo.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
baseDomain	path	True	string	Dominio base para todas las solicitudes de servicio de Azure IoT Central.
deviceId	path	True	string	Identificador único del dispositivo.
subdomain	path	True	string	Subdominio de aplicación.
api-version	query	True	string	Versión de la API a la que se llama.

Respuestas

Nombre	Tipo	Description
200 OK	Device	Correcto
Other Status Codes	Error	Respuesta de error recibida del servicio IoT Central. Encabezados x-ms-error-code: string

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

Get device by ID

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

status code:

200

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

Definiciones

Nombre	Description
Device	Definición del dispositivo.
Error	Definición de error de respuesta.
ErrorDetails	Información detallada del error.

Device

Definición del dispositivo.

Nombre	Tipo	Description
displayName	string	Nombre para mostrar del dispositivo.
enabled	boolean	Si se ha habilitado la conexión del dispositivo a IoT Central.
etag	string	ETag usado para evitar conflictos en las actualizaciones del dispositivo.
id	string	Identificador único del dispositivo.
organizations	string[]	Lista de identificadores de organización de los que forma parte el dispositivo, solo se admite una organización hoy en día, se admitirán próximamente varias organizaciones.
provisioned	boolean	Si se han asignado recursos para el dispositivo.
simulated	boolean	Si el dispositivo está simulado.
template	string	Definición de plantilla de dispositivo para el dispositivo.

Error

Definición de error de respuesta.

Nombre	Tipo	Description
error	ErrorDetails	Detalles del error para la solicitud actual.

ErrorDetails

Información detallada del error.

Nombre	Tipo	Description
code	string	Código de error.
message	string	Detalles del mensaje de error.
requestId	string	Id. de correlación para la solicitud actual.
time	string	Hora en que se produjo un error en la solicitud de error.