az iot hub routing-endpoint

  • Preterido
  • Referência

Esse grupo de comandos foi preterido e será removido em uma versão futura. Em vez disso, use 'IoT Extension (azure-iot) message-endpoint command group (az iot hub message-endpoint)'.

Gerenciar pontos de extremidade personalizados de um Hub IoT.

Comandos

Nome Description Tipo Status
az iot hub routing-endpoint create

Adicione um ponto de extremidade ao seu Hub IoT.

 Núcleo Preterido
az iot hub routing-endpoint delete

Exclua todo o ponto de extremidade ou mencionado para seu Hub IoT.

 Núcleo Preterido
az iot hub routing-endpoint list

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

 Núcleo Preterido
az iot hub routing-endpoint show

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

 Núcleo Preterido

az iot hub routing-endpoint create

Editar
Preterido

Esse comando foi preterido implicitamente porque o grupo de comandos 'iot hub routing-endpoint' foi preterido e será removido em uma versão futura. Em vez disso, use 'IoT Extension (azure-iot) message-endpoint command group (az iot hub message-endpoint)'.

Adicione um ponto de extremidade ao seu Hub IoT.

Crie um novo ponto de extremidade personalizado em seu Hub IoT.

az iot hub routing-endpoint create --endpoint-name
                                   --endpoint-resource-group
                                   --endpoint-subscription-id
                                   --endpoint-type {azurestoragecontainer, eventhub, servicebusqueue, servicebustopic}
                                   --hub-name
                                   [--auth-type {identityBased, keyBased}]
                                   [--batch-frequency]
                                   [--chunk-size]
                                   [--connection-string]
                                   [--container]
                                   [--encoding {avro, json}]
                                   [--endpoint-uri]
                                   [--entity-path]
                                   [--ff]
                                   [--identity]
                                   [--resource-group]

Exemplos

Adicione um novo ponto de extremidade "E2" do tipo EventHub ao Hub IoT "MyIotHub".

az iot hub routing-endpoint create --resource-group MyResourceGroup --hub-name MyIotHub --endpoint-name E2 --endpoint-type eventhub --endpoint-resource-group {ResourceGroup} --endpoint-subscription-id {SubscriptionId} --connection-string {ConnectionString}

Adicione um novo ponto de extremidade "S1" do tipo AzureStorageContainer ao Hub IoT "MyIotHub" dentro do grupo de recursos de ponto de extremidade "MyEndpointResourceGroup".

az iot hub routing-endpoint create --resource-group MyResourceGroup --hub-name MyIotHub \
--endpoint-name S1 --endpoint-type azurestoragecontainer --endpoint-resource-group MyEndpointResourceGroup \
--endpoint-subscription-id {SubscriptionId} --connection-string {ConnectionString} \
--container-name {ContainerName} --batch-frequency 100 --chunk-size 100 \
--ff {iothub}-{partition}-{YYYY}-{MM}-{DD}-{HH}-{mm}

Adicione um novo ponto de extremidade do EventHub baseado em identidade chamado "EventHubIdentity" e autentique-se usando uma identidade gerenciada atribuída pelo usuário

az iot hub routing-endpoint create --resource-group MyResourceGroup --hub-name MyIotHub --endpoint-name EventHubIdentity --endpoint-type eventhub --endpoint-resource-group {ResourceGroup} --endpoint-subscription-id {SubscriptionId} --auth-type identityBased --identity {userIdentityResourceId} --endpoint-uri {EventHubEndpointUri} --entity-path {EntityPath}

Parâmetros Exigidos

--endpoint-name --name -n

Nome do ponto de extremidade de roteamento.

--endpoint-resource-group --erg -r

Grupo de recursos do recurso Endpoint.

--endpoint-subscription-id -s

SubscriptionId do recurso Endpoint.

--endpoint-type --type -t

Tipo do ponto de extremidade de roteamento.

valores aceitos: azurestoragecontainer, eventhub, servicebusqueue, servicebustopic
--hub-name

Nome do Hub IoT.

Parâmetros Opcionais

--auth-type

Tipo de autenticação para o ponto de extremidade. O padrão é keyBased.

valores aceitos: identityBased, keyBased
--batch-frequency -b

Frequência de lote de solicitação em segundos. A quantidade máxima de tempo que pode decorrer antes que os dados sejam gravados em um blob, entre 60 e 720 segundos.

valor padrão: 300
--chunk-size -w

Tamanho do bloco de solicitação em megabytes (MB). O tamanho máximo dos blobs, entre 10 e 500 MB.

valor padrão: 300
--connection-string -c

Cadeia de conexão do Ponto de Extremidade de Roteamento.

--container --container-name

Nome do recipiente de armazenamento.

--encoding

Formato de codificação para o contêiner. O padrão é AVRO. Observe que esse campo é aplicável somente para pontos de extremidade de contêiner de blob.

