Iot Hub Resource - Get Endpoint Health

서비스:

IoT Hub

API 버전:

2023-06-30

라우팅 엔드포인트에 대한 상태를 가져옵니다.

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
iotHubName	path	True	string
resourceGroupName	path	True	string
subscriptionId	path	True	string	구독 식별자입니다.
api-version	query	True	string	API의 버전입니다.

응답

Name	형식	Description
200 OK	EndpointHealthDataListResult	그래
Other Status Codes	ErrorDetails	DefaultErrorResponse

보안

azure_auth

Azure Active Directory OAuth2 Flow

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name	Description
user_impersonation	사용자 계정 가장

예제

IotHubResource_GetEndpointHealth

샘플 요청

HTTP

GET https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub/routingEndpointsHealth?api-version=2023-06-30

Java

/**
 * 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

Python

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

Go

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

JavaScript

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

dotnet

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

// 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

샘플 응답

상태 코드:

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

정의

Name	Description
EndpointHealthData	엔드포인트의 상태 데이터
EndpointHealthDataListResult	다음 링크가 있는 EndpointHealthData 개체의 JSON 직렬화된 배열입니다.
EndpointHealthStatus	상태의 의미는 다음과 같습니다. '정상' 상태는 엔드포인트가 예상대로 메시지를 수락하고 있음을 보여 줍니다. '비정상' 상태는 엔드포인트가 예상대로 메시지를 수락하지 않고 IoT Hub가 이 엔드포인트로 데이터를 보내려고 다시 시도하고 있음을 보여 줍니다. IoT Hub가 최종적으로 일관된 상태를 설정한 경우 비정상 엔드포인트의 상태가 정상으로 업데이트됩니다. 'dead' 상태는 IoT Hub가 재심 기간 동안 메시지 보내기를 다시 시도한 후 엔드포인트가 메시지를 수락하지 않음을 보여 줍니다. 오류를 식별하고 엔드포인트와 관련된 문제를 모니터링하려면 IoT Hub 메트릭을 참조하세요. '알 수 없음' 상태는 IoT Hub가 엔드포인트와의 연결을 설정하지 않은 것을 보여 줍니다. 이 엔드포인트에 전달되거나 거부된 메시지가 없습니다.
ErrorDetails	오류 세부 정보입니다.

EndpointHealthData

Object

엔드포인트의 상태 데이터

Name	형식	Description
endpointId	string	엔드포인트의 ID
healthStatus	EndpointHealthStatus	상태의 의미는 다음과 같습니다. '정상' 상태는 엔드포인트가 예상대로 메시지를 수락하고 있음을 보여 줍니다. '비정상' 상태는 엔드포인트가 예상대로 메시지를 수락하지 않고 IoT Hub가 이 엔드포인트로 데이터를 보내려고 다시 시도하고 있음을 보여 줍니다. IoT Hub가 최종적으로 일관된 상태를 설정한 경우 비정상 엔드포인트의 상태가 정상으로 업데이트됩니다. 'dead' 상태는 IoT Hub가 재심 기간 동안 메시지 보내기를 다시 시도한 후 엔드포인트가 메시지를 수락하지 않음을 보여 줍니다. 오류를 식별하고 엔드포인트와 관련된 문제를 모니터링하려면 IoT Hub 메트릭을 참조하세요. '알 수 없음' 상태는 IoT Hub가 엔드포인트와의 연결을 설정하지 않은 것을 보여 줍니다. 이 엔드포인트에 전달되거나 거부된 메시지가 없습니다.
lastKnownError	string	IoT Hub에 메시지를 배달하지 못한 경우 마지막으로 발생한 오류
lastKnownErrorTime	string (date-time-rfc1123)	마지막으로 알려진 오류가 발생한 시간
lastSendAttemptTime	string (date-time-rfc1123)	마지막으로 IoT 허브가 엔드포인트에 메시지를 보내려고 했습니다.
lastSuccessfulSendAttemptTime	string (date-time-rfc1123)	마지막으로 IoT 허브가 엔드포인트에 메시지를 보냈을 때

EndpointHealthDataListResult

Object

다음 링크가 있는 EndpointHealthData 개체의 JSON 직렬화된 배열입니다.

Name	형식	Description
nextLink	string	더 많은 결과에 연결
value	EndpointHealthData[]	엔드포인트 상태 데이터의 JSON 직렬화된 배열

EndpointHealthStatus

열거형

상태의 의미는 다음과 같습니다. '정상' 상태는 엔드포인트가 예상대로 메시지를 수락하고 있음을 보여 줍니다. '비정상' 상태는 엔드포인트가 예상대로 메시지를 수락하지 않고 IoT Hub가 이 엔드포인트로 데이터를 보내려고 다시 시도하고 있음을 보여 줍니다. IoT Hub가 최종적으로 일관된 상태를 설정한 경우 비정상 엔드포인트의 상태가 정상으로 업데이트됩니다. 'dead' 상태는 IoT Hub가 재심 기간 동안 메시지 보내기를 다시 시도한 후 엔드포인트가 메시지를 수락하지 않음을 보여 줍니다. 오류를 식별하고 엔드포인트와 관련된 문제를 모니터링하려면 IoT Hub 메트릭을 참조하세요. '알 수 없음' 상태는 IoT Hub가 엔드포인트와의 연결을 설정하지 않은 것을 보여 줍니다. 이 엔드포인트에 전달되거나 거부된 메시지가 없습니다.

값	Description
dead
degraded
healthy
unhealthy
unknown

ErrorDetails

Object

오류 세부 정보입니다.

Name	형식	Description
code	string	오류 코드입니다.
details	string	오류 세부 정보입니다.
httpStatusCode	string	HTTP 상태 코드입니다.
message	string	오류 메시지입니다.