az iot hub

Referência

Nota

Este grupo de comandos tem comandos definidos na CLI do Azure e em pelo menos uma extensão. Instale cada extensão para se beneficiar de seus recursos estendidos. Saiba mais sobre extensões.

Gerencie hubs IoT do Azure.

Comandos

Name	Description	Tipo	Status
az iot hub certificate	Gerencie certificados do Hub IoT.	Núcleo e Extensão	GA
az iot hub certificate create	Crie/carregue um certificado do Hub IoT do Azure.	Principal	GA
az iot hub certificate delete	Exclui um certificado do Hub IoT do Azure.	Principal	GA
az iot hub certificate generate-verification-code	Gera um código de verificação para um certificado do Hub IoT do Azure.	Principal	GA
az iot hub certificate list	Lista todos os certificados contidos em um Hub IoT do Azure.	Principal	GA
az iot hub certificate root-authority	Gerencie a autoridade raiz do certificado para uma instância do Hub IoT.	Extensão	Preterido
az iot hub certificate root-authority set	Defina a autoridade raiz do certificado para uma instância do Hub IoT para uma versão específica.	Extensão	Preterido
az iot hub certificate root-authority show	Mostrar a autoridade raiz do certificado atual para uma instância do Hub IoT.	Extensão	Preterido
az iot hub certificate show	Mostra informações sobre um certificado específico do Hub IoT do Azure.	Principal	GA
az iot hub certificate update	Atualizar um certificado do Hub IoT do Azure.	Principal	GA
az iot hub certificate verify	Verifica um certificado do Hub IoT do Azure.	Principal	GA
az iot hub configuration	Gestão da configuração da gestão automática de dispositivos IoT em escala.	Extensão	GA
az iot hub configuration create	Crie uma configuração de gerenciamento automático de dispositivos IoT em um Hub IoT de destino.	Extensão	GA
az iot hub configuration delete	Exclua uma configuração de dispositivo IoT.	Extensão	GA
az iot hub configuration list	Liste as configurações de gerenciamento automático de dispositivos IoT em um Hub IoT.	Extensão	GA
az iot hub configuration show	Obtenha os detalhes de uma configuração de gerenciamento automático de dispositivos IoT.	Extensão	GA
az iot hub configuration show-metric	Avalie um usuário de destino ou uma métrica do sistema definida em uma configuração de dispositivo IoT.	Extensão	GA
az iot hub configuration update	Atualize as propriedades especificadas de uma configuração de gerenciamento automático de dispositivos IoT.	Extensão	GA
az iot hub connection-string	Gerencie cadeias de conexão do Hub IoT.	Extensão	GA
az iot hub connection-string show	Mostrar as cadeias de conexão para os Hubs IoT especificados usando o nome e a chave da política fornecidos.	Extensão	GA
az iot hub consumer-group	Gerencie os grupos de consumidores do hub de eventos de um hub IoT.	Principal	GA
az iot hub consumer-group create	Crie um grupo de consumidores do hub de eventos.	Principal	GA
az iot hub consumer-group delete	Exclua um grupo de consumidores do hub de eventos.	Principal	GA
az iot hub consumer-group list	Listar grupos de consumidores do hub de eventos.	Principal	GA
az iot hub consumer-group show	Obtenha os detalhes de um grupo de consumidores do hub de eventos.	Principal	GA
az iot hub create	Crie um hub IoT do Azure.	Principal	GA
az iot hub delete	Exclua um hub IoT.	Principal	GA
az iot hub device-identity	Gerencie dispositivos IoT.	Extensão	GA
az iot hub device-identity children	Gerencie relacionamentos de dispositivos filhos para dispositivos de borda IoT.	Extensão	GA
az iot hub device-identity children add	Adicione dispositivos como crianças a um dispositivo de borda de destino.	Extensão	GA
az iot hub device-identity children list	Produz a coleção de dispositivos filho atribuídos.	Extensão	GA
az iot hub device-identity children remove	Remova dispositivos filho de um dispositivo de borda de destino.	Extensão	GA
az iot hub device-identity connection-string	Gerencie a cadeia de conexão do dispositivo IoT.	Extensão	GA
az iot hub device-identity connection-string show	Mostrar uma determinada cadeia de conexão de dispositivo do Hub IoT.	Extensão	GA
az iot hub device-identity create	Crie um dispositivo em um Hub IoT.	Extensão	GA
az iot hub device-identity delete	Exclua um dispositivo do Hub IoT.	Extensão	GA
az iot hub device-identity export	Exporte todas as identidades de dispositivo de um Hub IoT para um contêiner de blob de Armazenamento do Azure.	Extensão	GA
az iot hub device-identity import	Importe identidades de dispositivo para um Hub IoT a partir de um blob de contêiner de armazenamento.	Extensão	GA
az iot hub device-identity list	Listar dispositivos em um Hub IoT.	Extensão	GA
az iot hub device-identity parent	Gerencie relacionamentos de dispositivos pai para dispositivos IoT.	Extensão	GA
az iot hub device-identity parent set	Defina o dispositivo pai de um dispositivo de destino.	Extensão	GA
az iot hub device-identity parent show	Obtenha o dispositivo pai de um dispositivo de destino.	Extensão	GA
az iot hub device-identity renew-key	Renove as chaves de destino de um dispositivo do Hub IoT com autenticação sas.	Extensão	GA
az iot hub device-identity show	Obtenha os detalhes de um dispositivo do Hub IoT.	Extensão	GA
az iot hub device-identity update	Atualize um dispositivo do Hub IoT.	Extensão	GA
az iot hub device-twin	Gerencie a configuração de gêmeos de dispositivos IoT.	Extensão	GA
az iot hub device-twin list	Listar gêmeos de dispositivo em um Hub IoT.	Extensão	GA
az iot hub device-twin replace	Substitua a definição gêmea do dispositivo pelo json de destino.	Extensão	GA
az iot hub device-twin show	Obtenha uma definição de dispositivo duplo.	Extensão	GA
az iot hub device-twin update	Atualize as propriedades e tags desejadas do dispositivo.	Extensão	GA
az iot hub devicestream	Gerencie fluxos de dispositivos de um hub IoT.	Principal	Pré-visualizar
az iot hub devicestream show	Obtenha os pontos finais de fluxos de dispositivos do Hub IoT.	Principal	Pré-visualizar
az iot hub digital-twin	Manipule e interaja com o gêmeo digital de um dispositivo do Hub IoT.	Extensão	GA
az iot hub digital-twin invoke-command	Invoque um comando raiz ou de nível de componente de um dispositivo de gêmeo digital.	Extensão	GA
az iot hub digital-twin show	Mostre o gêmeo digital de um dispositivo do Hub IoT.	Extensão	GA
az iot hub digital-twin update	Atualize as propriedades de leitura-gravação de um dispositivo gêmeo digital por meio da especificação de patch JSON.	Extensão	GA
az iot hub distributed-tracing	Gerencie configurações distribuídas por dispositivo.	Extensão	Pré-visualizar
az iot hub distributed-tracing show	Obtenha as configurações de rastreamento distribuído para um dispositivo.	Extensão	Pré-visualizar
az iot hub distributed-tracing update	Atualize as opções de rastreamento distribuído para um dispositivo.	Extensão	Pré-visualizar
az iot hub generate-sas-token	Gere um token SAS para um Hub, dispositivo ou módulo IoT de destino.	Extensão	GA
az iot hub identity	Gerencie identidades de um hub IoT do Azure.	Principal	GA
az iot hub identity assign	Atribua identidades gerenciadas a um Hub IoT.	Principal	GA
az iot hub identity remove	Remova identidades gerenciadas de um Hub IoT.	Principal	GA
az iot hub identity show	Mostrar as propriedades de identidade de um Hub IoT.	Principal	GA
az iot hub invoke-device-method	Invoque um método de dispositivo.	Extensão	GA
az iot hub invoke-module-method	Invoque um método de módulo.	Extensão	GA
az iot hub job	Gerenciar trabalhos do Hub IoT (v2).	Extensão	GA
az iot hub job cancel	Cancelar um trabalho do Hub IoT.	Extensão	GA
az iot hub job create	Crie e agende um trabalho do Hub IoT para execução.	Extensão	GA
az iot hub job list	Liste os trabalhos históricos de um Hub IoT.	Extensão	GA
az iot hub job show	Mostrar detalhes de um trabalho existente do Hub IoT.	Extensão	GA
az iot hub list	Listar hubs IoT.	Principal	GA
az iot hub list-skus	Listar os níveis de preços disponíveis.	Principal	GA
az iot hub manual-failover	Inicie um failover manual do Hub IoT para a região de recuperação de desastres emparelhada geograficamente.	Principal	GA
az iot hub message-endpoint	Gerencie pontos de extremidade personalizados de um hub IoT.	Extensão	Pré-visualizar
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-enrichment	Gerencie o enriquecimento de mensagens para pontos de extremidade de um Hub IoT.	Principal	GA
az iot hub message-enrichment create	Crie um enriquecimento de mensagem para pontos de extremidade escolhidos em seu Hub IoT.	Principal	GA
az iot hub message-enrichment delete	Exclua um enriquecimento de mensagem em seu hub IoT (por chave).	Principal	GA
az iot hub message-enrichment list	Obtenha informações sobre todos os enriquecimentos de mensagens para o seu Hub IoT.	Principal	GA
az iot hub message-enrichment update	Atualize um enriquecimento de mensagem no seu hub IoT (por chave).	Principal	GA
az iot hub message-route	Gerencie rotas de um hub IoT.	Extensão	Pré-visualizar
az iot hub message-route create	Adicione uma rota para um Hub IoT.	Extensão	Pré-visualizar
az iot hub message-route delete	Exclua todas as rotas ou uma rota mencionada em um Hub IoT.	Extensão	Pré-visualizar
az iot hub message-route fallback	Gerencie a rota de fallback de um hub IoT.	Extensão	Pré-visualizar
az iot hub message-route fallback set	Habilite ou desabilite a rota de fallback em um Hub IoT.	Extensão	Pré-visualizar
az iot hub message-route fallback show	Mostrar a rota de fallback de um Hub IoT.	Extensão	Pré-visualizar
az iot hub message-route list	Obtenha todas as rotas em um Hub IoT.	Extensão	Pré-visualizar
az iot hub message-route show	Obtenha informações sobre a rota em um Hub IoT.	Extensão	Pré-visualizar
az iot hub message-route test	Teste todas as rotas ou uma rota mencionada em um Hub IoT.	Extensão	Pré-visualizar
az iot hub message-route update	Atualize uma rota para um Hub IoT.	Extensão	Pré-visualizar
az iot hub module-identity	Gerencie módulos de dispositivos IoT.	Extensão	GA
az iot hub module-identity connection-string	Gerencie a cadeia de conexão do módulo de dispositivo IoT.	Extensão	GA
az iot hub module-identity connection-string show	Mostrar uma cadeia de conexão do módulo de dispositivo IoT de destino.	Extensão	GA
az iot hub module-identity create	Crie um módulo em um dispositivo IoT de destino em um Hub IoT.	Extensão	GA
az iot hub module-identity delete	Exclua um dispositivo em um Hub IoT.	Extensão	GA
az iot hub module-identity list	Liste módulos localizados em um dispositivo IoT em um Hub IoT.	Extensão	GA
az iot hub module-identity renew-key	Renove as chaves de destino de um módulo de dispositivo do Hub IoT com autenticação sas.	Extensão	GA
az iot hub module-identity show	Obtenha os detalhes de um módulo de dispositivo IoT em um Hub IoT.	Extensão	GA
az iot hub module-identity update	Atualize um módulo de dispositivo do Hub IoT.	Extensão	GA
az iot hub module-twin	Gerencie a configuração gêmea do módulo de dispositivo IoT.	Extensão	GA
az iot hub module-twin replace	Substitua uma definição de módulo duplo por json de destino.	Extensão	GA
az iot hub module-twin show	Mostrar uma definição de módulo duplo.	Extensão	GA
az iot hub module-twin update	Atualize as propriedades e tags desejadas do módulo duplo.	Extensão	GA
az iot hub monitor-events	Monitore a telemetria do dispositivo e as mensagens enviadas para um Hub IoT.	Extensão	GA
az iot hub monitor-feedback	Monitore os comentários enviados pelos dispositivos para reconhecer mensagens C2D (Cloud-to-Device).	Extensão	GA
az iot hub policy	Gerencie políticas de acesso compartilhado de um hub IoT.	Principal	GA
az iot hub policy create	Crie uma nova política de acesso compartilhado em um hub IoT.	Principal	GA
az iot hub policy delete	Exclua uma política de acesso compartilhado de um hub IoT.	Principal	GA
az iot hub policy list	Listar políticas de acesso compartilhado de um hub IoT.	Principal	GA
az iot hub policy renew-key	Regenere chaves de uma política de acesso compartilhado de um hub IoT.	Principal	GA
az iot hub policy show	Obtenha os detalhes de uma política de acesso compartilhado de um hub IoT.	Principal	GA
az iot hub query	Consulte um Hub IoT usando uma poderosa linguagem semelhante ao SQL.	Extensão	GA
az iot hub route	Gerencie rotas de um hub IoT.	Principal	Preterido
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 routing-endpoint	Gerencie pontos de extremidade personalizados de um hub IoT.	Principal	Preterido
az iot hub routing-endpoint create	Adicione um ponto de extremidade ao seu Hub IoT.	Principal	Preterido
az iot hub routing-endpoint delete	Exclua todos os pontos de extremidade mencionados ou mencionados para seu Hub IoT.	Principal	Preterido
az iot hub routing-endpoint list	Obtenha informações sobre todos os endpoints do seu Hub IoT.	Principal	Preterido
az iot hub routing-endpoint show	Obtenha informações sobre o ponto de extremidade mencionado para o seu Hub IoT.	Principal	Preterido
az iot hub show	Obtenha os detalhes de um hub IoT.	Principal	GA
az iot hub show-connection-string	Mostrar as cadeias de conexão para um hub IoT.	Principal	Preterido
az iot hub show-quota-metrics	Obtenha as métricas de cota para um hub IoT.	Principal	GA
az iot hub show-stats	Obtenha as estatísticas de um hub IoT.	Principal	GA
az iot hub state	Gerencie o estado de um Hub IoT.	Extensão	Experimental
az iot hub state export	Exporte o estado de um Hub IoT para um arquivo.	Extensão	Experimental
az iot hub state import	Importe um estado de Hub de um arquivo para um Hub IoT.	Extensão	Experimental
az iot hub state migrate	Migre o estado de um hub para outro sem salvar em um arquivo.	Extensão	Experimental
az iot hub update	Atualizar metadados para um hub IoT.	Principal	GA
az iot hub wait	Aguarde até que uma operação em uma instância do Hub IoT seja concluída.	Principal	GA

