Iot Hub Resource - Test Route

サービス:

IoT Hub

API バージョン:

2023-06-30

この IoT Hub の新しいルートをテストする

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{iotHubName}/routing/routes/$testnew?api-version=2023-06-30

URI パラメーター

名前	/	必須	型	説明
iotHubName	path	True	string	テストする IotHub
resourceGroupName	path	True	string	IoT Hub が属するリソース グループ
subscriptionId	path	True	string	サブスクリプション識別子。
api-version	query	True	string	API のバージョン。

要求本文

名前	必須	型	説明
route	True	RouteProperties	ルートのプロパティ
message		RoutingMessage	ルーティング メッセージ
twin		RoutingTwin	ルーティング ツインリファレンス

応答

名前	型	説明
200 OK	TestRouteResult	わかりました
Other Status Codes	ErrorDetails	DefaultErrorResponse

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザー アカウントを偽装する

例

IotHubResource_TestRoute

要求のサンプル

HTTP

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

{
  "message": {
    "body": "Body of message",
    "appProperties": {
      "key1": "value1"
    },
    "systemProperties": {
      "key1": "value1"
    }
  },
  "route": {
    "name": "Routeid",
    "source": "DeviceMessages",
    "endpointNames": [
      "id1"
    ],
    "isEnabled": true
  }
}

Java

