Partilhar via


az iot hub message-endpoint

Nota

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

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

Gerencie pontos de extremidade personalizados de um hub IoT.

Comandos

Name Description Tipo Status
az iot hub message-endpoint create

Adicione um ponto de extremidade a um Hub IoT.

Extensão Pré-visualizar
az iot hub message-endpoint create cosmosdb-container

Adicione um ponto de extremidade de contêiner do Cosmos DB para um Hub IoT.

Extensão Pré-visualizar
az iot hub message-endpoint create eventhub

Adicione um ponto de extremidade do Hub de Eventos para um Hub IoT.

Extensão Pré-visualizar
az iot hub message-endpoint create servicebus-queue

Adicione um ponto de extremidade da Fila do Service Bus para um Hub IoT.

Extensão Pré-visualizar
az iot hub message-endpoint create servicebus-topic

Adicione um ponto de extremidade de Tópico do Service Bus para um Hub IoT.

Extensão Pré-visualizar
az iot hub message-endpoint create storage-container

Adicione um ponto de extremidade de contêiner de armazenamento para um Hub IoT.

Extensão Pré-visualizar
az iot hub message-endpoint delete

Exclua todo ou um ponto de extremidade específico para um Hub IoT.

Extensão Pré-visualizar
az iot hub message-endpoint list

Obtenha informações sobre todos os pontos de extremidade de um Hub IoT.

Extensão Pré-visualizar
az iot hub message-endpoint show

Obtenha informações sobre o ponto de extremidade mencionado para um Hub IoT.

Extensão Pré-visualizar
az iot hub message-endpoint update

Atualize as propriedades de um ponto de extremidade existente para um Hub IoT.

Extensão Pré-visualizar
az iot hub message-endpoint update cosmosdb-container

Atualize as propriedades de um ponto de extremidade de contêiner do Cosmos DB existente para um Hub IoT.

Extensão Pré-visualizar
az iot hub message-endpoint update eventhub

Atualize as propriedades de um ponto de extremidade existente do Hub de Eventos para um Hub IoT.

Extensão Pré-visualizar
az iot hub message-endpoint update servicebus-queue

Atualize as propriedades de um ponto de extremidade existente da Fila do Service Bus para um Hub IoT.

Extensão Pré-visualizar
az iot hub message-endpoint update servicebus-topic

Atualize as propriedades de um ponto de extremidade existente do Tópico do Service Bus para um Hub IoT.

Extensão Pré-visualizar
az iot hub message-endpoint update storage-container

Atualize as propriedades de um ponto de extremidade de Contêiner de Armazenamento existente para um Hub IoT.

Extensão Pré-visualizar

az iot hub message-endpoint delete

Pré-visualizar

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

Exclua todo ou um ponto de extremidade específico para um Hub IoT.

Você deve excluir todas as rotas e enriquecimentos de mensagens para o ponto de extremidade, antes de excluir o ponto de extremidade.

az iot hub message-endpoint delete --hub-name
                                   [--en]
                                   [--endpoint-type {cosmosdb-container, eventhub, servicebus-queue, servicebus-topic, storage-container}]
                                   [--force]
                                   [--resource-group]
                                   [--yes {false, true}]

Exemplos

Exclua um ponto de extremidade de um Hub IoT.

az iot hub message-endpoint delete -n {iothub_name} --endpoint-name {endpoint_name}

Exclua todos os pontos de extremidade do tipo "EventHub" de um Hub IoT.

az iot hub message-endpoint delete -n {iothub_name} --endpoint-type eventhub

Exclua todos os pontos de extremidade de um Hub IoT.

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

Forçar a exclusão de um ponto de extremidade de um Hub IoT. Isso excluirá todas as rotas e enriquecimentos de mensagens associados a esse ponto de extremidade.

az iot hub message-endpoint delete -n {iothub_name} --endpoint-name {endpoint_name} -f

Força a exclusão de todos os pontos de extremidade do tipo "EventHub" de um Hub IoT. Isso excluirá todas as rotas e enriquecimentos de mensagens associados a esse ponto de extremidade.

az iot hub message-endpoint delete -n {iothub_name} --endpoint-type eventhub -f

Parâmetros Obrigatórios

--hub-name -n

Nome do Hub IoT.

Parâmetros Opcionais

--en --endpoint --endpoint-name

Nome do ponto de extremidade de roteamento.

--endpoint-type --type -t

Tipo do ponto de extremidade de roteamento.

Valores aceites: cosmosdb-container, eventhub, servicebus-queue, servicebus-topic, storage-container
--force -f

Força a exclusão do(s) ponto(s) de extremidade e quaisquer rotas e enriquecimento de mensagem associados.

Default value: False
--resource-group -g

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

--yes -y

Ignore os prompts do usuário. Indica a aceitação da ação. Usado principalmente para cenários de automação. Predefinição: false.

Valores aceites: false, true
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
Default value: 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 message-endpoint list

Pré-visualizar

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

Obtenha informações sobre todos os pontos de extremidade de um Hub IoT.

Você também pode especificar sobre qual tipo de ponto de extremidade deseja obter informações.

az iot hub message-endpoint list --hub-name
                                 [--endpoint-type {cosmosdb-container, eventhub, servicebus-queue, servicebus-topic, storage-container}]
                                 [--resource-group]

Exemplos

Obtenha todos os endpoints de um Hub IoT.

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

Obtenha todos os pontos de extremidade do tipo "EventHub" de um Hub IoT.

az iot hub message-endpoint list -n {iothub_name} --endpoint-type eventhub

Parâmetros Obrigatórios

--hub-name -n

Nome do Hub IoT.

Parâmetros Opcionais

--endpoint-type --type -t

Tipo do ponto de extremidade de roteamento.

Valores aceites: cosmosdb-container, eventhub, servicebus-queue, servicebus-topic, storage-container
--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
Default value: 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 message-endpoint show

Pré-visualizar

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

Obtenha informações sobre o ponto de extremidade mencionado para um Hub IoT.

az iot hub message-endpoint show --en
                                 --hub-name
                                 [--resource-group]

Exemplos

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

az iot hub message-endpoint show -n {iothub_name} --endpoint-name {endpoint_name}

Parâmetros Obrigatórios

--en --endpoint --endpoint-name

Nome do ponto de extremidade de roteamento.

--hub-name -n

Nome do Hub IoT.

Parâmetros Opcionais

--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
Default value: 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.