Iot Hub Resource - Test Route

Szolgáltatás:

IoT Hub

API-verzió:

2023-06-30

Az Iot Hub új útvonalának tesztelése

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
iotHubName	path	True	string	Tesztelendő IotHub
resourceGroupName	path	True	string	erőforráscsoport, amelyhez az Iot Hub tartozik
subscriptionId	path	True	string	Az előfizetés azonosítója.
api-version	query	True	string	Az API verziója.

Kérelem törzse

Name	Kötelező	Típus	Description
route	True	RouteProperties	Útvonal tulajdonságai
message		RoutingMessage	Útválasztási üzenet
twin		RoutingTwin	Útválasztási ikerpéldány referenciája

Válaszok

Name	Típus	Description
200 OK	TestRouteResult	OK
Other Status Codes	ErrorDetails	DefaultErrorResponse

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	felhasználói fiók megszemélyesítése

Példák

IotHubResource_TestRoute

Mintakérelem

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

Mintaválasz

Állapotkód:

200

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

Definíciók

Name	Description
ErrorDetails	Hiba részletei.
Properties
RouteCompilationError	Fordítási hiba az útvonal kiértékelésekor
RouteErrorPosition	Az útvonalhiba helye
RouteErrorRange	Útvonalhibák tartománya
RouteErrorSeverity	Az útvonalhiba súlyossága
RouteProperties	Egy útválasztási szabály tulajdonságai, amelyeket az IoT Hub az üzenetek végpontokra irányításához használ.
RoutingMessage	Útválasztási üzenet
RoutingSource	A forrás, amellyel az útválasztási szabályt alkalmazni kell, például DeviceMessages.
RoutingTwin	Ikerhivatkozás bemeneti paramétere. Ez egy nem kötelező paraméter
TestResultStatus	A tesztelési útvonal eredménye
TestRouteInput	Bemenet az útvonal teszteléséhez
TestRouteResult	Egy útvonal tesztelésének eredménye
TestRouteResultDetails	Útvonal tesztelésének részletes eredménye

ErrorDetails

Hiba részletei.

Name	Típus	Description
code	string	A hibakód.
details	string	A hiba részletei.
httpStatusCode	string	A HTTP-állapotkód.
message	string	A hibaüzenet.

Properties

Name	Típus	Description
desired	object	Ikerpéldány kívánt tulajdonságai
reported	object	Ikerpéldány kívánt tulajdonságai

RouteCompilationError

Fordítási hiba az útvonal kiértékelésekor

Name	Típus	Description
location	RouteErrorRange	Az útvonalhiba helyének helye
message	string	Útvonalhiba
severity	RouteErrorSeverity	Az útvonalhiba súlyossága

RouteErrorPosition

Az útvonalhiba helye

Name	Típus	Description
column	integer	Oszlop, ahol az útvonalhiba történt
line	integer	Vonal, ahol az útvonalhiba történt

RouteErrorRange

Útvonalhibák tartománya

Name	Típus	Description
end	RouteErrorPosition	Az útvonalhiba megszűnésének vége
start	RouteErrorPosition	Az útvonalhiba kiindulópontja

RouteErrorSeverity

Az útvonalhiba súlyossága

Name	Típus	Description
error	string
warning	string

RouteProperties

Egy útválasztási szabály tulajdonságai, amelyeket az IoT Hub az üzenetek végpontokra irányításához használ.

Name	Típus	Description
condition	string	Az útválasztási szabály alkalmazásához kiértékelt feltétel. Ha nincs megadva feltétel, alapértelmezés szerint true (igaz) értéket ad vissza. A nyelvhelyességről a következő témakörben olvashat: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language
endpointNames	string[]	Azon végpontok listája, amelyekhez a feltételnek megfelelő üzenetek vannak átirányítva. Jelenleg csak egy végpont engedélyezett.
isEnabled	boolean	Annak megadására szolgál, hogy engedélyezve van-e egy útvonal.
name	string	Az útvonal neve. A név csak alfanumerikus karaktereket, pontokat, aláhúzásjeleket, kötőjeleket tartalmazhat, legfeljebb 64 karakter hosszúságú lehet, és egyedinek kell lennie.
source	RoutingSource	A forrás, amellyel az útválasztási szabályt alkalmazni kell, például DeviceMessages.

RoutingMessage

Útválasztási üzenet

Name	Típus	Description
appProperties	object	Alkalmazás tulajdonságai
body	string	Útválasztási üzenet törzse
systemProperties	object	Rendszertulajdonságok

RoutingSource

A forrás, amellyel az útválasztási szabályt alkalmazni kell, például DeviceMessages.

Name	Típus	Description
DeviceConnectionStateEvents	string
DeviceJobLifecycleEvents	string
DeviceLifecycleEvents	string
DeviceMessages	string
Invalid	string
TwinChangeEvents	string

RoutingTwin

Ikerhivatkozás bemeneti paramétere. Ez egy nem kötelező paraméter

Name	Típus	Description
properties	Properties
tags	object	Ikercímkék

TestResultStatus

A tesztelési útvonal eredménye

Name	Típus	Description
false	string
true	string
undefined	string

TestRouteInput

Bemenet az útvonal teszteléséhez

Name	Típus	Description
message	RoutingMessage	Útválasztási üzenet
route	RouteProperties	Útvonal tulajdonságai
twin	RoutingTwin	Útválasztási ikerpéldány referenciája

TestRouteResult

Egy útvonal tesztelésének eredménye

Name	Típus	Description
details	TestRouteResultDetails	A tesztelési útvonal részletes eredménye
result	TestResultStatus	A tesztelési útvonal eredménye

TestRouteResultDetails

Útvonal tesztelésének részletes eredménye

Name	Típus	Description
compilationErrors	RouteCompilationError[]	Útvonal-fordítási hibák JSON-szerializált listája