Iot Hub Resource - Test Route

Teste a nova rota para este Hub Iot

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

Parâmetros do URI

Nome Em Obrigatório Tipo Descrição
iotHubName
path True

string

resourceGroupName
path True

string

minLength: 1
maxLength: 90

O nome do grupo de recursos. O nome não faz distinção entre maiúsculas e minúsculas.

subscriptionId
path True

string (uuid)

O ID da assinatura de destino. O valor deve ser um UUID.

api-version
query True

string

minLength: 1

A versão da API a utilizar para esta operação.

Corpo do Pedido

Nome Obrigatório Tipo Descrição
route True

RouteProperties

Propriedades da rota

message

RoutingMessage

Mensagem de roteamento

twin

RoutingTwin

Referência de gêmeos de roteamento

Respostas

Nome Tipo Descrição
200 OK

TestRouteResult

Operação do Azure concluída com sucesso.

Other Status Codes

ErrorDetails

Uma resposta de erro inesperada.

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

Nome Descrição
user_impersonation assumir a identidade da sua conta de utilizador

Exemplos

IotHubResource_TestRoute

Pedido de amostra

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

{
  "message": {
    "appProperties": {
      "key1": "value1"
    },
    "body": "Body of message",
    "systemProperties": {
      "key1": "value1"
    }
  },
  "route": {
    "name": "Routeid",
    "endpointNames": [
      "id1"
    ],
    "isEnabled": true,
    "source": "DeviceMessages"
  }
}

Resposta da amostra

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

Definições

Nome Descrição
ErrorDetails

Detalhes do erro.

RouteCompilationError

Erro de compilação ao avaliar a rota

RouteErrorPosition

Posição onde o erro de rota aconteceu

RouteErrorRange

Gama de erros de rota

RouteErrorSeverity

Gravidade do erro de rota

RouteProperties

As propriedades de uma regra de roteamento que seu hub IoT usa para rotear mensagens para pontos de extremidade.

RoutingMessage

Mensagem de roteamento

RoutingSource

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

RoutingTwin

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

RoutingTwinProperties
TestResultStatus

Resultado da rota de teste

TestRouteInput

Entrada para rota de teste

TestRouteResult

Resultado do teste de uma rota

TestRouteResultDetails

Resultado detalhado do teste de uma rota

ErrorDetails

Detalhes do erro.

Nome Tipo Descrição
code

string

O código de erro.

details

string

Os detalhes do erro.

httpStatusCode

string

O código de status HTTP.

message

string

A mensagem de erro.

RouteCompilationError

Erro de compilação ao avaliar a rota

Nome Tipo Descrição
location

RouteErrorRange

Local onde o erro de rota aconteceu

message

string

Mensagem de erro de rota

severity

RouteErrorSeverity

Gravidade do erro de rota

RouteErrorPosition

Posição onde o erro de rota aconteceu

Nome Tipo Descrição
column

integer (int32)

Coluna onde ocorreu o erro de rota

line

integer (int32)

Linha onde ocorreu o erro de rota

RouteErrorRange

Gama de erros de rota

Nome Tipo Descrição
end

RouteErrorPosition

Terminar onde o erro de rota aconteceu

start

RouteErrorPosition

Iniciar onde o erro de rota aconteceu

RouteErrorSeverity

Gravidade do erro de rota

Valor Descrição
error

erro

warning

aviso

RouteProperties

As propriedades de uma regra de roteamento que seu hub IoT usa para rotear mensagens para pontos de extremidade.

Nome Tipo Descrição
condition

string

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

endpointNames

string[]

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

isEnabled

boolean

Usado para especificar se uma rota está habilitada.

name

string

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

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

source

RoutingSource

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

RoutingMessage

Mensagem de roteamento

Nome Tipo Descrição
appProperties

object

Propriedades do aplicativo

body

string

Corpo da mensagem de roteamento

systemProperties

object

Propriedades do sistema

RoutingSource

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

Valor Descrição
Invalid

Inválido

DeviceMessages

DeviceMessages

TwinChangeEvents

TwinChangeEvents

DeviceLifecycleEvents

DeviceLifecycleEvents

DeviceJobLifecycleEvents

DeviceJobLifecycleEvents

DeviceConnectionStateEvents

DeviceConnectionStateEvents

RoutingTwin

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

Nome Tipo Descrição
properties

RoutingTwinProperties

tags

Tags gêmeas

RoutingTwinProperties

Nome Tipo Descrição
desired

Propriedades desejadas gêmeas

reported

Propriedades reportadas por gémeos

TestResultStatus

Resultado da rota de teste

Valor Descrição
undefined

indefinido

false

false

true

verdadeiro

TestRouteInput

Entrada para rota de teste

Nome Tipo Descrição
message

RoutingMessage

Mensagem de roteamento

route

RouteProperties

Propriedades da rota

twin

RoutingTwin

Referência de gêmeos de roteamento

TestRouteResult

Resultado do teste de uma rota

Nome Tipo Descrição
details

TestRouteResultDetails

Resultado detalhado da rota de teste

result

TestResultStatus

Resultado da rota de teste

TestRouteResultDetails

Resultado detalhado do teste de uma rota

Nome Tipo Descrição
compilationErrors

RouteCompilationError[]

Lista serializada por JSON de erros de compilação de rotas