次の方法で共有


Iot Hub Resource - Test Route

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

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

OK

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

要求のサンプル

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

応答のサンプル

{
  "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

エラーの詳細。

名前 説明
code

string

エラー コード。

details

string

エラーの詳細です。

httpStatusCode

string

HTTP 状態コード。

message

string

エラー メッセージ。

Properties

名前 説明
desired

object

デバイス ツインの必要なプロパティ

reported

object

デバイス ツインの必要なプロパティ

RouteCompilationError

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

名前 説明
location

RouteErrorRange

ルート エラーが発生した場所

message

string

ルート エラー メッセージ

severity

RouteErrorSeverity

ルート エラーの重大度

RouteErrorPosition

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

名前 説明
column

integer

ルート エラーが発生した列

line

integer

ルート エラーが発生した行

RouteErrorRange

ルート エラーの範囲

名前 説明
end

RouteErrorPosition

ルート エラーが発生した場所を終了する

start

RouteErrorPosition

ルート エラーが発生した場所を開始する

RouteErrorSeverity

ルート エラーの重大度

名前 説明
error

string

warning

string

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

RoutingSource

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

RoutingMessage

ルーティング メッセージ

名前 説明
appProperties

object

アプリのプロパティ

body

string

ルーティング メッセージの本文

systemProperties

object

システム プロパティ

RoutingSource

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

名前 説明
DeviceConnectionStateEvents

string

DeviceJobLifecycleEvents

string

DeviceLifecycleEvents

string

DeviceMessages

string

Invalid

string

TwinChangeEvents

string

RoutingTwin

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

名前 説明
properties

Properties

tags

object

ツイン タグ

TestResultStatus

テスト ルートの結果

名前 説明
false

string

true

string

undefined

string

TestRouteInput

テスト ルートの入力

名前 説明
message

RoutingMessage

ルーティング メッセージ

route

RouteProperties

ルートのプロパティ

twin

RoutingTwin

ルーティング ツイン リファレンス

TestRouteResult

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

名前 説明
details

TestRouteResultDetails

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

result

TestResultStatus

テスト ルートの結果

TestRouteResultDetails

ルートをテストした詳細な結果

名前 説明
compilationErrors

RouteCompilationError[]

JSON でシリアル化されたルート コンパイル エラーの一覧