Compartilhar via


Iot Hub Resource - Test Route

Testar 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=2023-06-30

Parâmetros de URI

Nome Em Obrigatório Tipo Description
iotHubName
path True

string

IotHub a ser testado

resourceGroupName
path True

string

grupo de recursos ao qual o Hub Iot pertence

subscriptionId
path True

string

O identificador da assinatura.

api-version
query True

string

A versão da API.

Corpo da solicitação

Nome Obrigatório Tipo Description
route True

RouteProperties

Propriedades de rota

message

RoutingMessage

Mensagem de roteamento

twin

RoutingTwin

Referência de gêmeo de roteamento

Respostas

Nome Tipo Description
200 OK

TestRouteResult

OK

Other Status Codes

ErrorDetails

DefaultErrorResponse

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory

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

Escopos

Nome Description
user_impersonation representar sua conta de usuário

Exemplos

IotHubResource_TestRoute

Solicitação de exemplo

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

Resposta de exemplo

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

Definições

Nome Description
ErrorDetails

Detalhes do erro.

Properties
RouteCompilationError

Erro de compilação ao avaliar a rota

RouteErrorPosition

Posição em que o erro de rota ocorreu

RouteErrorRange

Intervalo 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 de gêmeo. Esse é um parâmetro opcional

TestResultStatus

Resultado da rota de teste

TestRouteInput

Entrada para a rota de teste

TestRouteResult

Resultado do teste de uma rota

TestRouteResultDetails

Resultado detalhado do teste de uma rota

ErrorDetails

Detalhes do erro.

Nome Tipo Description
code

string

O código de erro.

details

string

Os detalhes do erro.

httpStatusCode

string

O código de status do HTTP.

message

string

A mensagem de erro.

Properties

Nome Tipo Description
desired

object

Propriedades desejadas do gêmeo

reported

object

Propriedades desejadas do gêmeo

RouteCompilationError

Erro de compilação ao avaliar a rota

Nome Tipo Description
location

RouteErrorRange

Local em que o erro de rota ocorreu

message

string

Mensagem de erro de rota

severity

RouteErrorSeverity

Gravidade do erro de rota

RouteErrorPosition

Posição em que o erro de rota ocorreu

Nome Tipo Description
column

integer

Coluna em que o erro de rota ocorreu

line

integer

Linha em que ocorreu o erro de rota

RouteErrorRange

Intervalo de erros de rota

Nome Tipo Description
end

RouteErrorPosition

Terminar onde o erro de rota ocorreu

start

RouteErrorPosition

Iniciar onde o erro de rota aconteceu

RouteErrorSeverity

Gravidade do erro de rota

Nome Tipo Description
error

string

warning

string

RouteProperties

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

Nome Tipo Description
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 atendem à condição são roteadas. Atualmente, apenas um ponto de extremidade é permitido.

isEnabled

boolean

Usado para especificar se uma rota está habilitada.

name

string

O nome da rota. O nome só pode incluir caracteres alfanuméricos, períodos, sublinhados, hifens, 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 Description
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.

Nome Tipo Description
DeviceConnectionStateEvents

string

DeviceJobLifecycleEvents

string

DeviceLifecycleEvents

string

DeviceMessages

string

Invalid

string

TwinChangeEvents

string

RoutingTwin

Parâmetro de entrada de referência de gêmeo. Esse é um parâmetro opcional

Nome Tipo Description
properties

Properties

tags

object

Marcas gêmeas

TestResultStatus

Resultado da rota de teste

Nome Tipo Description
false

string

true

string

undefined

string

TestRouteInput

Entrada para a rota de teste

Nome Tipo Description
message

RoutingMessage

Mensagem de roteamento

route

RouteProperties

Propriedades de rota

twin

RoutingTwin

Referência de gêmeo de roteamento

TestRouteResult

Resultado do teste de uma rota

Nome Tipo Description
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 Description
compilationErrors

RouteCompilationError[]

Lista serializada de JSON de erros de compilação de rota