Iot Hub Resource - Get Endpoint Health

Başvuru

Service:: IoT Hub

API Version:: 2023-06-30

Yönlendirme uç noktalarının sistem durumunu alın.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
iotHubName	path	True	string
resourceGroupName	path	True	string
subscriptionId	path	True	string	Abonelik tanımlayıcısı.
api-version	query	True	string	API'nin sürümü.

Yanıtlar

Name	Tür	Description
200 OK	EndpointHealthDataListResult	Tamam
Other Status Codes	ErrorDetails	DefaultErrorResponse

Güvenlik

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	kullanıcı hesabınızın kimliğine bürünme

Örnekler

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=2023-06-30

/** Samples for IotHubResource GetEndpointHealth. */
public final class Main {
    /*
     * x-ms-original-file: specification/iothub/resource-manager/Microsoft.Devices/stable/2023-06-30/examples/iothub_routingendpointhealth.json
     */
    /**
     * Sample code: IotHubResource_GetEndpointHealth.
     *
     * @param manager Entry point to IotHubManager.
     */
    public static void iotHubResourceGetEndpointHealth(com.azure.resourcemanager.iothub.IotHubManager manager) {
        manager.iotHubResources().getEndpointHealth("myResourceGroup", "testHub", com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential
from azure.mgmt.iothub import IotHubClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-iothub
# USAGE
    python iothub_routingendpointhealth.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = IotHubClient(
        credential=DefaultAzureCredential(),
        subscription_id="91d12660-3dec-467a-be2a-213b5544ddc0",
    )

    response = client.iot_hub_resource.get_endpoint_health(
        resource_group_name="myResourceGroup",
        iot_hub_name="testHub",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/iothub/resource-manager/Microsoft.Devices/stable/2023-06-30/examples/iothub_routingendpointhealth.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armiothub_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/iothub/armiothub"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/32c178f2467f792a322f56174be244135d2c907f/specification/iothub/resource-manager/Microsoft.Devices/stable/2023-06-30/examples/iothub_routingendpointhealth.json
func ExampleResourceClient_NewGetEndpointHealthPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armiothub.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewResourceClient().NewGetEndpointHealthPager("myResourceGroup", "testHub", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.EndpointHealthDataListResult = armiothub.EndpointHealthDataListResult{
		// 	Value: []*armiothub.EndpointHealthData{
		// 		{
		// 			EndpointID: to.Ptr("id1"),
		// 			HealthStatus: to.Ptr(armiothub.EndpointHealthStatusHealthy),
		// 			LastSendAttemptTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC1123, "2022-09-13T18:04:32.000Z"); return t}()),
		// 			LastSuccessfulSendAttemptTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC1123, "2022-09-13T18:04:32.000Z"); return t}()),
		// 		},
		// 		{
		// 			EndpointID: to.Ptr("id2"),
		// 			HealthStatus: to.Ptr(armiothub.EndpointHealthStatusUnknown),
		// 		},
		// 		{
		// 			EndpointID: to.Ptr("id3"),
		// 			HealthStatus: to.Ptr(armiothub.EndpointHealthStatusUnhealthy),
		// 			LastKnownError: to.Ptr("NotFound"),
		// 			LastKnownErrorTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC1123, "2022-09-13T18:04:32.000Z"); return t}()),
		// 			LastSendAttemptTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC1123, "2022-09-13T18:04:32.000Z"); return t}()),
		// 			LastSuccessfulSendAttemptTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC1123, "2022-09-13T18:04:32.000Z"); return t}()),
		// 	}},
		// }
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { IotHubClient } = require("@azure/arm-iothub");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Get the health for routing endpoints.
 *
 * @summary Get the health for routing endpoints.
 * x-ms-original-file: specification/iothub/resource-manager/Microsoft.Devices/stable/2023-06-30/examples/iothub_routingendpointhealth.json
 */
async function iotHubResourceGetEndpointHealth() {
  const subscriptionId =
    process.env["IOTHUB_SUBSCRIPTION_ID"] || "91d12660-3dec-467a-be2a-213b5544ddc0";
  const resourceGroupName = process.env["IOTHUB_RESOURCE_GROUP"] || "myResourceGroup";
  const iotHubName = "testHub";
  const credential = new DefaultAzureCredential();
  const client = new IotHubClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.iotHubResource.listEndpointHealth(resourceGroupName, iotHubName)) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.IotHub;
using Azure.ResourceManager.IotHub.Models;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/iothub/resource-manager/Microsoft.Devices/stable/2023-06-30/examples/iothub_routingendpointhealth.json
// this example is just showing the usage of "IotHubResource_GetEndpointHealth" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this IotHubDescriptionResource created on azure
// for more information of creating IotHubDescriptionResource, please refer to the document of IotHubDescriptionResource
string subscriptionId = "91d12660-3dec-467a-be2a-213b5544ddc0";
string resourceGroupName = "myResourceGroup";
string iotHubName = "testHub";
ResourceIdentifier iotHubDescriptionResourceId = IotHubDescriptionResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, iotHubName);
IotHubDescriptionResource iotHubDescription = client.GetIotHubDescriptionResource(iotHubDescriptionResourceId);

// invoke the operation and iterate over the result
await foreach (IotHubEndpointHealthInfo item in iotHubDescription.GetEndpointHealthAsync())
{
    Console.WriteLine($"Succeeded: {item}");
}

Console.WriteLine($"Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:: 200

{
  "value": [
    {
      "endpointId": "id1",
      "healthStatus": "healthy",
      "lastSuccessfulSendAttemptTime": "Wed, 13 Sep 2022 18:04:32 GMT",
      "lastSendAttemptTime": "Wed, 13 Sep 2022 18:04:32 GMT"
    },
    {
      "endpointId": "id2",
      "healthStatus": "unknown"
    },
    {
      "endpointId": "id3",
      "healthStatus": "unhealthy",
      "lastKnownError": "NotFound",
      "lastKnownErrorTime": "Wed, 13 Sep 2022 18:04:32 GMT",
      "lastSuccessfulSendAttemptTime": "Wed, 13 Sep 2022 18:04:32 GMT",
      "lastSendAttemptTime": "Wed, 13 Sep 2022 18:04:32 GMT"
    }
  ]
}

Tanımlar

Name	Description
EndpointHealthData	Uç noktanın sistem durumu verileri
EndpointHealthDataListResult	Sonraki bağlantıya sahip EndpointHealthData nesnelerinin JSON serileştirilmiş dizisi.
EndpointHealthStatus	Sistem durumu durumları aşağıdaki anlamlara sahiptir. 'Sağlıklı' durumu, uç noktanın iletileri beklendiği gibi kabul ettiğini gösterir. 'İyi durumda değil' durumu, uç noktanın iletileri beklendiği gibi kabul etmediğini ve IoT Hub bu uç noktaya veri göndermeyi yeniden denediğini gösterir. sağlıksız bir uç noktanın durumu, IoT Hub sonunda tutarlı bir sistem durumu oluşturduğunda iyi durumda olarak güncelleştirilir. 'Ölü' durumu, yeniden deneme süresi için iletileri gönderme IoT Hub yeniden denendikten sonra uç noktanın iletileri kabul etmediğini gösterir. Hataları belirlemek ve uç noktalarla ilgili sorunları izlemek için bkz. IoT Hub ölçümleri. 'Bilinmeyen' durumu, IoT Hub uç noktayla bağlantı kurmadığını gösterir. Bu uç noktaya ileti teslim edilmedi veya bu uç noktadan ileti reddedildi
ErrorDetails	Hata ayrıntıları.

EndpointHealthData

Uç noktanın sistem durumu verileri

Name	Tür	Description
endpointId	string	Uç noktanın kimliği
healthStatus	EndpointHealthStatus	Sistem durumu durumları aşağıdaki anlamlara sahiptir. 'Sağlıklı' durumu, uç noktanın iletileri beklendiği gibi kabul ettiğini gösterir. 'İyi durumda değil' durumu, uç noktanın iletileri beklendiği gibi kabul etmediğini ve IoT Hub bu uç noktaya veri göndermeyi yeniden denediğini gösterir. sağlıksız bir uç noktanın durumu, IoT Hub sonunda tutarlı bir sistem durumu oluşturduğunda iyi durumda olarak güncelleştirilir. 'Ölü' durumu, yeniden deneme süresi için iletileri gönderme IoT Hub yeniden denendikten sonra uç noktanın iletileri kabul etmediğini gösterir. Hataları belirlemek ve uç noktalarla ilgili sorunları izlemek için bkz. IoT Hub ölçümleri. 'Bilinmeyen' durumu, IoT Hub uç noktayla bağlantı kurmadığını gösterir. Bu uç noktaya ileti teslim edilmedi veya bu uç noktadan ileti reddedildi
lastKnownError	string	Bir ileti iot hub'ına teslim edilemediğinde alınan son hata
lastKnownErrorTime	string	Bilinen son hatanın oluştuğu saat
lastSendAttemptTime	string	iot hub'ı son kez uç noktaya ileti göndermeye çalıştığında
lastSuccessfulSendAttemptTime	string	IoT hub'ı son kez uç noktaya başarıyla bir ileti gönderdi

EndpointHealthDataListResult

Sonraki bağlantıya sahip EndpointHealthData nesnelerinin JSON serileştirilmiş dizisi.

Name	Tür	Description
nextLink	string	Daha fazla sonuç bağlantısı
value	EndpointHealthData[]	Uç nokta sistem durumu verilerinin JSON serileştirilmiş dizisi

EndpointHealthStatus

Sistem durumu durumları aşağıdaki anlamlara sahiptir. 'Sağlıklı' durumu, uç noktanın iletileri beklendiği gibi kabul ettiğini gösterir. 'İyi durumda değil' durumu, uç noktanın iletileri beklendiği gibi kabul etmediğini ve IoT Hub bu uç noktaya veri göndermeyi yeniden denediğini gösterir. sağlıksız bir uç noktanın durumu, IoT Hub sonunda tutarlı bir sistem durumu oluşturduğunda iyi durumda olarak güncelleştirilir. 'Ölü' durumu, yeniden deneme süresi için iletileri gönderme IoT Hub yeniden denendikten sonra uç noktanın iletileri kabul etmediğini gösterir. Hataları belirlemek ve uç noktalarla ilgili sorunları izlemek için bkz. IoT Hub ölçümleri. 'Bilinmeyen' durumu, IoT Hub uç noktayla bağlantı kurmadığını gösterir. Bu uç noktaya ileti teslim edilmedi veya bu uç noktadan ileti reddedildi

Name	Tür	Description
dead	string
degraded	string
healthy	string
unhealthy	string
unknown	string

ErrorDetails

Hata ayrıntıları.

Name	Tür	Description
code	string	Hata kodu.
details	string	Hata ayrıntıları.
httpStatusCode	string	HTTP durum kodu.
message	string	Hata iletisi.