Compartilhar 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 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 Tipo Description
message

RoutingMessage

Mensagem de roteamento

routingSource

RoutingSource

Origem do roteamento

twin

RoutingTwin

Referência de gêmeo de roteamento

Respostas

Nome Tipo Description
200 OK

TestAllRoutesResult

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_TestAllRoutes

Solicitação de exemplo

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 de exemplo

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

Definições

Nome Description
ErrorDetails

Detalhes do erro.

MatchedRoute

Rotas correspondentes

Properties
RouteProperties

As propriedades de uma regra de roteamento que o 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

TestAllRoutesInput

Entrada para testar todas as rotas

TestAllRoutesResult

Resultado do teste de todas as rotas

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.

MatchedRoute

Rotas correspondentes

Nome Tipo Description
properties

RouteProperties

Propriedades de rotas que corresponderam

Properties

Nome Tipo Description
desired

object

Propriedades desejadas do gêmeo

reported

object

Propriedades desejadas do gêmeo

RouteProperties

As propriedades de uma regra de roteamento que o 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, pontos, 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 de gêmeo

TestAllRoutesInput

Entrada para testar todas as rotas

Nome Tipo Description
message

RoutingMessage

Mensagem de roteamento

routingSource

RoutingSource

Origem do roteamento

twin

RoutingTwin

Referência de gêmeo de roteamento

TestAllRoutesResult

Resultado do teste de todas as rotas

Nome Tipo Description
routes

MatchedRoute[]

Matriz serializada por JSON de rotas correspondentes