az iot hub message-route

  • Versão Prévia
  • Referência

Observação

Essa referência faz parte da extensão azure-iot para a CLI do Azure (versão 2.37.0 ou superior). A extensão será instalada automaticamente na primeira vez que você executar um comando az iot hub message-route . Saiba mais sobre extensões.

Este grupo de comandos está em pré-visualização e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

Gerenciar rotas de um Hub IoT.

Comandos

Nome Description Tipo Status
az iot hub message-route create

Adicione uma rota para um Hub IoT.

 Extensão Versão Prévia
az iot hub message-route delete

Exclua todas as rotas ou uma rota mencionada em um Hub IoT.

 Extensão Versão Prévia
az iot hub message-route fallback

Gerenciar a rota de fallback de um hub IoT.

 Extensão Versão Prévia
az iot hub message-route fallback set

Habilite ou desabilite a rota de fallback em um Hub IoT.

 Extensão Versão Prévia
az iot hub message-route fallback show

Mostrar a rota de fallback de um Hub IoT.

 Extensão Versão Prévia
az iot hub message-route list

Obtenha todas as rotas em um Hub IoT.

 Extensão Versão Prévia
az iot hub message-route show

Obtenha informações sobre a rota em um Hub IoT.

 Extensão Versão Prévia
az iot hub message-route test

Teste todas as rotas ou uma rota mencionada em um Hub IoT.

 Extensão Versão Prévia
az iot hub message-route update

Atualize uma rota para um Hub IoT.

 Extensão Versão Prévia

az iot hub message-route create

Versão Prévia

O grupo de comandos 'iot hub message-route' está em pré-visualização e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

Adicione uma rota para um Hub IoT.

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

Exemplos

Crie uma rota para um Hub IoT com o ponto de extremidade e o tipo de origem "DeviceMessages" fornecidos.

az iot hub message-route create -n {iothub_name} --route-name {route_name} --endpoint-name {endpoint_name} --source DeviceMessages

Crie uma rota para um Hub IoT com o ponto de extremidade interno e o tipo de origem "DeviceMessages".

az iot hub message-route create -n {iothub_name} --route-name {route_name} --endpoint-name events --source DeviceMessages

Crie uma rota desabilitada para um Hub IoT com o ponto de extremidade fornecido, o tipo de origem "DigitalTwinChangeEvents" e a condição personalizada.

az iot hub message-route create -n {iothub_name} --route-name {route_name} --endpoint-name {endpoint_name} --source DigitalTwinChangeEvents --condition {condition} --enabled false

Parâmetros Exigidos

--en --endpoint --endpoint-name

Nome do ponto de extremidade de roteamento. Para o ponto de extremidade interno, use o nome do ponto de extremidade 'eventos'.

--hub-name -n

Nome do Hub IoT.

--rn --route --route-name

O nome da rota.

--source-type --type -t

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.

valor padrão: true
--enabled -e

Um booleano indicando se deve habilitar a rota para o Hub IoT.

valores aceitos: false, true
valor padrão: 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 message-route delete

Versão Prévia

O grupo de comandos 'iot hub message-route' está em pré-visualização e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

Exclua todas as rotas ou uma rota mencionada em um Hub IoT.

az iot hub message-route delete --hub-name
                                [--resource-group]
                                [--rn]
                                [--source-type {deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents}]
                                [--yes {false, true}]

Exemplos

Exclua uma rota de um Hub IoT.

az iot hub message-route delete -n {iothub_name} --route-name {route_name}

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

az iot hub message-route delete -n {iothub_name} --source DeviceMessages

Exclua todas as rotas de um Hub IoT.

az iot hub message-route delete -n {iothub_name}

Parâmetros Exigidos

--hub-name -n

Nome do Hub IoT.

Parâmetros Opcionais

--resource-group -g

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

--rn --route --route-name

O nome da rota.

--source-type --type -t

Origem da rota.

valores aceitos: deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents
--yes -y

Ignorar prompts do usuário. Indica aceitação da ação. Usado principalmente para cenários de automação. Padrão: falso.

valores aceitos: false, true
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 message-route list

Versão Prévia

O grupo de comandos 'iot hub message-route' está em pré-visualização e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

Obtenha todas as rotas em um Hub IoT.

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

Exemplos

Obtenha todas as rotas de um Hub IoT.

az iot hub message-route list -n {iothub_name}

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

az iot hub message-route list -n {iothub_name} --source DeviceMessages

Parâmetros Exigidos

--hub-name -n

Nome do Hub IoT.

Parâmetros Opcionais

--resource-group -g

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

--source-type --type -t

Origem da rota.

valores aceitos: deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents
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 message-route show

Versão Prévia

O grupo de comandos 'iot hub message-route' está em pré-visualização e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

Obtenha informações sobre a rota em um Hub IoT.

az iot hub message-route show --hub-name
                              --rn
                              [--resource-group]

Exemplos

Obtenha informações de rota de um Hub IoT.

az iot hub message-route show -n {iothub_name} --route-name {route_name}

Parâmetros Exigidos

--hub-name -n

Nome do Hub IoT.

--rn --route --route-name

O nome da rota.

Parâmetros Opcionais

--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 message-route test

Versão Prévia

O grupo de comandos 'iot hub message-route' está em pré-visualização e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

Teste todas as rotas ou uma rota mencionada em um Hub IoT.

Você pode fornecer uma mensagem de exemplo para testar suas rotas.

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

Exemplos

Testar uma rota de um Hub IoT.

az iot hub message-route test -n {iothub_name} --route-name {route_name}

Teste todas as rotas do tipo de origem "DeviceMessages" de um Hub IoT.

az iot hub message-route test -n {iothub_name} --source DeviceMessages

Teste todas as rotas de um Hub IoT com uma mensagem personalizada, incluindo corpo, propriedades do aplicativo e propriedades do sistema.

az iot hub message-route test -n {iothub_name} -b {body} --ap {app_properties} --sp {system_properties}

Parâmetros Exigidos

--hub-name -n

Nome do Hub IoT.

Parâmetros Opcionais

--ap --app-properties

Propriedades do aplicativo da mensagem de rota.

--body -b

Corpo da mensagem de rota.

--resource-group -g

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

--rn --route --route-name

O nome da rota.

--source-type --type -t

Origem da rota.

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

Propriedades do sistema da mensagem de rota.

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 message-route update

Versão Prévia

O grupo de comandos 'iot hub message-route' está em pré-visualização e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

Atualize uma rota para um Hub IoT.

Você pode alterar a origem, o ponto de extremidade, a condição ou o estado habilitado na rota.

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

Exemplos

Atualize uma rota para um determinado ponto de extremidade e tipo de origem "DeviceMessages".

az iot hub message-route update -n {iothub_name} --route-name {route_name} --endpoint-name {endpoint_name} --source DeviceMessages

Desative uma rota.

az iot hub message-route update -n {iothub_name} --route-name {route_name} --enabled false

Alterar a condição de uma rota.

az iot hub message-route update -n {iothub_name} --route-name {route_name} --condition {condition}

Parâmetros Exigidos

--hub-name -n

Nome do Hub IoT.

--rn --route --route-name

O 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. Para o ponto de extremidade interno, use o nome do ponto de extremidade 'eventos'.

--enabled -e

Um booleano indicando se deve habilitar a rota para o Hub IoT.

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

--source-type --type -t

Origem da rota.

valores aceitos: deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents
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.