Iot Hub Resource - Test Route

Service:

IoT Hub

API Version:

2023-06-30

Test the new route for this Iot Hub

HTTP

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

URI Parameters

Name	In	Required	Type	Description
iotHubName	path	True	string	IotHub to be tested
resourceGroupName	path	True	string	resource group which Iot Hub belongs to
subscriptionId	path	True	string	The subscription identifier.
api-version	query	True	string	The version of the API.

Request Body

Name	Required	Type	Description
route	True	RouteProperties	Route properties
message		RoutingMessage	Routing message
twin		RoutingTwin	Routing Twin Reference

Responses

Name	Type	Description
200 OK	TestRouteResult	OK
Other Status Codes	ErrorDetails	DefaultErrorResponse

Security

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	impersonate your user account

Examples

IotHubResource_TestRoute

Sample request

HTTP

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

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

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

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

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

C#

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

Sample response

Status code:

200

JSON

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

Definitions

Name	Description
ErrorDetails	Error details.
Properties
RouteCompilationError	Compilation error when evaluating route
RouteErrorPosition	Position where the route error happened
RouteErrorRange	Range of route errors
RouteErrorSeverity	Severity of the route error
RouteProperties	The properties of a routing rule that your IoT hub uses to route messages to endpoints.
RoutingMessage	Routing message
RoutingSource	The source that the routing rule is to be applied to, such as DeviceMessages.
RoutingTwin	Twin reference input parameter. This is an optional parameter
TestResultStatus	Result of testing route
TestRouteInput	Input for testing route
TestRouteResult	Result of testing one route
TestRouteResultDetails	Detailed result of testing a route

ErrorDetails

Object

Error details.

Name	Type	Description
code	string	The error code.
details	string	The error details.
httpStatusCode	string	The HTTP status code.
message	string	The error message.

Properties

Object

Name	Type	Description
desired	object	Twin desired properties
reported	object	Twin desired properties

RouteCompilationError

Object

Compilation error when evaluating route

Name	Type	Description
location	RouteErrorRange	Location where the route error happened
message	string	Route error message
severity	RouteErrorSeverity	Severity of the route error

RouteErrorPosition

Object

Position where the route error happened

Name	Type	Description
column	integer	Column where the route error happened
line	integer	Line where the route error happened

RouteErrorRange

Object

Range of route errors

Name	Type	Description
end	RouteErrorPosition	End where the route error happened
start	RouteErrorPosition	Start where the route error happened

RouteErrorSeverity

Enumeration

Severity of the route error

Value	Description
error
warning

RouteProperties

Object

The properties of a routing rule that your IoT hub uses to route messages to endpoints.

Name	Type	Description
condition	string	The condition that is evaluated to apply the routing rule. If no condition is provided, it evaluates to true by default. For grammar, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language
endpointNames	string[]	The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed.
isEnabled	boolean	Used to specify whether a route is enabled.
name	string	The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique.
source	RoutingSource	The source that the routing rule is to be applied to, such as DeviceMessages.

RoutingMessage

Object

Routing message

Name	Type	Description
appProperties	object	App properties
body	string	Body of routing message
systemProperties	object	System properties

RoutingSource

Enumeration

The source that the routing rule is to be applied to, such as DeviceMessages.

Value	Description
DeviceConnectionStateEvents
DeviceJobLifecycleEvents
DeviceLifecycleEvents
DeviceMessages
Invalid
TwinChangeEvents

RoutingTwin

Object

Twin reference input parameter. This is an optional parameter

Name	Type	Description
properties	Properties
tags	object	Twin Tags

TestResultStatus

Enumeration

Result of testing route

Value	Description
false
true
undefined

TestRouteInput

Object

Input for testing route

Name	Type	Description
message	RoutingMessage	Routing message
route	RouteProperties	Route properties
twin	RoutingTwin	Routing Twin Reference

TestRouteResult

Object

Result of testing one route

Name	Type	Description
details	TestRouteResultDetails	Detailed result of testing route
result	TestResultStatus	Result of testing route

TestRouteResultDetails

Object

Detailed result of testing a route

Name	Type	Description
compilationErrors	RouteCompilationError[]	JSON-serialized list of route compilation errors