Iot Hub Resource - Test All Routes
この IoT ハブで構成されているすべてのルートをテストする
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{iotHubName}/routing/routes/$testall?api-version=2023-06-30
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
iot
|
path | True |
string |
テストする IotHub |
resource
|
path | True |
string |
Iot Hub が属するリソース グループ |
subscription
|
path | True |
string |
サブスクリプションの識別子です。 |
api-version
|
query | True |
string |
API のバージョン。 |
要求本文
名前 | 型 | 説明 |
---|---|---|
message |
ルーティング メッセージ |
|
routingSource |
ルーティング ソース |
|
twin |
ルーティング ツイン リファレンス |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
OK |
|
Other Status Codes |
DefaultErrorResponse |
セキュリティ
azure_auth
Azure Active Directory OAuth2 フロー
型:
oauth2
フロー:
implicit
Authorization URL (承認 URL):
https://login.microsoftonline.com/common/oauth2/authorize
スコープ
名前 | 説明 |
---|---|
user_impersonation | ユーザー アカウントの借用 |
例
IotHubResource_TestAllRoutes
要求のサンプル
POST https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub/routing/routes/$testall?api-version=2023-06-30
{
"routingSource": "DeviceMessages",
"message": {
"body": "Body of message",
"appProperties": {
"key1": "value1"
},
"systemProperties": {
"key1": "value1"
}
}
}
応答のサンプル
{
"routes": [
{
"properties": {
"name": "Routeid",
"source": "DeviceMessages",
"endpointNames": [
"id1"
],
"isEnabled": true
}
}
]
}
定義
名前 | 説明 |
---|---|
Error |
エラーの詳細。 |
Matched |
一致したルート |
Properties | |
Route |
IoT ハブがエンドポイントにメッセージをルーティングするために使用するルーティング規則のプロパティ。 |
Routing |
ルーティング メッセージ |
Routing |
ルーティング規則を適用するソース (DeviceMessages など)。 |
Routing |
ツイン参照入力パラメーター。 これは省略可能なパラメーターです |
Test |
すべてのルートをテストするための入力 |
Test |
すべてのルートをテストした結果 |
ErrorDetails
エラーの詳細。
名前 | 型 | 説明 |
---|---|---|
code |
string |
エラー コード。 |
details |
string |
エラーの詳細です。 |
httpStatusCode |
string |
HTTP 状態コード。 |
message |
string |
エラー メッセージ。 |
MatchedRoute
一致したルート
名前 | 型 | 説明 |
---|---|---|
properties |
一致したルートのプロパティ |
Properties
名前 | 型 | 説明 |
---|---|---|
desired |
object |
デバイス ツインの必要なプロパティ |
reported |
object |
デバイス ツインの必要なプロパティ |
RouteProperties
IoT ハブがエンドポイントにメッセージをルーティングするために使用するルーティング規則のプロパティ。
名前 | 型 | 説明 |
---|---|---|
condition |
string |
ルーティング規則を適用するために評価される条件。 条件が指定されていない場合、既定では true と評価されます。 文法については、次を参照してください。 https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language |
endpointNames |
string[] |
条件を満たすメッセージがルーティングされるエンドポイントの一覧。 現在、許可されているエンドポイントは 1 つだけです。 |
isEnabled |
boolean |
ルートを有効にするかどうかを指定するために使用します。 |
name |
string |
ルートの名前。 名前には、英数字、ピリオド、アンダースコア、ハイフンのみを含めることができます。最大長は 64 文字で、一意である必要があります。 |
source |
ルーティング規則を適用するソース (DeviceMessages など)。 |
RoutingMessage
ルーティング メッセージ
名前 | 型 | 説明 |
---|---|---|
appProperties |
object |
アプリのプロパティ |
body |
string |
ルーティング メッセージの本文 |
systemProperties |
object |
システム プロパティ |
RoutingSource
ルーティング規則を適用するソース (DeviceMessages など)。
名前 | 型 | 説明 |
---|---|---|
DeviceConnectionStateEvents |
string |
|
DeviceJobLifecycleEvents |
string |
|
DeviceLifecycleEvents |
string |
|
DeviceMessages |
string |
|
Invalid |
string |
|
TwinChangeEvents |
string |
RoutingTwin
ツイン参照入力パラメーター。 これは省略可能なパラメーターです
名前 | 型 | 説明 |
---|---|---|
properties | ||
tags |
object |
ツイン タグ |
TestAllRoutesInput
すべてのルートをテストするための入力
名前 | 型 | 説明 |
---|---|---|
message |
ルーティング メッセージ |
|
routingSource |
ルーティング ソース |
|
twin |
ルーティング ツイン リファレンス |
TestAllRoutesResult
すべてのルートをテストした結果
名前 | 型 | 説明 |
---|---|---|
routes |
一致するルートの JSON シリアル化された配列 |