import com.azure.resourcemanager.iothub.models.RouteProperties;
import com.azure.resourcemanager.iothub.models.RoutingMessage;
import com.azure.resourcemanager.iothub.models.RoutingSource;
import com.azure.resourcemanager.iothub.models.TestRouteInput;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for IotHubResource TestRoute.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/iothub/resource-manager/Microsoft.Devices/stable/2023-06-30/examples/iothub_testnewroute.json
     */
    /**
     * Sample code: IotHubResource_TestRoute.
     * 
     * @param manager Entry point to IotHubManager.
     */
    public static void iotHubResourceTestRoute(com.azure.resourcemanager.iothub.IotHubManager manager) {
        manager.iotHubResources().testRouteWithResponse("testHub", "myResourceGroup",
            new TestRouteInput()
                .withMessage(new RoutingMessage().withBody("Body of message")
                    .withAppProperties(mapOf("key1", "fakeTokenPlaceholder"))
                    .withSystemProperties(mapOf("key1", "fakeTokenPlaceholder")))
                .withRoute(new RouteProperties().withName("Routeid").withSource(RoutingSource.DEVICE_MESSAGES)
                    .withEndpointNames(Arrays.asList("id1")).withIsEnabled(true)),
            com.azure.core.util.Context.NONE);
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

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_testnewroute.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.test_route(
        iot_hub_name="testHub",
        resource_group_name="myResourceGroup",
        input={
            "message": {
                "appProperties": {"key1": "value1"},
                "body": "Body of message",
                "systemProperties": {"key1": "value1"},
            },
            "route": {"endpointNames": ["id1"], "isEnabled": True, "name": "Routeid", "source": "DeviceMessages"},
        },
    )
    print(response)


# x-ms-original-file: specification/iothub/resource-manager/Microsoft.Devices/stable/2023-06-30/examples/iothub_testnewroute.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/azcore/to"
	"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_testnewroute.json
func ExampleResourceClient_TestRoute() {
	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)
	}
	res, err := clientFactory.NewResourceClient().TestRoute(ctx, "testHub", "myResourceGroup", armiothub.TestRouteInput{
		Message: &armiothub.RoutingMessage{
			AppProperties: map[string]*string{
				"key1": to.Ptr("value1"),
			},
			Body: to.Ptr("Body of message"),
			SystemProperties: map[string]*string{
				"key1": to.Ptr("value1"),
			},
		},
		Route: &armiothub.RouteProperties{
			Name: to.Ptr("Routeid"),
			EndpointNames: []*string{
				to.Ptr("id1")},
			IsEnabled: to.Ptr(true),
			Source:    to.Ptr(armiothub.RoutingSourceDeviceMessages),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.TestRouteResult = armiothub.TestRouteResult{
	// 	Result: to.Ptr(armiothub.TestResultStatusFalse),
	// 	Details: &armiothub.TestRouteResultDetails{
	// 		CompilationErrors: []*armiothub.RouteCompilationError{
	// 			{
	// 				Location: &armiothub.RouteErrorRange{
	// 					End: &armiothub.RouteErrorPosition{
	// 						Column: to.Ptr[int32](24),
	// 						Line: to.Ptr[int32](12),
	// 					},
	// 					Start: &armiothub.RouteErrorPosition{
	// 						Column: to.Ptr[int32](12),
	// 						Line: to.Ptr[int32](12),
	// 					},
	// 				},
	// 				Message: to.Ptr("string response"),
	// 				Severity: to.Ptr(armiothub.RouteErrorSeverityError),
	// 		}},
	// 	},
	// }
}

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 Test the new route for this Iot Hub
 *
 * @summary Test the new route for this Iot Hub
 * x-ms-original-file: specification/iothub/resource-manager/Microsoft.Devices/stable/2023-06-30/examples/iothub_testnewroute.json
 */
async function iotHubResourceTestRoute() {
  const subscriptionId =
    process.env["IOTHUB_SUBSCRIPTION_ID"] || "91d12660-3dec-467a-be2a-213b5544ddc0";
  const iotHubName = "testHub";
  const resourceGroupName = process.env["IOTHUB_RESOURCE_GROUP"] || "myResourceGroup";
  const input = {
    message: {
      appProperties: { key1: "value1" },
      body: "Body of message",
      systemProperties: { key1: "value1" },
    },
    route: {
      name: "Routeid",
      endpointNames: ["id1"],
      isEnabled: true,
      source: "DeviceMessages",
    },
  };
  const credential = new DefaultAzureCredential();
  const client = new IotHubClient(credential, subscriptionId);
  const result = await client.iotHubResource.testRoute(iotHubName, resourceGroupName, input);
  console.log(result);
}

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_testnewroute.json
// this example is just showing the usage of "IotHubResource_TestRoute" 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
IotHubTestRouteContent content = new IotHubTestRouteContent(new RoutingRuleProperties("Routeid", IotHubRoutingSource.DeviceMessages, new string[]
{
"id1"
}, true))
{
    Message = new RoutingMessage()
    {
        Body = "Body of message",
        AppProperties =
        {
        ["key1"] = "value1",
        },
        SystemProperties =
        {
        ["key1"] = "value1",
        },
    },
};
IotHubTestRouteResult result = await iotHubDescription.TestRouteAsync(content);

Console.WriteLine($"Succeeded: {result}");

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

応答のサンプル

状態コード:

200

{
  "result": "false",
  "details": {
    "compilationErrors": [
      {
        "message": "string response",
        "severity": "error",
        "location": {
          "start": {
            "line": 12,
            "column": 12
          },
          "end": {
            "line": 12,
            "column": 24
          }
        }
      }
    ]
  }
}

定義

名前	説明
ErrorDetails	エラーの詳細。
Properties
RouteCompilationError	ルートを評価するときのコンパイル エラー
RouteErrorPosition	ルート エラーが発生した位置
RouteErrorRange	ルート エラーの範囲
RouteErrorSeverity	ルート エラーの重大度
RouteProperties	IoT ハブがエンドポイントにメッセージをルーティングするために使用するルーティング規則のプロパティ。
RoutingMessage	ルーティング メッセージ
RoutingSource	ルーティング規則を適用するソース (DeviceMessages など)。
RoutingTwin	ツイン参照入力パラメーター。 これは省略可能なパラメーターです
TestResultStatus	テスト ルートの結果
TestRouteInput	テスト ルートの入力
TestRouteResult	1 つのルートをテストした結果
TestRouteResultDetails	ルートのテストの詳細な結果

ErrorDetails

Object

エラーの詳細。

名前	型	説明
code	string	エラー コード。
details	string	エラーの詳細。
httpStatusCode	string	HTTP 状態コード。
message	string	エラー メッセージ。

Properties

Object

名前	型	説明
desired	object	両方の望ましい特性
reported	object	両方の望ましい特性

RouteCompilationError

Object

ルートを評価するときのコンパイル エラー

名前	型	説明
location	RouteErrorRange	ルート エラーが発生した場所
message	string	ルート エラー メッセージ
severity	RouteErrorSeverity	ルート エラーの重大度

RouteErrorPosition

Object

ルート エラーが発生した位置

名前	型	説明
column	integer (int32)	ルート エラーが発生した列
line	integer (int32)	ルート エラーが発生した行

RouteErrorRange

Object

ルート エラーの範囲

名前	型	説明
end	RouteErrorPosition	ルート エラーが発生した場所を終了する
start	RouteErrorPosition	ルート エラーが発生した場所を開始する

RouteErrorSeverity

列挙

ルート エラーの重大度

値	説明
error
warning

RouteProperties

Object

IoT ハブがエンドポイントにメッセージをルーティングするために使用するルーティング規則のプロパティ。

名前	型	説明
condition	string	ルーティング規則を適用するために評価される条件。 条件が指定されていない場合は、既定で true に評価されます。 文法については、「https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language」を参照してください。
endpointNames	string[]	条件を満たすメッセージがルーティングされるエンドポイントの一覧。 現在、許可されているエンドポイントは 1 つだけです。
isEnabled	boolean	ルートを有効にするかどうかを指定するために使用します。
name	string pattern: ^[A-Za-z0-9-._]{1,64}$	ルートの名前。 名前には、英数字、ピリオド、アンダースコア、ハイフンのみを含めることができます。最大長は 64 文字で、一意である必要があります。
source	RoutingSource	ルーティング規則を適用するソース (DeviceMessages など)。

RoutingMessage

Object

ルーティング メッセージ

名前	型	説明
appProperties	object	アプリのプロパティ
body	string	ルーティング メッセージの本文
systemProperties	object	システム プロパティ

RoutingSource

列挙

ルーティング規則を適用するソース (DeviceMessages など)。

値	説明
DeviceConnectionStateEvents
DeviceJobLifecycleEvents
DeviceLifecycleEvents
DeviceMessages
Invalid
TwinChangeEvents

RoutingTwin

Object

ツイン参照入力パラメーター。 これは省略可能なパラメーターです

名前	型	説明
properties	Properties
tags	object	ツイン タグ

TestResultStatus

列挙

テスト ルートの結果

値	説明
false
true
undefined

TestRouteInput

Object

テスト ルートの入力

名前	型	説明
message	RoutingMessage	ルーティング メッセージ
route	RouteProperties	ルートのプロパティ
twin	RoutingTwin	ルーティング ツインリファレンス

TestRouteResult

Object

1 つのルートをテストした結果

名前	型	説明
details	TestRouteResultDetails	テスト ルートの詳細な結果
result	TestResultStatus	テスト ルートの結果

TestRouteResultDetails

Object

ルートのテストの詳細な結果

名前	型	説明
compilationErrors	RouteCompilationError[]	ルート コンパイル エラーの JSON シリアル化された一覧