Iot Hub Resource - Get Endpoint Health

De status voor routerings-eindpunten op te halen.

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
iotHubName
path True
  • string
resourceGroupName
path True
  • string
subscriptionId
path True
  • string

De abonnements-id.

api-version
query True
  • string

De versie van de API.

Antwoorden

Name Type Description
200 OK

OK

Other Status Codes

DefaultErrorResponse

Beveiliging

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 uw gebruikersaccount imiteren

Voorbeelden

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

Definities

EndpointHealthData

De statusgegevens voor een eindpunt

EndpointHealthDataListResult

De door JSON geser serialiseerde matrix van EndpointHealthData-objecten met een volgende koppeling.

EndpointHealthStatus

De statuscode van het eindpunt

ErrorDetails

Foutdetails.

EndpointHealthData

De statusgegevens voor een eindpunt

Name Type Description
endpointId
  • string

Id van het eindpunt

healthStatus

De statuscode van het eindpunt

EndpointHealthDataListResult

De door JSON geser serialiseerde matrix van EndpointHealthData-objecten met een volgende koppeling.

Name Type Description
nextLink
  • string

Koppeling naar meer resultaten

value

Door JSON geser serialiseerde matrix met eindpunt-statusgegevens

EndpointHealthStatus

De statuscode van het eindpunt

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

ErrorDetails

Foutdetails.

Name Type Description
code
  • string

De foutcode.

details
  • string

De foutdetails.

httpStatusCode
  • string

De HTTP-statuscode.

message
  • string

Het foutbericht.