Megosztás a következőn keresztül:


Iot Hub Resource - Test Route

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

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

Mintaválasz

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