az iot hub create

Editar

Crie um hub IoT do Azure.

Para obter uma introdução ao Hub IoT do Azure, consulte https://docs.microsoft.com/azure/iot-hub/.

az iot hub create --name
                  --resource-group
                  [--c2d-max-delivery-count]
                  [--c2d-ttl]
                  [--dds {false, true}]
                  [--disable-local-auth {false, true}]
                  [--disable-module-sas {false, true}]
                  [--edr {false, true}]
                  [--fc]
                  [--fcs]
                  [--fd]
                  [--feedback-lock-duration]
                  [--feedback-ttl]
                  [--fileupload-notification-lock-duration]
                  [--fileupload-notification-max-delivery-count]
                  [--fileupload-notification-ttl]
                  [--fileupload-notifications {false, true}]
                  [--fileupload-sas-ttl]
                  [--fileupload-storage-auth-type {identityBased, keyBased}]
                  [--fileupload-storage-identity]
                  [--location]
                  [--mi-system-assigned {false, true}]
                  [--mi-user-assigned]
                  [--min-tls-version]
                  [--no-wait]
                  [--partition-count]
                  [--rd]
                  [--role]
                  [--scopes]
                  [--sku {B1, B2, B3, F1, S1, S2, S3}]
                  [--tags]
                  [--unit]

