Iot Hub Resource - Test Route

Služba:

IoT Hub

Verze rozhraní API:

2023-06-30

Otestování nové trasy pro tuto službu Iot Hub

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{iotHubName}/routing/routes/$testnew?api-version=2023-06-30

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
iotHubName	path	True	string	IotHub, který se má testovat
resourceGroupName	path	True	string	skupina prostředků, do které iot Hub patří
subscriptionId	path	True	string	Identifikátor předplatného.
api-version	query	True	string	Verze rozhraní API.

Text požadavku

Name	Vyžadováno	Typ	Description
route	True	RouteProperties	Vlastnosti trasy
message		RoutingMessage	Směrovací zpráva
twin		RoutingTwin	Referenční informace ke dvojčeti směrování

Odpovědi

Name	Typ	Description
200 OK	TestRouteResult	OK
Other Status Codes	ErrorDetails	DefaultErrorResponse

Zabezpečení

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

IotHubResource_TestRoute

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:

200

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

Definice

Name	Description
ErrorDetails	Podrobnosti o chybě
Properties
RouteCompilationError	Chyba kompilace při vyhodnocování trasy
RouteErrorPosition	Pozice, kde došlo k chybě trasy
RouteErrorRange	Rozsah chyb tras
RouteErrorSeverity	Závažnost chyby trasy
RouteProperties	Vlastnosti pravidla směrování, které vaše centrum IoT používá ke směrování zpráv do koncových bodů.
RoutingMessage	Směrovací zpráva
RoutingSource	Zdroj, na který se má pravidlo směrování použít, například DeviceMessages.
RoutingTwin	Vstupní parametr odkazu dvojčete. Toto je volitelný parametr.
TestResultStatus	Výsledek testovací trasy
TestRouteInput	Vstup pro testovací trasu
TestRouteResult	Výsledek testování jedné trasy
TestRouteResultDetails	Podrobný výsledek testování trasy

ErrorDetails

Objekt

Podrobnosti o chybě

Name	Typ	Description
code	string	Kód chyby.
details	string	Podrobnosti o chybě.
httpStatusCode	string	Stavový kód HTTP.
message	string	Chybová zpráva.

Properties

Objekt

Name	Typ	Description
desired	object	Požadované vlastnosti dvojčete
reported	object	Požadované vlastnosti dvojčete

RouteCompilationError

Objekt

Chyba kompilace při vyhodnocování trasy

Name	Typ	Description
location	RouteErrorRange	Umístění, kde došlo k chybě trasy
message	string	Chybová zpráva směrování
severity	RouteErrorSeverity	Závažnost chyby trasy

RouteErrorPosition

Objekt

Pozice, kde došlo k chybě trasy

Name	Typ	Description
column	integer (int32)	Sloupec, ve kterém došlo k chybě trasy
line	integer (int32)	Řádek, kde došlo k chybě trasy

RouteErrorRange

Objekt

Rozsah chyb tras

Name	Typ	Description
end	RouteErrorPosition	Konec místa, kde došlo k chybě trasy
start	RouteErrorPosition	Spuštění, kde došlo k chybě trasy

RouteErrorSeverity

Výčet

Závažnost chyby trasy

Hodnota	Description
error
warning

RouteProperties

Objekt

Vlastnosti pravidla směrování, které vaše centrum IoT používá ke směrování zpráv do koncových bodů.

Name	Typ	Description
condition	string	Podmínka, která se vyhodnotí jako použití pravidla směrování. Pokud není zadanou podmínkou, vyhodnotí se ve výchozím nastavení jako true. Gramatiku najdete v tématu: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language
endpointNames	string[]	Seznam koncových bodů, do kterých se směrují zprávy, které splňují podmínku. Aktuálně je povolený jenom jeden koncový bod.
isEnabled	boolean	Slouží k určení, jestli je povolená trasa.
name	string pattern: ^[A-Za-z0-9-._]{1,64}$	Název trasy. Název může obsahovat pouze alfanumerické znaky, tečky, podtržítka, pomlčky, maximální délku 64 znaků a musí být jedinečný.
source	RoutingSource	Zdroj, na který se má pravidlo směrování použít, například DeviceMessages.

RoutingMessage

Objekt

Směrovací zpráva

Name	Typ	Description
appProperties	object	Vlastnosti aplikace
body	string	Text zprávy směrování
systemProperties	object	Systémové vlastnosti

RoutingSource

Výčet

Zdroj, na který se má pravidlo směrování použít, například DeviceMessages.

Hodnota	Description
Invalid
DeviceMessages
TwinChangeEvents
DeviceLifecycleEvents
DeviceJobLifecycleEvents
DeviceConnectionStateEvents

RoutingTwin

Objekt

Vstupní parametr odkazu dvojčete. Toto je volitelný parametr.

Name	Typ	Description
properties	Properties
tags	object	Značky dvojčat

TestResultStatus

Výčet

Výsledek testovací trasy

Hodnota	Description
undefined
false
true

TestRouteInput

Objekt

Vstup pro testovací trasu

Name	Typ	Description
message	RoutingMessage	Směrovací zpráva
route	RouteProperties	Vlastnosti trasy
twin	RoutingTwin	Referenční informace ke dvojčeti směrování

TestRouteResult

Objekt

Výsledek testování jedné trasy

Name	Typ	Description
details	TestRouteResultDetails	Podrobný výsledek testovací trasy
result	TestResultStatus	Výsledek testovací trasy

TestRouteResultDetails

Objekt

Podrobný výsledek testování trasy

Name	Typ	Description
compilationErrors	RouteCompilationError[]	Serializovaný seznam chyb kompilace tras ve formátu JSON