valores aceitos: avro, json
--endpoint-uri

O uri do recurso de ponto de extremidade.

--entity-path

O caminho da entidade do recurso de ponto de extremidade.

--ff --file-name-format

Formato de nome de arquivo para o blob. O formato de nome de arquivo deve conter os campos {iothub}, {partition}, {YYYY}, {MM}, {DD}, {HH} e {mm}. Todos os parâmetros são obrigatórios, mas podem ser reordenados com ou sem delimitadores.

valor padrão: {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}
--identity

Use uma identidade gerenciada atribuída pelo sistema ou pelo usuário para autenticação de ponto de extremidade. Use "[system]" para se referir à identidade atribuída pelo sistema ou a uma ID de recurso para se referir a uma identidade atribuída pelo usuário. Se você usar --auth-type sem esse parâmetro, a identidade gerenciada atribuída pelo sistema será presumida.

--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 routing-endpoint delete

Editar
Preterido

Esse comando foi preterido implicitamente porque o grupo de comandos 'iot hub routing-endpoint' foi preterido e será removido em uma versão futura. Em vez disso, use 'IoT Extension (azure-iot) message-endpoint command group (az iot hub message-endpoint)'.

Exclua todo o ponto de extremidade ou mencionado para seu Hub IoT.

Exclua um ponto de extremidade do Hub IoT. Recomendamos que você exclua todas as rotas para o ponto de extremidade, antes de excluir o ponto de extremidade.

az iot hub routing-endpoint delete [--endpoint-name]
                                   [--endpoint-type {azurestoragecontainer, eventhub, servicebusqueue, servicebustopic}]
                                   [--hub-name]
                                   [--ids]
                                   [--resource-group]
                                   [--subscription]

Exemplos

Exclua o ponto de extremidade "E2" do Hub IoT "MyIotHub".

az iot hub routing-endpoint delete --resource-group MyResourceGroup --hub-name MyIotHub --endpoint-name E2

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

az iot hub routing-endpoint delete --resource-group MyResourceGroup --hub-name MyIotHub --endpoint-type eventhub

Exclua todos os pontos de extremidade do Hub IoT "MyIotHub".

az iot hub routing-endpoint delete --resource-group MyResourceGroup --hub-name MyIotHub

Parâmetros Opcionais

--endpoint-name --name -n

Nome do ponto de extremidade de roteamento.

--endpoint-type --type -t

Tipo do ponto de extremidade de roteamento.

valores aceitos: azurestoragecontainer, eventhub, servicebusqueue, servicebustopic
--hub-name

Nome do Hub IoT.

--ids

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

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

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 routing-endpoint list

Editar
Preterido

Esse comando foi preterido implicitamente porque o grupo de comandos 'iot hub routing-endpoint' foi preterido e será removido em uma versão futura. Em vez disso, use 'IoT Extension (azure-iot) message-endpoint command group (az iot hub message-endpoint)'.

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

Obtenha informações sobre todos os pontos de extremidade em seu Hub IoT. Você também pode especificar em qual tipo de ponto de extremidade deseja obter informações.

az iot hub routing-endpoint list [--endpoint-type {azurestoragecontainer, eventhub, servicebusqueue, servicebustopic}]
                                 [--hub-name]
                                 [--ids]
                                 [--resource-group]
                                 [--subscription]

Exemplos

Obtenha todos os pontos de extremidade do Hub IoT "MyIotHub".

az iot hub routing-endpoint list -g MyResourceGroup --hub-name MyIotHub

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

az iot hub routing-endpoint list -g MyResourceGroup --hub-name MyIotHub --endpoint-type eventhub

Parâmetros Opcionais

--endpoint-type --type -t

Tipo do ponto de extremidade de roteamento.

valores aceitos: azurestoragecontainer, eventhub, servicebusqueue, servicebustopic
--hub-name

Nome do Hub IoT.

--ids

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

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

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 routing-endpoint show

Editar
Preterido

Esse comando foi preterido implicitamente porque o grupo de comandos 'iot hub routing-endpoint' foi preterido e será removido em uma versão futura. Em vez disso, use 'IoT Extension (azure-iot) message-endpoint command group (az iot hub message-endpoint)'.

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

Obtenha informações sobre um ponto de extremidade específico em seu Hub IoT.

az iot hub routing-endpoint show --endpoint-name
                                 [--hub-name]
                                 [--ids]
                                 [--resource-group]
                                 [--subscription]

Exemplos

Obtenha informações de ponto de extremidade do Hub IoT "MyIotHub".

az iot hub routing-endpoint show --resource-group MyResourceGroup --hub-name MyIotHub \
--endpoint-name {endpointName}

Parâmetros Exigidos

--endpoint-name --name -n

Nome do ponto de extremidade de roteamento.

Parâmetros Opcionais

--hub-name

Nome do Hub IoT.

--ids

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

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

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.