Exemplos

Crie um Hub IoT com a camada de preços gratuita F1, na região do grupo de recursos.

az iot hub create --resource-group MyResourceGroup --name MyIotHub --sku F1 --partition-count 2

Crie um Hub IoT com as partições de nível de preço padrão S1 e 4, na região 'westus', com tags.

az iot hub create --resource-group MyResourceGroup --name MyIotHub --location westus --tags a=b c=d

Crie um Hub IoT com uma identidade gerenciada atribuída ao sistema e atribua uma função e um escopo a uma conta de armazenamento para a identidade criada.

az iot hub create --resource-group MyResourceGroup --name MyIotHub --location westus --mi-system-assigned --role "Storage Blob Data Contributor" --scopes {resourceId}

Crie um Hub IoT com autenticação local, chaves SAS de dispositivo e chaves SAS de módulo todas desabilitadas

az iot hub create --resource-group MyResourceGroup --name MyIotHub --location westus --disable-local-auth --disable-device-sas --disable-module-sas

Crie um Hub IoT com residência de dados imposta. Isso desativará a recuperação de desastres entre regiões.

az iot hub create --resource-group MyResourceGroup --name MyIoTHub --edr

Parâmetros Obrigatórios

--name -n

Nome do Hub IoT.

--resource-group -g

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

Parâmetros Opcionais

--c2d-max-delivery-count --cdd

O número de vezes que o hub IoT tentará entregar uma mensagem da nuvem para o dispositivo para um dispositivo, entre 1 e 100.

Default value: 10

--c2d-ttl --ct

A quantidade de tempo que uma mensagem está disponível para o dispositivo consumir antes de expirar pelo Hub IoT, entre 1 e 48 horas.

Default value: 1

--dds --disable-device-sas

Um booleano que indica se todos os dispositivos devem ou não ser desabilitados (incluindo dispositivos de Borda, mas excluindo módulos) com escopo de chaves SAS para autenticação.

Valores aceites: false, true

--disable-local-auth --dla

Um booleano que indica se as chaves SAS com escopo do hub IoT devem ou não ser desabilitadas para autenticação.

Valores aceites: false, true

--disable-module-sas --dms

Um booleano que indica se as chaves SAS com escopo de módulo devem ou não ser desabilitadas para autenticação.

Valores aceites: false, true

--edr --enforce-data-residency

Imponha a residência de dados para este Hub IoT desativando a recuperação de desastres entre regiões. Esta propriedade é imutável uma vez definida no recurso. Disponível apenas em regiões selecionadas. Saiba mais em https://aka.ms/iothubdisabledr.

