az iot hub route

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

Gerencie rotas de um hub IoT.

Comandos

Name	Description	Tipo	Estado
az iot hub route create	Crie uma rota no Hub IoT.	Principal	Preterido
az iot hub route delete	Exclua toda ou mencionada rota para seu Hub IoT.	Principal	Preterido
az iot hub route list	Obtenha todas as rotas no Hub IoT.	Principal	Preterido
az iot hub route show	Obtenha informações sobre a rota no Hub IoT.	Principal	Preterido
az iot hub route test	Teste todas as rotas ou rotas mencionadas no Hub IoT.	Principal	Preterido
az iot hub route update	Atualize uma rota no Hub IoT.	Principal	Preterido

az iot hub route create

Preterido

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

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 Obrigatórios

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

Fonte do percurso.

valores aceites: 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 que indica se a rota deve ser habilitada para o hub Iot.

valores aceites: false, true

--resource-group -g

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

Parâmetros de Globais

--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc

valor predefinido: json

--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az iot hub route delete

Preterido

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

Exclua toda ou mencionada rota 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 "MyIotHub" IoT Hub.

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

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

--name --route-name -n

Nome da rota.

--resource-group -g

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

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

Fonte do percurso.

valores aceites: deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

Parâmetros de Globais

--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc

valor predefinido: json

--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az iot hub route list

Preterido

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

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 "MyIotHub" IoT Hub.

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

Parâmetros Opcionais

--hub-name

Nome do Hub IoT.

--ids

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

--resource-group -g

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

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

Fonte do percurso.

valores aceites: deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

Parâmetros de Globais

--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc

valor predefinido: json

--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az iot hub route show

Preterido

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

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

Obtenha informações sobre uma rota específica no 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 Obrigatórios

--name --route-name -n

Nome da rota.

Parâmetros Opcionais

--hub-name

Nome do Hub IoT.

--ids

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

--resource-group -g

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

Parâmetros de Globais

--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc

valor predefinido: json

--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az iot hub route test

Preterido

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

Teste todas as rotas ou rotas mencionadas no Hub IoT.

Teste todas as rotas existentes ou mencionadas no 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

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

--name --route-name -n

Nome da rota.

--resource-group -g

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

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

Fonte do percurso.

valores aceites: deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents

--sp --system-properties

Propriedades do sistema da mensagem de rota.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

Parâmetros de Globais

--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc

valor predefinido: json

--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az iot hub route update

Preterido

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

Atualize 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 Obrigatórios

--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 que indica se a rota deve ser habilitada para o hub Iot.

valores aceites: false, true

--hub-name

Nome do Hub IoT.

--ids

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

--resource-group -g

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

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

Fonte do percurso.

valores aceites: deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

Parâmetros de Globais

--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc

valor predefinido: json

--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.