az iot hub route

Gerenciar rotas de um Hub IoT.

Comandos

az iot hub route create

Crie uma rota no Hub IoT.

az iot hub route delete

Exclua toda ou mencionada rota para o Hub IoT.

az iot hub route list

Obter todas as rotas no Hub IoT.

az iot hub route show

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

az iot hub route test

Teste todas as rotas ou a rota mencionada no Hub IoT.

az iot hub route update

Atualize uma rota no Hub IoT.

az iot hub route create

Crie uma rota no Hub IoT.

Crie uma rota para enviar uma fonte de dados específica e uma condição 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]
                        [--subscription]

Exemplos

Crie uma nova rota "R1".

az iot hub route create -g MyResourceGroup --hub-name MyIotHub --endpoint-name E2 --source-type 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-type 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 booliana que indica se a rota deve ser habilitada 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>.

--subscription

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

az iot hub route delete

Exclua toda ou mencionada rota para o Hub IoT.

Exclua uma rota ou todas as rotas para o 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-type 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 uma ID de recurso completa que contém todas as informações dos argumentos de 'ID do recurso'. Você deve fornecer --ids ou outros argumentos de "ID do recurso".

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

az iot hub route list

Obter todas as rotas no Hub IoT.

Obter informações sobre todas as rotas de um Hub IoT.

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

Exemplos

Obter toda a rota do Hub IoT "MyIotHub".

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

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

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

Parâmetros Opcionais

--hub-name

Nome do Hub IoT.

--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações dos argumentos de 'ID do recurso'. Você deve fornecer --ids ou outros argumentos de "ID do recurso".

--query-examples

Recomendamos cadeia de caracteres JMESPath para você. Você pode copiar uma da consulta e colar depois do parâmetro --query entre aspas duplas para ver os resultados. Você pode adicionar uma ou mais palavras-chave posicionais para que possamos dar sugestões com base nessas palavras-chave.

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

az iot hub route show

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

Obter informações sobre uma rota específica no Hub IoT.

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

Exemplos

Obter 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 uma ID de recurso completa que contém todas as informações dos argumentos de 'ID do recurso'. Você deve fornecer --ids ou outros argumentos de "ID do recurso".

--query-examples

Recomendamos cadeia de caracteres JMESPath para você. Você pode copiar uma da consulta e colar depois do parâmetro --query entre aspas duplas para ver os resultados. Você pode adicionar uma ou mais palavras-chave posicionais para que possamos dar sugestões com base nessas palavras-chave.

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

az iot hub route test

Teste todas as rotas ou a rota mencionada no Hub IoT.

Teste todas as rotas existentes ou a rota mencionada 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-type 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 uma ID de recurso completa que contém todas as informações dos argumentos de 'ID do recurso'. Você deve fornecer --ids ou outros argumentos de "ID do recurso".

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

az iot hub route update

Atualize uma rota no Hub IoT.

Atualiza uma rota no Hub IoT. Você pode alterar a origem, o enpoint 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-type 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 booliana que indica se a rota deve ser habilitada para o Hub IoT.

valores aceitos: false, true
--hub-name

Nome do Hub IoT.

--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações dos argumentos de 'ID do recurso'. Você deve fornecer --ids ou outros argumentos de "ID do recurso".

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