Partilhar via


Iot Hub Resource - Test All Routes

Testar todas as rotas configuradas neste Hub Iot

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

Parâmetros do URI

Name Em Necessário Tipo Description
iotHubName
path True

string

IotHub a testar

resourceGroupName
path True

string

grupo de recursos ao qual o Hub Iot pertence

subscriptionId
path True

string

O identificador da subscrição.

api-version
query True

string

A versão da API.

Corpo do Pedido

Name Tipo Description
message

RoutingMessage

Mensagem de encaminhamento

routingSource

RoutingSource

Origem de encaminhamento

twin

RoutingTwin

Referência de Duplos de Encaminhamento

Respostas

Name Tipo Description
200 OK

TestAllRoutesResult

OK

Other Status Codes

ErrorDetails

DefaultErrorResponse

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name Description
user_impersonation representar a sua conta de utilizador

Exemplos

IotHubResource_TestAllRoutes

Pedido de amostra

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

{
  "routingSource": "DeviceMessages",
  "message": {
    "body": "Body of message",
    "appProperties": {
      "key1": "value1"
    },
    "systemProperties": {
      "key1": "value1"
    }
  }
}

Resposta da amostra

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

Definições

Name Description
ErrorDetails

Detalhes do erro.

MatchedRoute

Rotas que correspondiam

Properties
RouteProperties

As propriedades de uma regra de encaminhamento que o hub IoT utiliza para encaminhar mensagens para pontos finais.

RoutingMessage

Mensagem de encaminhamento

RoutingSource

A origem à qual a regra de encaminhamento deve ser aplicada, como DeviceMessages.

RoutingTwin

Parâmetro de entrada de referência de duplo. Este é um parâmetro opcional

TestAllRoutesInput

Entrada para testar todas as rotas

TestAllRoutesResult

Resultado do teste de todas as rotas

ErrorDetails

Detalhes do erro.

Name Tipo Description
code

string

O código de erro.

details

string

Os detalhes do erro.

httpStatusCode

string

O código de estado HTTP.

message

string

A mensagem de erro.

MatchedRoute

Rotas que correspondiam

Name Tipo Description
properties

RouteProperties

Propriedades das rotas correspondentes

Properties

Name Tipo Description
desired

object

Propriedades pretendidas de duplos

reported

object

Propriedades pretendidas de duplos

RouteProperties

As propriedades de uma regra de encaminhamento que o hub IoT utiliza para encaminhar mensagens para pontos finais.

Name Tipo Description
condition

string

A condição que é avaliada para aplicar a regra de encaminhamento. Se não for fornecida nenhuma condição, é avaliada como verdadeira por predefinição. Para gramática, consulte: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language

endpointNames

string[]

A lista de pontos finais para os quais as mensagens que satisfazem a condição são encaminhadas. Atualmente, só é permitido um ponto final.

isEnabled

boolean

Utilizado para especificar se uma rota está ativada.

name

string

O nome da rota. O nome só pode incluir carateres alfanuméricos, períodos, sublinhados, hífenes, tem um comprimento máximo de 64 carateres e tem de ser exclusivo.

source

RoutingSource

A origem à qual a regra de encaminhamento deve ser aplicada, como DeviceMessages.

RoutingMessage

Mensagem de encaminhamento

Name Tipo Description
appProperties

object

Propriedades da aplicação

body

string

Corpo da mensagem de encaminhamento

systemProperties

object

Propriedades do sistema

RoutingSource

A origem à qual a regra de encaminhamento deve ser aplicada, como DeviceMessages.

Name Tipo Description
DeviceConnectionStateEvents

string

DeviceJobLifecycleEvents

string

DeviceLifecycleEvents

string

DeviceMessages

string

Invalid

string

TwinChangeEvents

string

RoutingTwin

Parâmetro de entrada de referência de duplo. Este é um parâmetro opcional

Name Tipo Description
properties

Properties

tags

object

Etiquetas Duplos

TestAllRoutesInput

Entrada para testar todas as rotas

Name Tipo Description
message

RoutingMessage

Mensagem de encaminhamento

routingSource

RoutingSource

Origem de encaminhamento

twin

RoutingTwin

Referência de Duplos de Encaminhamento

TestAllRoutesResult

Resultado do teste de todas as rotas

Name Tipo Description
routes

MatchedRoute[]

Matriz serializada JSON de rotas correspondidas