Condividi tramite


Iot Hub Resource - Test Route

Testare la nuova route per questo hub Iot

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
iotHubName
path True

string

IotHub da testare

resourceGroupName
path True

string

gruppo di risorse a cui appartiene l'hub Iot

subscriptionId
path True

string

L'identificatore della sottoscrizione.

api-version
query True

string

Versione dell'API.

Corpo della richiesta

Nome Necessario Tipo Descrizione
route True

RouteProperties

Proprietà della route

message

RoutingMessage

Messaggio di routing

twin

RoutingTwin

Riferimento ai dispositivi gemelli di routing

Risposte

Nome Tipo Descrizione
200 OK

TestRouteResult

Va bene

Other Status Codes

ErrorDetails

DefaultErrorResponse

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome Descrizione
user_impersonation rappresentare l'account utente

Esempio

IotHubResource_TestRoute

Esempio di richiesta

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

Risposta di esempio

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

Definizioni

Nome Descrizione
ErrorDetails

Dettagli errore.

Properties
RouteCompilationError

Errore di compilazione durante la valutazione della route

RouteErrorPosition

Posizione in cui si è verificato l'errore di route

RouteErrorRange

Intervallo di errori di route

RouteErrorSeverity

Gravità dell'errore di route

RouteProperties

Proprietà di una regola di routing usata dall'hub IoT per instradare i messaggi agli endpoint.

RoutingMessage

Messaggio di routing

RoutingSource

Origine a cui applicare la regola di routing, ad esempio DeviceMessages.

RoutingTwin

Parametro di input di riferimento gemello. Si tratta di un parametro facoltativo

TestResultStatus

Risultato della route di test

TestRouteInput

Input per il test della route

TestRouteResult

Risultato del test di una route

TestRouteResultDetails

Risultato dettagliato del test di una route

ErrorDetails

Dettagli errore.

Nome Tipo Descrizione
code

string

Codice di errore.

details

string

Dettagli dell'errore.

httpStatusCode

string

Codice di stato HTTP.

message

string

Messaggio di errore.

Properties

Nome Tipo Descrizione
desired

object

Proprietà desiderate del dispositivo gemello

reported

object

Proprietà desiderate del dispositivo gemello

RouteCompilationError

Errore di compilazione durante la valutazione della route

Nome Tipo Descrizione
location

RouteErrorRange

Posizione in cui si è verificato l'errore di route

message

string

Messaggio di errore di route

severity

RouteErrorSeverity

Gravità dell'errore di route

RouteErrorPosition

Posizione in cui si è verificato l'errore di route

Nome Tipo Descrizione
column

integer (int32)

Colonna in cui si è verificato l'errore di route

line

integer (int32)

Riga in cui si è verificato l'errore di route

RouteErrorRange

Intervallo di errori di route

Nome Tipo Descrizione
end

RouteErrorPosition

Terminare dove si è verificato l'errore di route

start

RouteErrorPosition

Iniziare da dove si è verificato l'errore di route

RouteErrorSeverity

Gravità dell'errore di route

Valore Descrizione
error
warning

RouteProperties

Proprietà di una regola di routing usata dall'hub IoT per instradare i messaggi agli endpoint.

Nome Tipo Descrizione
condition

string

Condizione valutata per applicare la regola di routing. Se non viene specificata alcuna condizione, restituisce true per impostazione predefinita. Per la grammatica, vedere: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language

endpointNames

string[]

Elenco di endpoint a cui vengono indirizzati i messaggi che soddisfano la condizione. Attualmente è consentito un solo endpoint.

isEnabled

boolean

Consente di specificare se una route è abilitata.

name

string

pattern: ^[A-Za-z0-9-._]{1,64}$

Nome della route. Il nome può includere solo caratteri alfanumerici, punti, caratteri di sottolineatura, trattini, ha una lunghezza massima di 64 caratteri e deve essere univoco.

source

RoutingSource

Origine a cui applicare la regola di routing, ad esempio DeviceMessages.

RoutingMessage

Messaggio di routing

Nome Tipo Descrizione
appProperties

object

Proprietà dell'app

body

string

Corpo del messaggio di routing

systemProperties

object

Proprietà del sistema

RoutingSource

Origine a cui applicare la regola di routing, ad esempio DeviceMessages.

Valore Descrizione
DeviceConnectionStateEvents
DeviceJobLifecycleEvents
DeviceLifecycleEvents
DeviceMessages
Invalid
TwinChangeEvents

RoutingTwin

Parametro di input di riferimento gemello. Si tratta di un parametro facoltativo

Nome Tipo Descrizione
properties

Properties

tags

object

Tag gemelli

TestResultStatus

Risultato della route di test

Valore Descrizione
false
true
undefined

TestRouteInput

Input per il test della route

Nome Tipo Descrizione
message

RoutingMessage

Messaggio di routing

route

RouteProperties

Proprietà della route

twin

RoutingTwin

Riferimento ai dispositivi gemelli di routing

TestRouteResult

Risultato del test di una route

Nome Tipo Descrizione
details

TestRouteResultDetails

Risultato dettagliato della route di test

result

TestResultStatus

Risultato della route di test

TestRouteResultDetails

Risultato dettagliato del test di una route

Nome Tipo Descrizione
compilationErrors

RouteCompilationError[]

Elenco serializzato JSON degli errori di compilazione della route