Iot Hub Resource - Test All Routes

Başvuru

Service:: IoT Hub

API Version:: 2018-04-01

Bu IoT Hub'ında yapılandırılan tüm yolları test etme

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{iotHubName}/routing/routes/$testall?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 sürümü.

İstek Gövdesi

Name	Tür	Description
message	RoutingMessage	Yönlendirme iletisi
routingSource	RoutingSource	Yönlendirme kaynağı
twin	RoutingTwin	Yönlendirme İkizi Başvurusu

Yanıtlar

Name	Tür	Description
200 OK	TestAllRoutesResult	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_TestAllRoutes

Sample Request

HTTP

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

{
  "routingSource": "DeviceMessages",
  "message": {
    "body": "Body of message",
    "appProperties": "App Properties",
    "systemProperties": "System Properties"
  }
}

Sample Response

Status code:: 200

{
  "routes": [
    {
      "properties": {
        "name": "Routeid",
        "source": "DeviceMessages",
        "endpointNames": [
          "id1"
        ],
        "isEnabled": true
      }
    }
  ]
}

Tanımlar

Name	Description
ErrorDetails	Hata ayrıntıları.
MatchedRoute	Eşleşen yollar
Properties
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
TestAllRoutesInput	Tüm yolları test etme girişi
TestAllRoutesResult	Tüm yolları test etme sonucu

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.

MatchedRoute

Eşleşen yollar

Name	Tür	Description
properties	RouteProperties	Eşleşen yolların özellikleri

Properties

Name	Tür	Description
desiredProperties	object	İkiz istenen özellikler
reportedProperties	object	İkiz istenen özellikler

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 etkinleştirilip etkinleştirilmediğini belirtmek için kullanılır.
name	string	Yolun adı. Ad yalnızca alfasayısal karakterler, nokta, alt çizgi, kısa çizgi içerebilir, en fazla 64 karakter uzunluğundadır 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

TestAllRoutesInput

Tüm yolları test etme girişi

Name	Tür	Description
message	RoutingMessage	Yönlendirme iletisi
routingSource	RoutingSource	Yönlendirme kaynağı
twin	RoutingTwin	Yönlendirme İkizi Başvurusu

TestAllRoutesResult

Tüm yolları test etme sonucu

Name	Tür	Description
routes	MatchedRoute[]	Eşleşen yolların JSON serileştirilmiş dizisi