Compartilhar via

az iot hub route

  • Preterido
  • Referência

Esse grupo de comandos foi preterido e será removido em uma versão futura. Em vez disso, use 'IoT Extension (azure-iot) message-route command group (az iot hub message-route)'.

Gerenciar rotas de um Hub IoT.

Comandos

Nome Description Tipo Status
az iot hub route create

Crie uma rota no Hub IoT.

 Núcleo Preterido
az iot hub route delete

Exclua toda a rota mencionada ou mencionada para seu Hub IoT.

 Núcleo Preterido
az iot hub route list

Obtenha todas as rotas no Hub IoT.

 Núcleo Preterido
az iot hub route show

Obtenha informações sobre a rota no Hub IoT.

 Núcleo Preterido
az iot hub route test

Teste todas as rotas ou rotas mencionadas no Hub IoT.

 Núcleo Preterido
az iot hub route update

Atualizar uma rota no Hub IoT.

 Núcleo Preterido

az iot hub route create

Editar
Preterido

Esse comando foi preterido implicitamente porque o grupo de comandos 'rota do hub iot' foi preterido e será removido em uma versão futura. Em vez disso, use 'IoT Extension (azure-iot) message-route command group (az iot hub message-route)'.

Crie uma rota no Hub IoT.

Crie uma rota para enviar uma fonte de dados e uma condição específicas para um ponto de extremidade desejado.

az iot hub route create --en
                        --hub-name
                        --name
                        --source {deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents}
                        [--condition]
                        [--enabled {false, true}]
                        [--resource-group]

Exemplos

Crie uma nova rota "R1".

az iot hub route create -g MyResourceGroup --hub-name MyIotHub --endpoint-name E2 --source DeviceMessages --route-name R1

Crie uma nova rota "R1" com todos os parâmetros.

az iot hub route create -g MyResourceGroup --hub-name MyIotHub --endpoint-name E2 --source DeviceMessages --route-name R1 --condition true --enabled true

Parâmetros Exigidos

--en --endpoint --endpoint-name

Nome do ponto de extremidade de roteamento.

--hub-name

Nome do Hub IoT.

--name --route-name -n

Nome da rota.

--source --source-type --type -s

Origem da rota.

Valores aceitos: deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents

Parâmetros Opcionais

--condition -c

Condição avaliada para aplicar a regra de roteamento.

--enabled -e

Um booleano indicando se a rota para o hub Iot deve ser habilitada.

Valores aceitos: false, true
--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az iot hub route delete

Editar
Preterido

Esse comando foi preterido implicitamente porque o grupo de comandos 'rota do hub iot' foi preterido e será removido em uma versão futura. Em vez disso, use 'IoT Extension (azure-iot) message-route command group (az iot hub message-route)'.

Exclua toda a rota mencionada ou mencionada para seu Hub IoT.

Exclua uma rota ou todas as rotas do seu Hub IoT.

az iot hub route delete [--hub-name]
                        [--ids]
                        [--name]
                        [--resource-group]
                        [--source {deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents}]
                        [--subscription]

Exemplos

Exclua a rota "R1" do Hub IoT "MyIotHub".

az iot hub route delete -g MyResourceGroup --hub-name MyIotHub --route-name R1

Exclua todas as rotas do tipo de origem "DeviceMessages" do Hub IoT "MyIotHub".

az iot hub route delete -g MyResourceGroup --hub-name MyIotHub --source DeviceMessages

Exclua todas as rotas do Hub IoT "MyIotHub".

az iot hub route delete -g MyResourceGroup --hub-name MyIotHub

Parâmetros Opcionais

--hub-name

Nome do Hub IoT.

--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'Resource Id'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

--name --route-name -n

Nome da rota.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--source --source-type --type -s

Origem da rota.

Valores aceitos: deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents
--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az iot hub route list

Editar
Preterido

Esse comando foi preterido implicitamente porque o grupo de comandos 'rota do hub iot' foi preterido e será removido em uma versão futura. Em vez disso, use 'IoT Extension (azure-iot) message-route command group (az iot hub message-route)'.

Obtenha todas as rotas no Hub IoT.

Obtenha informações sobre todas as rotas a partir de um Hub IoT.

az iot hub route list [--hub-name]
                      [--ids]
                      [--resource-group]
                      [--source {deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents}]
                      [--subscription]

