Iot Hub Resource - Test Route
Bu IoT Hub için yeni yolu test edin
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{iotHubName}/routing/routes/$testnew?api-version=2023-06-30
URI Parametreleri
Name | İçinde | Gerekli | Tür | Description |
---|---|---|---|---|
iot
|
path | True |
string |
Test edilecek IotHub |
resource
|
path | True |
string |
IoT Hub'ın ait olduğu kaynak grubu |
subscription
|
path | True |
string |
Abonelik tanımlayıcısı. |
api-version
|
query | True |
string |
API'nin sürümü. |
İstek Gövdesi
Name | Gerekli | Tür | Description |
---|---|---|---|
route | True |
Yol özellikleri |
|
message |
Yönlendirme iletisi |
||
twin |
Yönlendirme İkizi Başvurusu |
Yanıtlar
Name | Tür | Description |
---|---|---|
200 OK |
Tamam |
|
Other Status Codes |
DefaultErrorResponse |
Güvenlik
azure_auth
Azure Active Directory OAuth2 Flow
Tür:
oauth2
Akış:
implicit
Yetkilendirme URL’si:
https://login.microsoftonline.com/common/oauth2/authorize
Kapsamlar
Name | Description |
---|---|
user_impersonation | kullanıcı hesabınızın kimliğine bürünme |
Örnekler
IotHubResource_TestRoute
Örnek isteği
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
}
}
Örnek yanıt
{
"result": "false",
"details": {
"compilationErrors": [
{
"message": "string response",
"severity": "error",
"location": {
"start": {
"line": 12,
"column": 12
},
"end": {
"line": 12,
"column": 24
}
}
}
]
}
}
Tanımlar
Name | Description |
---|---|
Error |
Hata ayrıntıları. |
Properties | |
Route |
Yol değerlendirilirken derleme hatası |
Route |
Yol hatasının oluştuğu konum |
Route |
Yol hataları aralığı |
Route |
Yol hatasının önem derecesi |
Route |
IoT hub'ınızın iletileri uç noktalara yönlendirmek için kullandığı yönlendirme kuralının özellikleri. |
Routing |
Yönlendirme iletisi |
Routing |
DeviceMessages gibi yönlendirme kuralının uygulanacağı kaynak. |
Routing |
İkiz başvuru giriş parametresi. Bu isteğe bağlı bir parametredir |
Test |
Test rotasının sonucu |
Test |
Test yolu için giriş |
Test |
Bir yolu test etme sonucu |
Test |
Bir yolu test etmeyle ilgili ayrıntılı sonuç |
ErrorDetails
Hata ayrıntıları.
Name | Tür | Description |
---|---|---|
code |
string |
Hata kodu. |
details |
string |
Hata ayrıntıları. |
httpStatusCode |
string |
HTTP durum kodu. |
message |
string |
Hata iletisi. |
Properties
Name | Tür | Description |
---|---|---|
desired |
object |
İkiz istenen özellikler |
reported |
object |
İkiz istenen özellikler |
RouteCompilationError
Yol değerlendirilirken derleme hatası
Name | Tür | Description |
---|---|---|
location |
Yol hatasının oluştuğu konum |
|
message |
string |
Yol hata iletisi |
severity |
Yol hatasının önem derecesi |
RouteErrorPosition
Yol hatasının oluştuğu konum
Name | Tür | Description |
---|---|---|
column |
integer |
Yol hatasının oluştuğu sütun |
line |
integer |
Yol hatasının oluştuğu satır |
RouteErrorRange
Yol hataları aralığı
Name | Tür | Description |
---|---|---|
end |
Yol hatasının oluştuğu son nokta |
|
start |
Yol hatasının oluştuğu yerden başlayın |
RouteErrorSeverity
Yol hatasının önem derecesi
Name | Tür | Description |
---|---|---|
error |
string |
|
warning |
string |
RouteProperties
IoT hub'ınızın iletileri uç noktalara yönlendirmek için kullandığı yönlendirme kuralının özellikleri.
Name | Tür | Description |
---|---|---|
condition |
string |
Yönlendirme kuralını uygulamak için değerlendirilen koşul. Koşul sağlanmazsa, varsayılan olarak true olarak değerlendirilir. Dil bilgisi için bkz: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language |
endpointNames |
string[] |
Koşulu karşılayan iletilerin yönlendirildiği uç noktaların listesi. Şu anda yalnızca bir uç noktaya izin verilir. |
isEnabled |
boolean |
Bir yolun etkin olup olmadığını belirtmek için kullanılır. |
name |
string |
Yolun adı. Ad yalnızca alfasayısal karakterler, nokta, alt çizgi, kısa çizgi içerebilir, uzunluk üst sınırı 64 karakterdir ve benzersiz olmalıdır. |
source |
DeviceMessages gibi yönlendirme kuralının uygulanacağı kaynak. |
RoutingMessage
Yönlendirme iletisi
Name | Tür | Description |
---|---|---|
appProperties |
object |
Uygulama özellikleri |
body |
string |
Yönlendirme iletisinin gövdesi |
systemProperties |
object |
Sistem özellikleri |
RoutingSource
DeviceMessages gibi yönlendirme kuralının uygulanacağı kaynak.
Name | Tür | Description |
---|---|---|
DeviceConnectionStateEvents |
string |
|
DeviceJobLifecycleEvents |
string |
|
DeviceLifecycleEvents |
string |
|
DeviceMessages |
string |
|
Invalid |
string |
|
TwinChangeEvents |
string |
RoutingTwin
İkiz başvuru giriş parametresi. Bu isteğe bağlı bir parametredir
Name | Tür | Description |
---|---|---|
properties | ||
tags |
object |
İkiz Etiketleri |
TestResultStatus
Test rotasının sonucu
Name | Tür | Description |
---|---|---|
false |
string |
|
true |
string |
|
undefined |
string |
TestRouteInput
Test yolu için giriş
Name | Tür | Description |
---|---|---|
message |
Yönlendirme iletisi |
|
route |
Yol özellikleri |
|
twin |
Yönlendirme İkizi Başvurusu |
TestRouteResult
Bir yolu test etme sonucu
Name | Tür | Description |
---|---|---|
details |
Test yolunun ayrıntılı sonucu |
|
result |
Test rotasının sonucu |
TestRouteResultDetails
Bir yolu test etmeyle ilgili ayrıntılı sonuç
Name | Tür | Description |
---|---|---|
compilationErrors |
JSON ile seri hale getirilmiş yol derleme hataları listesi |