Iot Hub Resource - Get Endpoint Health

Service:

IoT Hub

API Version:

2018-04-01

Obtenga el estado de los puntos de conexión de enrutamiento.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{iotHubName}/routingEndpointsHealth?api-version=2018-04-01

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
iotHubName	path	True	string
resourceGroupName	path	True	string
subscriptionId	path	True	string	Identificador de la suscripción.
api-version	query	True	string	La versión de la API.

Respuestas

Nombre	Tipo	Description
200 OK	EndpointHealthDataListResult	Aceptar
Other Status Codes	ErrorDetails	DefaultErrorResponse

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory

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

Scopes

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

IotHubResource_GetEndpointHealth

Sample Request

HTTP

GET https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub/routingEndpointsHealth?api-version=2018-04-01

Sample Response

Status code:

200

{
  "value": [
    {
      "endpointId": "id1",
      "healthStatus": "healthy"
    },
    {
      "endpointId": "id2",
      "healthStatus": "unknown"
    }
  ]
}

Definiciones

Nombre	Description
EndpointHealthData	Los datos de mantenimiento de un punto de conexión
EndpointHealthDataListResult	Matriz serializada por JSON de objetos EndpointHealthData con un vínculo siguiente.
EndpointHealthStatus	El código de estado de mantenimiento del punto de conexión
ErrorDetails	Detalles del error.

EndpointHealthData

Los datos de mantenimiento de un punto de conexión

Nombre	Tipo	Description
endpointId	string	Identificador del punto de conexión
healthStatus	EndpointHealthStatus	El código de estado de mantenimiento del punto de conexión

EndpointHealthDataListResult

Matriz serializada por JSON de objetos EndpointHealthData con un vínculo siguiente.

Nombre	Tipo	Description
nextLink	string	Vínculo a más resultados
value	EndpointHealthData[]	Matriz serializada por JSON de datos de estado del punto de conexión

EndpointHealthStatus

El código de estado de mantenimiento del punto de conexión

Nombre	Tipo	Description
dead	string
healthy	string
unhealthy	string
unknown	string

ErrorDetails

Detalles del error.

Nombre	Tipo	Description
code	string	Código de error.
details	string	Los detalles del error.
httpStatusCode	string	El código de estado HTTP.
message	string	El mensaje de error.