Iot Hub Resource - Get Endpoint Health

Service:

IoT Hub

API Version:

2018-04-01

Ottenere l'integrità per gli endpoint di routing.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
iotHubName	path	True	string
resourceGroupName	path	True	string
subscriptionId	path	True	string	L'identificatore della sottoscrizione.
api-version	query	True	string	Versione dell'API.

Risposte

Nome	Tipo	Descrizione
200 OK	EndpointHealthDataListResult	OK
Other Status Codes	ErrorDetails	DefaultErrorResponse

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

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

Scopes

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

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

Definizioni

Nome	Descrizione
EndpointHealthData	Dati di integrità per un endpoint
EndpointHealthDataListResult	Matrice serializzata JSON di oggetti EndpointHealthData con un collegamento successivo.
EndpointHealthStatus	Codice di stato di integrità dell'endpoint
ErrorDetails	Dettagli errore.

EndpointHealthData

Dati di integrità per un endpoint

Nome	Tipo	Descrizione
endpointId	string	ID dell'endpoint
healthStatus	EndpointHealthStatus	Codice di stato di integrità dell'endpoint

EndpointHealthDataListResult

Matrice serializzata JSON di oggetti EndpointHealthData con un collegamento successivo.

Nome	Tipo	Descrizione
nextLink	string	Collegamento a altri risultati
value	EndpointHealthData[]	Matrice serializzata JSON dei dati di integrità degli endpoint

EndpointHealthStatus

Codice di stato di integrità dell'endpoint

Nome	Tipo	Descrizione
dead	string
healthy	string
unhealthy	string
unknown	string

ErrorDetails

Dettagli errore.

Nome	Tipo	Descrizione
code	string	Codice di errore.
details	string	Dettagli dell'errore.
httpStatusCode	string	Codice di stato HTTP.
message	string	Messaggio di errore.