Iot Hub Resource - Test All Routes

Referensi

Service:: IoT Hub

API Version:: 2018-04-01

Uji semua rute yang dikonfigurasi di Iot Hub ini

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{iotHubName}/routing/routes/$testall?api-version=2018-04-01

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
iotHubName	path	True	string	IotHub yang akan diuji
resourceGroupName	path	True	string	grup sumber daya tempat Iot Hub berada
subscriptionId	path	True	string	Pengidentifikasi langganan.
api-version	query	True	string	Versi API.

Isi Permintaan

Nama	Jenis	Deskripsi
message	RoutingMessage	Pesan perutean
routingSource	RoutingSource	Sumber perutean
twin	RoutingTwin	Referensi Kembar Perutean

Respons

Nama	Jenis	Deskripsi
200 OK	TestAllRoutesResult	OK
Other Status Codes	ErrorDetails	DefaultErrorResponse

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory

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

Scopes

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

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

Definisi

Nama	Deskripsi
ErrorDetails	Detail kesalahan.
MatchedRoute	Rute yang cocok
Properties
RouteProperties	Properti aturan perutean yang digunakan hub IoT Anda untuk merutekan pesan ke titik akhir.
RoutingMessage	Pesan perutean
RoutingSource	Sumber tempat aturan perutean akan diterapkan, seperti DeviceMessages.
RoutingTwin	Parameter input referensi kembar. Ini adalah parameter opsional
TestAllRoutesInput	Input untuk menguji semua rute
TestAllRoutesResult	Hasil pengujian semua rute

ErrorDetails

Detail kesalahan.

Nama	Jenis	Deskripsi
code	string	Kode kesalahan.
details	string	Detail kesalahan.
httpStatusCode	string	Kode status HTTP.
message	string	Pesan kesalahan.

MatchedRoute

Rute yang cocok

Nama	Jenis	Deskripsi
properties	RouteProperties	Properti rute yang cocok

Properties

Nama	Jenis	Deskripsi
desiredProperties	object	Properti yang diinginkan Kembaran
reportedProperties	object	Properti yang diinginkan Kembaran

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	RoutingSource	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
DeviceJobLifecycleEvents	string
DeviceLifecycleEvents	string
DeviceMessages	string
Invalid	string
TwinChangeEvents	string

RoutingTwin

Parameter input referensi kembar. Ini adalah parameter opsional

Nama	Jenis	Deskripsi
properties	Properties
tags	object	Tag Kembar

TestAllRoutesInput

Input untuk menguji semua rute

Nama	Jenis	Deskripsi
message	RoutingMessage	Pesan perutean
routingSource	RoutingSource	Sumber perutean
twin	RoutingTwin	Referensi Kembar Perutean

TestAllRoutesResult

Hasil pengujian semua rute

Nama	Jenis	Deskripsi
routes	MatchedRoute[]	Array rute yang diserialisasikan JSON dari rute yang cocok