Iot Hub Resource - Get Endpoint Health

Service:

IoT Hub

API Version:

2018-04-01

Obtenha o estado de funcionamento dos pontos finais de encaminhamento.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
iotHubName	path	True	string
resourceGroupName	path	True	string
subscriptionId	path	True	string	O identificador da subscrição.
api-version	query	True	string	A versão da API.

Respostas

Name	Tipo	Description
200 OK	EndpointHealthDataListResult	OK
Other Status Codes	ErrorDetails	DefaultErrorResponse

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

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"
    }
  ]
}

Definições

Name	Description
EndpointHealthData	Os dados de estado de funcionamento de um ponto final
EndpointHealthDataListResult	A matriz serializada JSON de objetos EndpointHealthData com uma ligação seguinte.
EndpointHealthStatus	O código de estado de funcionamento do ponto final
ErrorDetails	Detalhes do erro.

EndpointHealthData

Os dados de estado de funcionamento de um ponto final

Name	Tipo	Description
endpointId	string	ID do ponto final
healthStatus	EndpointHealthStatus	O código de estado de funcionamento do ponto final

EndpointHealthDataListResult

A matriz serializada JSON de objetos EndpointHealthData com uma ligação seguinte.

Name	Tipo	Description
nextLink	string	Ligar a mais resultados
value	EndpointHealthData[]	Matriz serializada JSON de dados de estado de funcionamento do Ponto Final

EndpointHealthStatus

O código de estado de funcionamento do ponto final

Name	Tipo	Description
dead	string
healthy	string
unhealthy	string
unknown	string

ErrorDetails

Detalhes do erro.

Name	Tipo	Description
code	string	O código de erro.
details	string	Os detalhes do erro.
httpStatusCode	string	O código de estado HTTP.
message	string	A mensagem de erro.