Iot Hub Resource - Test Route

Service:

IoT Hub

API Version:

2018-04-01

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=2018-04-01

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
iotHubName	path	True	string	Test edilecek IotHub
resourceGroupName	path	True	string	IoT Hub'ın ait olduğu kaynak grubu
subscriptionId	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	RouteProperties	Yol özellikleri
message		RoutingMessage	Yönlendirme iletisi
twin		RoutingTwin	Yönlendirme İkizi Başvurusu

Yanıtlar

Name	Tür	Description
200 OK	TestRouteResult	Tamam
Other Status Codes	ErrorDetails	DefaultErrorResponse

Güvenlik

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	kullanıcı hesabınızın kimliğine bürünme

Örnekler

IotHubResource_TestRoute

Sample Request

HTTP

POST https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub/routing/routes/$testnew?api-version=2018-04-01

{
  "message": {
    "body": "Body of message",
    "appProperties": "App Properties",
    "systemProperties": "System Properties"
  },
  "route": {
    "name": "Routeid",
    "source": "DeviceMessages",
    "endpointNames": [
      "id1"
    ],
    "isEnabled": true
  }
}

Sample Response

Status code:

200

{
  "result": "false",
  "details": {
    "compilationErrors": [
      {
        "message": "string response",
        "severity": "error",
        "location": {
          "start": {
            "line": 12,
            "column": 12
          },
          "end": {
            "line": 12,
            "column": 24
          }
        }
      }
    ]
  }
}

Tanımlar

Name	Description
ErrorDetails	Hata ayrıntıları.
Properties
RouteCompilationError	Yol değerlendirilirken derleme hatası
RouteErrorPosition	Yol hatasının oluştuğu konum
RouteErrorRange	Yol hataları aralığı
RouteErrorSeverity	Yol hatasının önem derecesi
RouteProperties	IoT hub'ınızın iletileri uç noktalara yönlendirmek için kullandığı yönlendirme kuralının özellikleri.
RoutingMessage	Yönlendirme iletisi
RoutingSource	DeviceMessages gibi yönlendirme kuralının uygulanacağı kaynak.
RoutingTwin	İkiz başvuru giriş parametresi. Bu isteğe bağlı bir parametredir
TestResultStatus	Test rotasının sonucu
TestRouteInput	Test yolu için giriş
TestRouteResult	Bir yolu test etme sonucu
TestRouteResultDetails	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
desiredProperties	object	İkiz istenen özellikler
reportedProperties	object	İkiz istenen özellikler

RouteCompilationError

Yol değerlendirilirken derleme hatası

Name	Tür	Description
location	RouteErrorRange	Yol hatasının oluştuğu konum
message	string	Yol hata iletisi
severity	RouteErrorSeverity	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	RouteErrorPosition	Yol hatasının oluştuğu son nokta
start	RouteErrorPosition	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	RoutingSource	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
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	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	RoutingMessage	Yönlendirme iletisi
route	RouteProperties	Yol özellikleri
twin	RoutingTwin	Yönlendirme İkizi Başvurusu

TestRouteResult

Bir yolu test etme sonucu

Name	Tür	Description
details	TestRouteResultDetails	Test yolunun ayrıntılı sonucu
result	TestResultStatus	Test rotasının sonucu

TestRouteResultDetails

Bir yolu test etmeyle ilgili ayrıntılı sonuç

Name	Tür	Description
compilationErrors	RouteCompilationError[]	JSON ile seri hale getirilmiş yol derleme hataları listesi