Valores aceites: false, true

--fc --fileupload-storage-container-name

O nome do contêiner raiz onde você carrega arquivos. O contêiner não precisa existir, mas deve ser criável usando o connectionString especificado.

--fcs --fileupload-storage-connectionstring

A cadeia de conexão para a conta de Armazenamento do Azure para a qual os arquivos são carregados.

--fd --feedback-max-delivery-count

O número de vezes que o hub IoT tenta entregar uma mensagem na fila de feedback, entre 1 e 100.

Default value: 10

--feedback-lock-duration --fld

A duração do bloqueio para a fila de comentários, entre 5 e 300 segundos.

Default value: 5

--feedback-ttl --ft

O período de tempo durante o qual o hub IoT manterá o feedback para expiração ou entrega de mensagens da nuvem para o dispositivo, entre 1 e 48 horas.

Default value: 1

--fileupload-notification-lock-duration --fnld

A duração do bloqueio para a fila de notificações de upload de arquivo, entre 5 e 300 segundos.

Default value: 5

--fileupload-notification-max-delivery-count --fnd

O número de vezes que o hub IoT tentará entregar uma mensagem de notificação de arquivo, entre 1 e 100.

Default value: 10

--fileupload-notification-ttl --fnt

A quantidade de tempo que uma notificação de carregamento de arquivo está disponível para o serviço consumir antes de expirar pelo Hub IoT, entre 1 e 48 horas.

Default value: 1

--fileupload-notifications --fn

Um booleano que indica se as informações sobre arquivos carregados devem ser registradas no ponto de extremidade do Hub IoT messages/servicebound/filenotifications.

Valores aceites: false, true

Default value: False

--fileupload-sas-ttl --fst

A quantidade de tempo que um URI SAS gerado pelo Hub IoT é válido antes de expirar, entre 1 e 24 horas.

Default value: 1

--fileupload-storage-auth-type --fsa

O tipo de autenticação para a conta de Armazenamento do Azure para a qual os arquivos são carregados.

Valores aceites: identityBased, keyBased

--fileupload-storage-identity --fsi

A identidade gerenciada a ser usada para autenticação de upload de arquivo. Use '[sistema]' para se referir à identidade gerenciada atribuída ao sistema ou a um ID de recurso para se referir a uma identidade gerenciada atribuída pelo usuário.

--location -l

Localização do seu Hub IoT. O padrão é o local do grupo de recursos de destino.

--mi-system-assigned

Habilite a identidade gerenciada atribuída ao sistema para este hub.

Valores aceites: false, true

--mi-user-assigned

Habilite identidades gerenciadas atribuídas pelo usuário para esse hub. Aceite uma lista separada por espaços de IDs de recursos de identidade.

--min-tls-version --mintls

Especifique a versão mínima do TLS para suportar este hub. Pode ser definido como "1.2" para que os clientes que usam uma versão TLS abaixo de 1.2 sejam rejeitados.

--no-wait

Não espere que a operação de longa duração termine.

Default value: False

--partition-count

O número de partições do Hub de Eventos de backup para mensagens de dispositivo para nuvem.

Default value: 4

--rd --retention-day

Especifica por quanto tempo esse hub IoT manterá eventos de dispositivo para nuvem, entre 1 e 7 dias.

Default value: 1

--role

Função a ser atribuída à identidade gerenciada atribuída pelo sistema do hub.

--scopes

Lista separada por espaço de escopos para atribuir a função (--role) para a identidade gerenciada atribuída ao sistema.

--sku

Camada de preços para o Hub IoT do Azure. Observe que apenas uma instância gratuita do hub IoT (F1) é permitida em cada assinatura. A exceção será lançada se as instâncias livres excederem uma.

Valores aceites: B1, B2, B3, F1, S1, S2, S3

Default value: S1

--tags

Tags separadas por espaço: key[=value] [key[=value] ...]. Use "" para limpar tags existentes.

--unit

Unidades no seu Hub IoT.

Default value: 1

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 delete

Editar

Exclua um hub IoT.

az iot hub delete [--ids]
                  [--name]
                  [--no-wait]
                  [--resource-group]
                  [--subscription]

Exemplos

Exclua um hub IoT. (gerado automaticamente)

az iot hub delete --name MyIoTHub --resource-group MyResourceGroup

Parâmetros Opcionais

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

Nome do Hub IoT.

--no-wait

Não espere que a operação de longa duração termine.

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

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

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 generate-sas-token

Gere um token SAS para um Hub, dispositivo ou módulo IoT de destino.

Para tokens SAS de dispositivo, o parâmetro policy é usado para acessar somente o registro do dispositivo. Portanto, a política deve ter acesso de leitura ao registro. Para tokens do Hub IoT, a política faz parte do SAS.

az iot hub generate-sas-token [--auth-type {key, login}]
                              [--connection-string]
                              [--device-id]
                              [--du]
                              [--hub-name]
                              [--key-type {primary, secondary}]
                              [--login]
                              [--module-id]
                              [--pn]
                              [--resource-group]

Exemplos

Gere um token SAS do Hub IoT usando a política iothubowner e a chave primária.

az iot hub generate-sas-token -n {iothub_name}

Gere um token SAS do Hub IoT usando a política registryRead e a chave secundária.

az iot hub generate-sas-token -n {iothub_name} --policy registryRead --key-type secondary

Gere um token SAS de dispositivo usando a política iothubowner para acessar o registro do dispositivo {iothub_name}.

az iot hub generate-sas-token -d {device_id} -n {iothub_name}

Gerar um token SAS de dispositivo usando uma cadeia de conexão do Hub IoT (com acesso ao Registro)

az iot hub generate-sas-token -d {device_id} --login 'HostName=myhub.azure-devices.net;SharedAccessKeyName=iothubowner;SharedAccessKey=12345'

Gerar um token SAS do Hub Iot usando uma cadeia de conexão do Hub IoT

az iot hub generate-sas-token --connection-string 'HostName=myhub.azure-devices.net;SharedAccessKeyName=iothubowner;SharedAccessKey=12345'

Gerar um token SAS de dispositivo usando uma cadeia de conexão de dispositivo

