Compartilhar via

az iot hub message-endpoint

  • Versão Prévia

Note

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

Esse grupo de comandos está em versão prévia e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

Gerenciar pontos de extremidade personalizados de um Hub IoT.

Comandos

Nome Description Tipo Status
az iot hub message-endpoint create

Adicione um ponto de extremidade a um Hub IoT.

 Extension Preview
az iot hub message-endpoint create cosmosdb-container

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

 Extension Preview
az iot hub message-endpoint create eventhub

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

 Extension Preview
az iot hub message-endpoint create servicebus-queue

Adicione um ponto de extremidade da Fila do Barramento de Serviço para um Hub IoT.

 Extension Preview
az iot hub message-endpoint create servicebus-topic

Adicione um ponto de extremidade de Tópico do Barramento de Serviço para um Hub IoT.

 Extension Preview
az iot hub message-endpoint create storage-container

Adicione um ponto de extremidade do Contêiner de Armazenamento para um Hub IoT.

 Extension Preview
az iot hub message-endpoint delete

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

 Extension Preview
az iot hub message-endpoint list

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

 Extension Preview
az iot hub message-endpoint show

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

 Extension Preview
az iot hub message-endpoint update

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

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

 Extension Preview
az iot hub message-endpoint update eventhub

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

 Extension Preview
az iot hub message-endpoint update servicebus-queue

Atualize as propriedades de um ponto de extremidade de Fila do Barramento de Serviço existente para um Hub IoT.

 Extension Preview
az iot hub message-endpoint update servicebus-topic

Atualize as propriedades de um ponto de extremidade de Tópico do Barramento de Serviço existente para um Hub IoT.

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

 Extension Preview

az iot hub message-endpoint delete

Versão Prévia

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

Exclua todo o ponto de extremidade ou um ponto de extremidade específico de 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 [--en --endpoint --endpoint-name]
                                   [--endpoint-type --type {cosmosdb-container, eventhub, servicebus-queue, servicebus-topic, storage-container}]
                                   [--force]
                                   [--hub-name]
                                   [--ids]
                                   [--resource-group]
                                   [--subscription]
                                   [--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}

Force a exclusão de um ponto de extremidade de um Hub IoT. Isso excluirá as rotas e os enriquecimentos de mensagens associados a esse ponto de extremidade.

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

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

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

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--en --endpoint --endpoint-name

Nome do ponto de extremidade de roteamento.

--endpoint-type --type -t

Tipo do ponto de extremidade de roteamento.

Propriedade Valor
Valores aceitos: cosmosdb-container, eventhub, servicebus-queue, servicebus-topic, storage-container
--force -f

Force a exclusão dos pontos de extremidade e quaisquer rotas e enriquecimentos de mensagens associados.

Propriedade Valor
Valor padrão: False
--hub-name -n

Nome do Hub IoT.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--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 de argumentos de 'ID do recurso'. Você deve fornecer --ids ou outros argumentos de 'ID de recurso'.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--resource-group -g

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--subscription

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--yes -y

Ignore as solicitações do usuário. Indica a aceitação da ação. Usado principalmente para cenários de automação. Padrão: false.

Propriedade Valor
Valores aceitos: false, true
Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

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

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

--verbose

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

Propriedade Valor
Valor padrão: False

az iot hub message-endpoint list

Versão Prévia

O grupo de comandos 'iot hub message-endpoint' está em versão prévia e em desenvolvimento. Níveis de referência e suporte: 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 [--endpoint-type --type {cosmosdb-container, eventhub, servicebus-queue, servicebus-topic, storage-container}]
                                 [--hub-name]
                                 [--ids]
                                 [--resource-group]
                                 [--subscription]

Exemplos

Obtenha todos os pontos de extremidade 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 Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--endpoint-type --type -t

Tipo do ponto de extremidade de roteamento.

Propriedade Valor
Valores aceitos: cosmosdb-container, eventhub, servicebus-queue, servicebus-topic, storage-container
--hub-name -n

Nome do Hub IoT.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--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 de argumentos de 'ID do recurso'. Você deve fornecer --ids ou outros argumentos de 'ID de recurso'.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--resource-group -g

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--subscription

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

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

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

--verbose

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

Propriedade Valor
Valor padrão: False

az iot hub message-endpoint show

Versão Prévia

O grupo de comandos 'iot hub message-endpoint' está em versão prévia e em desenvolvimento. Níveis de referência e suporte: 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 --endpoint --endpoint-name
                                 [--hub-name]
                                 [--ids]
                                 [--resource-group]
                                 [--subscription]

Exemplos

Obtenha informações de um ponto de extremidade de um Hub IoT.

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

Parâmetros Exigidos

--en --endpoint --endpoint-name

Nome do ponto de extremidade de roteamento.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--hub-name -n

Nome do Hub IoT.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--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 de argumentos de 'ID do recurso'. Você deve fornecer --ids ou outros argumentos de 'ID de recurso'.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--resource-group -g

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--subscription

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

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

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

--verbose

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

Propriedade Valor
Valor padrão: False