Iot Hub Resource - Test Route
Uji rute baru untuk Iot Hub ini
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{iotHubName}/routing/routes/$testnew?api-version=2023-06-30
Parameter URI
Nama | Dalam | Diperlukan | Jenis | Deskripsi |
---|---|---|---|---|
iot
|
path | True |
string |
IotHub yang akan diuji |
resource
|
path | True |
string |
grup sumber daya tempat Iot Hub berada |
subscription
|
path | True |
string |
Pengidentifikasi langganan. |
api-version
|
query | True |
string |
Versi API. |
Isi Permintaan
Nama | Diperlukan | Jenis | Deskripsi |
---|---|---|---|
route | True |
Properti rute |
|
message |
Pesan perutean |
||
twin |
Referensi Kembar Perutean |
Respons
Nama | Jenis | Deskripsi |
---|---|---|
200 OK |
OK |
|
Other Status Codes |
DefaultErrorResponse |
Keamanan
azure_auth
Alur OAuth2 Azure Active Directory
Jenis:
oauth2
Alur:
implicit
URL Otorisasi:
https://login.microsoftonline.com/common/oauth2/authorize
Cakupan
Nama | Deskripsi |
---|---|
user_impersonation | meniru akun pengguna Anda |
Contoh
IotHubResource_TestRoute
Permintaan sampel
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
}
}
Respon sampel
{
"result": "false",
"details": {
"compilationErrors": [
{
"message": "string response",
"severity": "error",
"location": {
"start": {
"line": 12,
"column": 12
},
"end": {
"line": 12,
"column": 24
}
}
}
]
}
}
Definisi
Nama | Deskripsi |
---|---|
Error |
Detail kesalahan. |
Properties | |
Route |
Kesalahan kompilasi saat mengevaluasi rute |
Route |
Posisi di mana kesalahan rute terjadi |
Route |
Rentang kesalahan rute |
Route |
Tingkat keparahan kesalahan rute |
Route |
Properti aturan perutean yang digunakan hub IoT Anda untuk merutekan pesan ke titik akhir. |
Routing |
Pesan perutean |
Routing |
Sumber tempat aturan perutean akan diterapkan, seperti DeviceMessages. |
Routing |
Parameter input referensi kembar. Ini adalah parameter opsional |
Test |
Hasil rute pengujian |
Test |
Input untuk rute pengujian |
Test |
Hasil pengujian satu rute |
Test |
Hasil terperinci dari pengujian rute |
ErrorDetails
Detail kesalahan.
Nama | Jenis | Deskripsi |
---|---|---|
code |
string |
Kode kesalahan. |
details |
string |
Detail kesalahan. |
httpStatusCode |
string |
Kode status HTTP. |
message |
string |
Pesan kesalahan. |
Properties
Nama | Jenis | Deskripsi |
---|---|---|
desired |
object |
Properti yang diinginkan Kembaran |
reported |
object |
Properti yang diinginkan Kembaran |
RouteCompilationError
Kesalahan kompilasi saat mengevaluasi rute
Nama | Jenis | Deskripsi |
---|---|---|
location |
Lokasi di mana kesalahan rute terjadi |
|
message |
string |
Pesan kesalahan rute |
severity |
Tingkat keparahan kesalahan rute |
RouteErrorPosition
Posisi di mana kesalahan rute terjadi
Nama | Jenis | Deskripsi |
---|---|---|
column |
integer |
Kolom tempat kesalahan rute terjadi |
line |
integer |
Baris tempat kesalahan rute terjadi |
RouteErrorRange
Rentang kesalahan rute
Nama | Jenis | Deskripsi |
---|---|---|
end |
Akhiri di mana kesalahan rute terjadi |
|
start |
Mulai di mana kesalahan rute terjadi |
RouteErrorSeverity
Tingkat keparahan kesalahan rute
Nama | Jenis | Deskripsi |
---|---|---|
error |
string |
|
warning |
string |
RouteProperties
Properti aturan perutean yang digunakan hub IoT Anda untuk merutekan pesan ke titik akhir.
Nama | Jenis | Deskripsi |
---|---|---|
condition |
string |
Kondisi yang dievaluasi untuk menerapkan aturan perutean. Jika tidak ada kondisi yang disediakan, kondisi akan mengevaluasi ke true secara default. Untuk tata bahasa, lihat: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language |
endpointNames |
string[] |
Daftar titik akhir tempat pesan yang memenuhi kondisi dirutekan. Saat ini hanya satu titik akhir yang diizinkan. |
isEnabled |
boolean |
Digunakan untuk menentukan apakah rute diaktifkan. |
name |
string |
Nama rute. Nama hanya dapat mencakup karakter alfanumerik, titik, garis bawah, tanda hubung, memiliki panjang maksimum 64 karakter, dan harus unik. |
source |
Sumber tempat aturan perutean akan diterapkan, seperti DeviceMessages. |
RoutingMessage
Pesan perutean
Nama | Jenis | Deskripsi |
---|---|---|
appProperties |
object |
Properti aplikasi |
body |
string |
Isi pesan perutean |
systemProperties |
object |
Properti sistem |
RoutingSource
Sumber tempat aturan perutean akan diterapkan, seperti DeviceMessages.
Nama | Jenis | Deskripsi |
---|---|---|
DeviceConnectionStateEvents |
string |
|
DeviceJobLifecycleEvents |
string |
|
DeviceLifecycleEvents |
string |
|
DeviceMessages |
string |
|
Invalid |
string |
|
TwinChangeEvents |
string |
RoutingTwin
Parameter input referensi kembar. Ini adalah parameter opsional
Nama | Jenis | Deskripsi |
---|---|---|
properties | ||
tags |
object |
Tag Kembar |
TestResultStatus
Hasil rute pengujian
Nama | Jenis | Deskripsi |
---|---|---|
false |
string |
|
true |
string |
|
undefined |
string |
TestRouteInput
Input untuk rute pengujian
Nama | Jenis | Deskripsi |
---|---|---|
message |
Pesan perutean |
|
route |
Properti rute |
|
twin |
Referensi Kembar Perutean |
TestRouteResult
Hasil pengujian satu rute
Nama | Jenis | Deskripsi |
---|---|---|
details |
Hasil terperinci dari rute pengujian |
|
result |
Hasil rute pengujian |
TestRouteResultDetails
Hasil terperinci dari pengujian rute
Nama | Jenis | Deskripsi |
---|---|---|
compilationErrors |
Daftar kesalahan kompilasi rute yang diserialisasikan JSON |