az iot hub generate-sas-token --connection-string 'HostName=myhub.azure-devices.net;DeviceId=mydevice;SharedAccessKeyName=iothubowner;SharedAccessKey=12345'

Gerar um token SAS de módulo usando uma cadeia de conexão de módulo

az iot hub generate-sas-token --connection-string 'HostName=myhub.azure-devices.net;DeviceId=mydevice;ModuleId=mymodule;SharedAccessKeyName=iothubowner;SharedAccessKey=12345'

Parâmetros Opcionais

--auth-type

Indica se a operação deve derivar automaticamente uma chave de política ou usar a sessão atual do Azure AD. Se o tipo de autenticação for login e o nome de host do recurso for fornecido, a pesquisa de recursos será ignorada, a menos que necessário. Você pode configurar o padrão usando az configure --defaults iothub-data-auth-type=<auth-type-value>.

Valores aceites: key, login

Default value: key

--connection-string --cs

Cadeia de conexão de destino. Isso ignora o registro do Hub IoT e gera o token SAS diretamente da chave simétrica fornecida sem validação adicional. Todos os outros parâmetros de comando, além da duração, serão ignorados. Tipos de cadeia de conexão suportados: Iot Hub, Dispositivo, Módulo.

--device-id -d

ID do dispositivo de destino.

--du --duration

Duração válida do token em segundos.

Default value: 3600

--hub-name -n

Nome ou nome do host do Hub IoT. Obrigatório se --login não for fornecido.

--key-type --kt

Tipo de chave de política de acesso compartilhado para autenticação.

Valores aceites: primary, secondary

Default value: primary

--login -l

Este comando suporta uma cadeia de conexão de entidade com direitos para executar a ação. Use para evitar login de sessão via "az login". Se uma cadeia de conexão de entidade e um nome forem fornecidos, a cadeia de conexão terá prioridade. Obrigatório se --hub-name não for fornecido.

--module-id -m

ID do módulo de destino.

--pn --policy-name

Política de acesso compartilhado com permissões de operação para a entidade do Hub IoT de destino.

Default value: iothubowner

--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 invoke-device-method

Invoque um método de dispositivo.

az iot hub invoke-device-method --device-id
                                --method-name
                                [--auth-type {key, login}]
                                [--hub-name]
                                [--login]
                                [--method-payload]
                                [--resource-group]
                                [--timeout]

Exemplos

Invoque um método direto em um dispositivo.

az iot hub invoke-device-method --hub-name {iothub_name} --device-id {device_id} --method-name Reboot --method-payload '{"version":"1.0"}'

Parâmetros Obrigatórios

--device-id -d

ID do dispositivo de destino.

--method-name --mn

Método de destino para invocação.

Parâmetros Opcionais

--auth-type

Valores aceites: key, login

Default value: key

--hub-name -n

Nome ou nome do host do Hub IoT. Obrigatório se --login não for fornecido.

--login -l

--method-payload --mp

Carga útil Json a ser passada para o método. Deve ser caminho do arquivo ou json bruto.

Default value: {}

--resource-group -g

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

--timeout --to

Número máximo de segundos para aguardar o resultado do método do dispositivo.

Default value: 30

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 invoke-module-method

Invoque um método de módulo.

Este comando suporta módulos de dispositivo de borda e não-borda.

az iot hub invoke-module-method --device-id
                                --method-name
                                --module-id
                                [--auth-type {key, login}]
                                [--hub-name]
                                [--login]
                                [--method-payload]
                                [--resource-group]
                                [--timeout]

Exemplos

Invoque um método direto em um módulo de dispositivo de borda.

az iot hub invoke-module-method -n {iothub_name} -d {device_id} -m '$edgeAgent' --method-name 'RestartModule' --method-payload '{"schemaVersion": "1.0"}'

Parâmetros Obrigatórios

--device-id -d

ID do dispositivo de destino.

--method-name --mn

Método de destino para invocação.

--module-id -m

ID do módulo de destino.

Parâmetros Opcionais

--auth-type

Valores aceites: key, login

Default value: key

--hub-name -n

Nome ou nome do host do Hub IoT. Obrigatório se --login não for fornecido.

--login -l

--method-payload --mp

Carga útil Json a ser passada para o método. Deve ser caminho do arquivo ou json bruto.

Default value: {}

--resource-group -g

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

--timeout --to

Número máximo de segundos para aguardar o resultado do método do módulo.

Default value: 30

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 list

Editar

Listar hubs IoT.

az iot hub list [--resource-group]

Exemplos

Liste todos os hubs IoT em uma assinatura.

az iot hub list

Listar todos os hubs IoT no grupo de recursos 'MyGroup'

az iot hub list --resource-group MyGroup

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.

az iot hub list-skus

Editar

Listar os níveis de preços disponíveis.

az iot hub list-skus [--ids]
                     [--name]
                     [--resource-group]
                     [--subscription]

Exemplos

Listar os níveis de preços disponíveis. (gerado automaticamente)

az iot hub list-skus --name MyIoTHub

Parâmetros Opcionais

--ids

--name -n

Nome do Hub IoT.

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

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

Editar

Inicie um failover manual do Hub IoT para a região de recuperação de desastres emparelhada geograficamente.

az iot hub manual-failover [--ids]
                           [--name]
                           [--no-wait]
                           [--resource-group]
                           [--subscription]

Exemplos

Inicie o failover "myhub" da região primária para a secundária.

az iot hub manual-failover -n myhub

Parâmetros Opcionais

--ids

--name -n

Nome do Hub IoT.

--no-wait

Não espere que a operação de longa duração termine.

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

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

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

Monitore a telemetria do dispositivo e as mensagens enviadas para um Hub IoT.

Este comando depende e pode instalar o pacote Cython dependente (uamqp) na primeira execução. https://github.com/Azure/azure-uamqp-python

Nota: O evento será exibido mesmo que o corpo da mensagem não seja decodificável unicode, neste caso, a parte de carga útil do evento será exibida como {{carga útil não decodificável}} com o restante das propriedades do evento disponíveis.

az iot hub monitor-events [--cg]
                          [--content-type]
                          [--device-id]
                          [--device-query]
                          [--enqueued-time]
                          [--hub-name]
                          [--interface]
                          [--login]
                          [--mc]
                          [--module-id]
                          [--properties {all, anno, app, sys}]
                          [--repair {false, true}]
                          [--resource-group]
                          [--timeout]
                          [--yes {false, true}]

