Devices - Get Relationship

Servicio:

IoT Central

Versión de la API:

2022-07-31

Dado el identificador de un dispositivo y un identificador de relación asociado a este dispositivo, obtenga los detalles de la relación.
Obtención de la relación de dispositivo por identificador

GET https://{subdomain}.{baseDomain}/api/devices/{deviceId}/relationships/{relationshipId}?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.
relationshipId	path	True	string	Identificador único de una relación entre dispositivos.
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	DeviceRelationship	Éxito
Other Status Codes	Error	Respuesta de error recibida del servicio IoT Central. Encabezados x-ms-error-code: string

Seguridad

azure_auth

Flujo de 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	suplantar la cuenta de usuario

Ejemplos

Get device relationship by ID

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

status code:

200

{
  "id": "relationship1",
  "source": "device1",
  "target": "device2"
}

Definiciones

Nombre	Description
DeviceRelationship	Objeto que representa la relación entre un dispositivo ascendente y un dispositivo de bajada.
Error	Definición de error de respuesta.
ErrorDetails	Información detallada del error.

DeviceRelationship

Object

Objeto que representa la relación entre un dispositivo ascendente y un dispositivo de bajada.

Nombre	Tipo	Description
id	string	Identificador único de esta relación.
source	string	Identificador de dispositivo del dispositivo de origen (primario).
target	string	Identificador de dispositivo del dispositivo de destino (secundario).

Error

Object

Definición de error de respuesta.

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

ErrorDetails

Object

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 (date-time-rfc1123)	Hora en que se produjo un error en la solicitud de error.