Exemplos

Obtenha todas as rotas do Hub IoT "MyIotHub".

az iot hub route list -g MyResourceGroup --hub-name MyIotHub

Obtenha todas as rotas do tipo de origem "DeviceMessages" do Hub IoT "MyIotHub".

az iot hub route list -g MyResourceGroup --hub-name MyIotHub --source DeviceMessages

Parâmetros Opcionais

--hub-name

Nome do Hub IoT.

--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'Resource Id'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--source --source-type --type -s

Origem da rota.

Valores aceitos: deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents
--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az iot hub route show

Editar
Preterido

Esse comando foi preterido implicitamente porque o grupo de comandos 'rota do hub iot' foi preterido e será removido em uma versão futura. Em vez disso, use 'IoT Extension (azure-iot) message-route command group (az iot hub message-route)'.

Obtenha informações sobre a rota no Hub IoT.

Obtenha informações sobre uma rota específica em seu Hub IoT.

az iot hub route show --name
                      [--hub-name]
                      [--ids]
                      [--resource-group]
                      [--subscription]

Exemplos

Obtenha informações de rota do Hub IoT "MyIotHub".

az iot hub route show -g MyResourceGroup --hub-name MyIotHub --route-name {routeName}

Parâmetros Exigidos

--name --route-name -n

Nome da rota.

Parâmetros Opcionais

--hub-name

Nome do Hub IoT.

--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'Resource Id'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az iot hub route test

Editar
Preterido

Esse comando foi preterido implicitamente porque o grupo de comandos 'rota do hub iot' foi preterido e será removido em uma versão futura. Em vez disso, use 'IoT Extension (azure-iot) message-route command group (az iot hub message-route)'.

Teste todas as rotas ou rotas mencionadas no Hub IoT.

Teste todas as rotas existentes ou mencionadas em seu Hub IoT. Você pode fornecer uma mensagem de exemplo para testar suas rotas.

az iot hub route test [--ap]
                      [--body]
                      [--hub-name]
                      [--ids]
                      [--name]
                      [--resource-group]
                      [--source {deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents}]
                      [--sp]
                      [--subscription]

Exemplos

Teste a rota "R1" do Hub IoT "MyIotHub".

az iot hub route test -g MyResourceGroup --hub-name MyIotHub --route-name R1

Teste toda a rota do tipo de origem "DeviceMessages" do Hub IoT "MyIotHub".

az iot hub route test -g MyResourceGroup --hub-name MyIotHub --source DeviceMessages

Parâmetros Opcionais

--ap --app-properties

Propriedades do aplicativo da mensagem de rota.

--body -b

Corpo da mensagem de rota.

--hub-name

Nome do Hub IoT.

--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'Resource Id'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

--name --route-name -n

Nome da rota.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--source --source-type --type -s

Origem da rota.

Valores aceitos: deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents
--sp --system-properties

Propriedades do sistema da mensagem de rota.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az iot hub route update

Editar
Preterido

Esse comando foi preterido implicitamente porque o grupo de comandos 'rota do hub iot' foi preterido e será removido em uma versão futura. Em vez disso, use 'IoT Extension (azure-iot) message-route command group (az iot hub message-route)'.

Atualizar uma rota no Hub IoT.

Atualiza uma rota no Hub IoT. Você pode alterar a origem, o ponto de extremidade ou a consulta na rota.

az iot hub route update --name
                        [--condition]
                        [--en]
                        [--enabled {false, true}]
                        [--hub-name]
                        [--ids]
                        [--resource-group]
                        [--source {deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents}]
                        [--subscription]

Exemplos

Atualize o tipo de origem da rota "R1" do Hub IoT "MyIotHub".

az iot hub route update -g MyResourceGroup --hub-name MyIotHub --source DeviceMessages --route-name R1

Parâmetros Exigidos

--name --route-name -n

Nome da rota.

Parâmetros Opcionais

--condition -c

Condição avaliada para aplicar a regra de roteamento.

--en --endpoint --endpoint-name

Nome do ponto de extremidade de roteamento.

--enabled -e

Um booleano indicando se a rota para o hub Iot deve ser habilitada.

Valores aceitos: false, true
--hub-name

Nome do Hub IoT.

--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'Resource Id'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--source --source-type --type -s

Origem da rota.

Valores aceitos: deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents
--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.