Exemplos

Utilização básica

az iot hub monitor-events -n {iothub_name}

Uso básico com uma cadeia de conexão do Hub IoT

az iot hub monitor-events -n {iothub_name} --login 'HostName=myhub.azure-devices.net;SharedAccessKeyName=iothubowner;SharedAccessKey=12345'

Uso básico ao filtrar no dispositivo alvo

az iot hub monitor-events -n {iothub_name} -d {device_id}

Uso básico ao filtrar dispositivos de destino com um curinga no ID

az iot hub monitor-events -n {iothub_name} -d Device*

Filtrar dispositivos usando a linguagem de consulta do Hub IoT

az iot hub monitor-events -n {iothub_name} -q "select * from devices where tags.location.region = 'US'"

Filtre o dispositivo e especifique um grupo de consumidores do Hub de Eventos ao qual se vincular.

az iot hub monitor-events -n {iothub_name} -d {device_id} --cg {consumer_group_name}

Receber anotações de mensagens (cabeçalhos de mensagens)

az iot hub monitor-events -n {iothub_name} -d {device_id} --properties anno

Receber anotações de mensagem + propriedades do sistema. Nunca perca tempo.

az iot hub monitor-events -n {iothub_name} -d {device_id} --properties anno sys --timeout 0

Receber todos os atributos de mensagem de todas as mensagens do dispositivo

az iot hub monitor-events -n {iothub_name} --props all

Receba todas as mensagens e analise a carga útil da mensagem como JSON

az iot hub monitor-events -n {iothub_name} --content-type application/json

Receba o número especificado de mensagens do hub e, em seguida, desligue.

az iot hub monitor-events -n {iothub_name} --message-count {message_count}

Parâmetros Opcionais

--cg --consumer-group -c

Especifique o grupo de consumidores a ser usado ao se conectar ao ponto de extremidade do hub de eventos.

Default value: $Default

--content-type --ct

Especifique o Content-Type da carga útil da mensagem para formatar automaticamente a saída para esse tipo.

--device-id -d

ID do dispositivo de destino.

--device-query -q

Especifique uma consulta personalizada para filtrar dispositivos.

--enqueued-time --et -e

Indica o tempo que deve ser usado como ponto de partida para ler mensagens das partições. As unidades são milissegundos desde a época unix. Se nenhum tempo for indicado, "agora" é usado.

--hub-name -n

Nome ou nome do host do Hub IoT. Obrigatório se --login não for fornecido.

--interface -i

Identificador da interface de destino para filtrar. Por exemplo: dtmi:com:example:TemperatureController;1.

--login -l

--mc --message-count

Número de mensagens de telemetria a serem capturadas antes que o monitor seja encerrado. Se não for especificado, o monitor continuará em execução até atingir o limite de tempo limite de não receber mensagens do hub.

--module-id -m

ID do módulo de destino.

--properties --props -p

Indique as propriedades da mensagem-chave para a saída. sys = propriedades do sistema, app = propriedades do aplicativo, anno = anotações.

Valores aceites: all, anno, app, sys

--repair -r

Reinstale a dependência uamqp compatível com a versão da extensão. Predefinição: false.

Valores aceites: false, true

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

--timeout --to -t

Máximo de segundos para manter a conexão sem receber mensagem. Use 0 para o infinito.

Default value: 300

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

Default value: False

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

Monitore os comentários enviados pelos dispositivos para reconhecer mensagens C2D (Cloud-to-Device).

Este comando depende e pode instalar o pacote Cython dependente (uamqp) na primeira execução. https://github.com/Azure/azure-uamqp-python.

az iot hub monitor-feedback [--auth-type {key, login}]
                            [--device-id]
                            [--hub-name]
                            [--login]
                            [--repair {false, true}]
                            [--resource-group]
                            [--wait-on-msg]
                            [--yes {false, true}]

Exemplos

Utilização básica

az iot hub monitor-feedback -n {iothub_name}

Uso básico com uma cadeia de conexão do Hub IoT

az iot hub monitor-feedback -n {iothub_name} --login 'HostName=myhub.azure-devices.net;SharedAccessKeyName=iothubowner;SharedAccessKey=12345'

Uso básico ao filtrar no dispositivo alvo

az iot hub monitor-feedback -n {iothub_name} -d {device_id}

Sair do monitor de feedback ao receber uma mensagem com id específico (uuid)

az iot hub monitor-feedback -n {iothub_name} -d {device_id} -w {message_id}

Parâmetros Opcionais

--auth-type

Valores aceites: key, login

Default value: key

--device-id -d

ID do dispositivo de destino.

--hub-name -n

Nome ou nome do host do Hub IoT. Obrigatório se --login não for fornecido.

--login -l

--repair -r

Reinstale a dependência uamqp compatível com a versão da extensão. Predefinição: false.

Valores aceites: false, true

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

--wait-on-msg -w

O monitor de feedback será bloqueado até que uma mensagem com id específico (uuid) seja recebida.

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

Default value: False

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 query

Consulte um Hub IoT usando uma poderosa linguagem semelhante ao SQL.

Recupere informações sobre gêmeos de dispositivo e módulo, trabalhos e roteamento de mensagens. Consulte https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language para obter mais informações.

az iot hub query --query-command
                 [--auth-type {key, login}]
                 [--hub-name]
                 [--login]
                 [--resource-group]
                 [--top]

Exemplos

Consulte todos os dados gêmeos de dispositivo em um Hub IoT do Azure.

az iot hub query -n {iothub_name} -q "select * from devices"

Consulte todos os dados gêmeos do módulo no dispositivo de destino.

az iot hub query -n {iothub_name} -q "select * from devices.modules where devices.deviceId = '{device_id}'"

Parâmetros Obrigatórios

--query-command -q

Consulta de usuário a ser executada.

Parâmetros Opcionais

--auth-type

Valores aceites: key, login

Default value: key

--hub-name -n

Nome ou nome do host do Hub IoT. Obrigatório se --login não for fornecido.

--login -l

--resource-group -g

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

--top

Número máximo de elementos a devolver. Por padrão, a consulta não tem limite.

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 show

Editar

Obtenha os detalhes de um hub IoT.

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

