Iot Hub Resource - Get Endpoint Health

Get the health for routing endpoints
Get the health for routing endpoints.

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

URI Parameters

Name In Required Type Description
subscriptionId
path True
  • string

The subscription identifier.

resourceGroupName
path True
  • string
iotHubName
path True
  • string
api-version
query True
  • string

The version of the API.

Responses

Name Type Description
200 OK

OK

Other Status Codes

DefaultErrorResponse

Security

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name Description
user_impersonation impersonate your user account

Examples

IotHubResource_GetEndpointHealth

Sample Request

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

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

Definitions

EndpointHealthData

The health data for an endpoint

EndpointHealthDataListResult

The JSON-serialized array of EndpointHealthData objects with a next link.

EndpointHealthStatus

The health status code of the endpoint

ErrorDetails

Error details.

EndpointHealthData

The health data for an endpoint

Name Type Description
endpointId
  • string

Id of the endpoint

healthStatus

The health status code of the endpoint

EndpointHealthDataListResult

The JSON-serialized array of EndpointHealthData objects with a next link.

Name Type Description
nextLink
  • string

Link to more results

value

JSON-serialized array of Endpoint health data

EndpointHealthStatus

The health status code of the endpoint

Name Type Description
dead
  • string
healthy
  • string
unhealthy
  • string
unknown
  • string

ErrorDetails

Error details.

Name Type Description
code
  • string

The error code.

details
  • string

The error details.

httpStatusCode
  • string

The HTTP status code.

message
  • string

The error message.