Exemplos

Obtenha os detalhes de um hub IoT. (gerado automaticamente)

az iot hub show --name MyIoTHub

Parâmetros Opcionais

--ids

--name -n

Nome do Hub IoT.

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

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 show-connection-string

Editar

Preterido

Este comando foi preterido e será removido em uma versão futura. Use 'IoT Extension (azure-iot) connection-string command (az iot hub connection-string show)' em vez disso.

Mostrar as cadeias de conexão para um hub IoT.

az iot hub show-connection-string [--all]
                                  [--hub-name]
                                  [--ids]
                                  [--key {primary, secondary}]
                                  [--policy-name]
                                  [--resource-group]
                                  [--subscription]

Exemplos

Mostrar a cadeia de conexão de um hub IoT usando a política padrão e a chave primária.

az iot hub show-connection-string --name MyIotHub

Mostrar a cadeia de conexão de um Hub IoT usando 'serviço' de política e chave secundária.

az iot hub show-connection-string --name MyIotHub --policy-name service --key secondary

Mostrar as cadeias de conexão para todos os hubs IoT em um grupo de recursos.

az iot hub show-connection-string --resource-group MyResourceGroup

Mostrar as cadeias de conexão para todos os hubs IoT em uma assinatura.

az iot hub show-connection-string

Mostrar as cadeias de conexão para um hub IoT. (gerado automaticamente)

az iot hub show-connection-string --key primary --policy-name MyPolicy

Parâmetros Opcionais

--all

Permitir mostrar todas as políticas de acesso compartilhado.

Default value: False

--hub-name --name -n

Nome do Hub IoT.

--ids

--key

A chave a ser usada.

Valores aceites: primary, secondary

Default value: primary

--policy-name

Política de acesso compartilhado a ser usada.

Default value: iothubowner

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

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 show-quota-metrics

Editar

Obtenha as métricas de cota para um hub IoT.

az iot hub show-quota-metrics [--ids]
                              [--name]
                              [--resource-group]
                              [--subscription]

Exemplos

Obtenha as métricas de cota para um hub IoT. (gerado automaticamente)

az iot hub show-quota-metrics --ids {ids}

Obtenha as métricas de cota para um hub IoT. (gerado automaticamente)

az iot hub show-quota-metrics --name MyIoTHub

Parâmetros Opcionais

--ids

--name -n

Nome do Hub IoT.

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

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

Editar

Obtenha as estatísticas de um hub IoT.

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

Exemplos

Obtenha as estatísticas de um hub IoT. (gerado automaticamente)

az iot hub show-stats --name MyIoTHub

Parâmetros Opcionais

--ids

--name -n

Nome do Hub IoT.

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

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 update

Editar

Atualizar metadados para um hub IoT.

az iot hub update [--add]
                  [--c2d-max-delivery-count]
                  [--c2d-ttl]
                  [--dds {false, true}]
                  [--disable-local-auth {false, true}]
                  [--disable-module-sas {false, true}]
                  [--fc]
                  [--fcs]
                  [--fd]
                  [--feedback-lock-duration]
                  [--feedback-ttl]
                  [--fileupload-notification-lock-duration]
                  [--fileupload-notification-max-delivery-count]
                  [--fileupload-notification-ttl]
                  [--fileupload-notifications {false, true}]
                  [--fileupload-sas-ttl]
                  [--fileupload-storage-auth-type {identityBased, keyBased}]
                  [--fileupload-storage-identity]
                  [--force-string]
                  [--ids]
                  [--name]
                  [--rd]
                  [--remove]
                  [--resource-group]
                  [--set]
                  [--sku {B1, B2, B3, F1, S1, S2, S3}]
                  [--subscription]
                  [--tags]
                  [--unit]

Exemplos

Adicionar configurações de contêiner de armazenamento ao upload de arquivos

az iot hub update --name MyIotHub --fileupload-storage-connectionstring "connection-string" \ --fileupload-storage-container-name "container_name"

Adicione uma regra de filtro de firewall para aceitar o tráfego da máscara de IP 127.0.0.0/31.

az iot hub update --name MyIotHub --add properties.ipFilterRules filter_name=test-rule action=Accept ip_mask=127.0.0.0/31

Atualizar metadados para um hub IoT. (gerado automaticamente)

az iot hub update --name MyIotHub --set properties.allocationPolicy="GeoLatency"

Atualizar unidades de um Hub IoT para 2 e adicionar tags

az iot hub update -n MyIotHub --unit 2 --tags a=b c=d

Atualizar a camada de preços para um Hub IoT como S2

az iot hub update -n MyIotHub --sku S2

Atualize os dias de retenção de eventos de dispositivo para nuvem do Hub IoT como 3 dias

az iot hub update -n MyIotHub --retention-day 3

Atualizar as configurações de mensagens da nuvem para o dispositivo do Hub IoT

az iot hub update --name MyIotHub --c2d-max-delivery-count 30 --c2d-ttl 5

Atualizar as configurações da fila de comentários do Hub IoT

az iot hub update --name MyIoTHub --feedback-max-delivery-count 20 --feedback-lock-duration 100 --feedback-ttl 4

Atualizar as configurações de carregamento de arquivos do Hub IoT e atribuir uma identidade gerenciada ao usuário para upload de arquivos

az iot hub update -n MyIoTHub --fileupload-sas-ttl 5 --fileupload-storage-auth-type identityBased --fileupload-storage-identity [system]

Atualizar as configurações de notificação de carregamento de arquivos do Hub IoT e a duração do bloqueio da fila

az iot hub update -n MyIoTHub --fileupload-notification-max-delivery-count 50 --fileupload-notification-ttl 48 --fileupload-notifications --fileupload-notification-lock-duration 10

Atualizar as configurações de autenticação local do Hub IoT, SAS de dispositivo e SAS de módulo

az iot hub update -n MyIoTHub --disable-local-auth --disable-device-sas false --disable-module-sas true

Parâmetros Opcionais

--add

Adicione um objeto a uma lista de objetos especificando um caminho e pares de valor de chave. Exemplo: --add property.listProperty <key=value, string or JSON string>.

Default value: []

--c2d-max-delivery-count --cdd

O número de vezes que o hub IoT tentará entregar uma mensagem da nuvem para o dispositivo para um dispositivo, entre 1 e 100.

--c2d-ttl --ct

A quantidade de tempo que uma mensagem está disponível para o dispositivo consumir antes de expirar pelo Hub IoT, entre 1 e 48 horas.

--dds --disable-device-sas

Um booleano que indica se todos os dispositivos devem ou não ser desabilitados (incluindo dispositivos de Borda, mas excluindo módulos) com escopo de chaves SAS para autenticação.

Valores aceites: false, true

--disable-local-auth --dla

Um booleano que indica se as chaves SAS com escopo do hub IoT devem ou não ser desabilitadas para autenticação.

Valores aceites: false, true

--disable-module-sas --dms

Um booleano que indica se as chaves SAS com escopo de módulo devem ou não ser desabilitadas para autenticação.

Valores aceites: false, true

--fc --fileupload-storage-container-name

O nome do contêiner raiz onde você carrega arquivos. O contêiner não precisa existir, mas deve ser criável usando o connectionString especificado.

--fcs --fileupload-storage-connectionstring

A cadeia de conexão para a conta de Armazenamento do Azure para a qual os arquivos são carregados.

--fd --feedback-max-delivery-count

O número de vezes que o hub IoT tenta entregar uma mensagem na fila de feedback, entre 1 e 100.

--feedback-lock-duration --fld

A duração do bloqueio para a fila de comentários, entre 5 e 300 segundos.

--feedback-ttl --ft

O período de tempo durante o qual o hub IoT manterá o feedback para expiração ou entrega de mensagens da nuvem para o dispositivo, entre 1 e 48 horas.

--fileupload-notification-lock-duration --fnld

A duração do bloqueio para a fila de notificações de upload de arquivo, entre 5 e 300 segundos.

--fileupload-notification-max-delivery-count --fnd

O número de vezes que o hub IoT tentará entregar uma mensagem de notificação de arquivo, entre 1 e 100.

--fileupload-notification-ttl --fnt

A quantidade de tempo que uma notificação de carregamento de arquivo está disponível para o serviço consumir antes de expirar pelo Hub IoT, entre 1 e 48 horas.

--fileupload-notifications --fn

Um booleano que indica se as informações sobre arquivos carregados devem ser registradas no ponto de extremidade do Hub IoT messages/servicebound/filenotifications.

Valores aceites: false, true

--fileupload-sas-ttl --fst

A quantidade de tempo que um URI SAS gerado pelo Hub IoT é válido antes de expirar, entre 1 e 24 horas.

--fileupload-storage-auth-type --fsa

O tipo de autenticação para a conta de Armazenamento do Azure para a qual os arquivos são carregados.

Valores aceites: identityBased, keyBased

--fileupload-storage-identity --fsi

--force-string

Ao usar 'set' ou 'add', preserve literais de string em vez de tentar converter para JSON.

Default value: False

--ids

--name -n

Nome do Hub IoT.

--rd --retention-day

Especifica por quanto tempo esse hub IoT manterá eventos de dispositivo para nuvem, entre 1 e 7 dias.

--remove

Remova uma propriedade ou um elemento de uma lista. Exemplo: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Default value: []

--resource-group -g

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

--set

Atualize um objeto especificando um caminho de propriedade e um valor a ser definido. Exemplo: --set property1.property2=<value>.

Default value: []

--sku

Valores aceites: B1, B2, B3, F1, S1, S2, S3

--subscription

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

--tags

Tags separadas por espaço: key[=value] [key[=value] ...]. Use "" para limpar tags existentes.

--unit

Unidades no seu Hub IoT.

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 wait

Editar

Aguarde até que uma operação em uma instância do Hub IoT seja concluída.

az iot hub wait [--created]
                [--custom]
                [--deleted]
                [--exists]
                [--ids]
                [--interval]
                [--name]
                [--resource-group]
                [--subscription]
                [--timeout]
                [--updated]

Exemplos

Aguarde até que uma instância existente do Hub IoT seja criada

az iot hub wait -n MyIoTHub --created

Aguarde até que uma instância do Hub IoT seja excluída

az iot hub wait -n MyIoTHub --deleted

Aguarde até que uma instância existente do Hub IoT tenha um estado Ativo

az iot hub wait -n MyIoTHub --custom "properties.state=='Active'"

Parâmetros Opcionais

--created

Aguarde até ser criado com 'provisioningState' em 'Succeeded'.

Default value: False

--custom

Aguarde até que a condição satisfaça uma consulta JMESPath personalizada. Por exemplo, provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Aguarde até ser excluído.

Default value: False

--exists

Aguarde até que o recurso exista.

Default value: False

--ids

--interval

Intervalo de sondagem em segundos.

Default value: 30

--name -n

Nome do Hub IoT.

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

--timeout

Espera máxima em segundos.

Default value: 3600

--updated

Aguarde até ser atualizado com provisioningState em 'Succeeded'.

Default value: False

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.

Partilhar via

az iot hub

Comandos

az iot hub create

Exemplos

Parâmetros Obrigatórios

Parâmetros Opcionais

az iot hub delete

Exemplos

Parâmetros Opcionais

az iot hub generate-sas-token

Exemplos

Parâmetros Opcionais

az iot hub invoke-device-method

Exemplos

Parâmetros Obrigatórios

Parâmetros Opcionais

az iot hub invoke-module-method

Exemplos

Parâmetros Obrigatórios

Parâmetros Opcionais

az iot hub list

Exemplos

Parâmetros Opcionais

az iot hub list-skus

Exemplos

Parâmetros Opcionais

az iot hub manual-failover

Exemplos

Parâmetros Opcionais

az iot hub monitor-events

Exemplos

Parâmetros Opcionais

az iot hub monitor-feedback

Exemplos

Parâmetros Opcionais

az iot hub query

Exemplos

Parâmetros Obrigatórios

Parâmetros Opcionais

az iot hub show

Exemplos

Parâmetros Opcionais

az iot hub show-connection-string

Exemplos

Parâmetros Opcionais

az iot hub show-quota-metrics

Exemplos

Parâmetros Opcionais

az iot hub show-stats

Exemplos

Parâmetros Opcionais

az iot hub update

Exemplos

Parâmetros Opcionais

az iot hub wait

Exemplos

Parâmetros Opcionais

Recursos adicionais