az iot hub
Observação
Esse 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 os hubs IoT do Azure.
Comandos
Nome | Description | Tipo | Status |
---|---|---|---|
az iot hub certificate |
Gerenciar certificados do Hub IoT. |
Núcleo e Extensão | GA |
az iot hub certificate create |
Criar/carregar um certificado do Hub IoT do Azure. |
Núcleo | GA |
az iot hub certificate delete |
Exclui um certificado do Hub IoT do Azure. |
Núcleo | GA |
az iot hub certificate generate-verification-code |
Gera um código de verificação para um certificado do Hub IoT do Azure. |
Núcleo | GA |
az iot hub certificate list |
Lista todos os certificados contidos em um Hub IoT do Azure. |
Núcleo | GA |
az iot hub certificate root-authority |
Gerenciar 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. |
Núcleo | GA |
az iot hub certificate update |
Atualize um certificado do Hub IoT do Azure. |
Núcleo | GA |
az iot hub certificate verify |
Verifica um certificado do Hub IoT do Azure. |
Núcleo | GA |
az iot hub configuration |
Gerenciar a configuração automática de gerenciamento de dispositivos da 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 |
Listar 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 uma métrica de usuário ou sistema de destino 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 |
Gerenciar cadeias de conexão do Hub IoT. |
Extensão | GA |
az iot hub connection-string show |
Mostre as cadeias de conexão para os Hubs IoT especificados usando o nome e a chave de política fornecidos. |
Extensão | GA |
az iot hub consumer-group |
Gerencie os grupos de consumidores do hub de eventos de um hub IoT. |
Núcleo | GA |
az iot hub consumer-group create |
Crie um grupo de consumidores do hub de eventos. |
Núcleo | GA |
az iot hub consumer-group delete |
Excluir um grupo de consumidores do hub de eventos. |
Núcleo | GA |
az iot hub consumer-group list |
Listar grupos de consumidores do hub de eventos. |
Núcleo | GA |
az iot hub consumer-group show |
Obtenha os detalhes de um grupo de consumidores do hub de eventos. |
Núcleo | GA |
az iot hub create |
Crie um hub IoT do Azure. |
Núcleo | GA |
az iot hub delete |
Exclua um hub IoT. |
Núcleo | GA |
az iot hub device-identity |
Gerenciar dispositivos IoT. |
Extensão | GA |
az iot hub device-identity children |
Gerencie relacionamentos de dispositivos filhos para dispositivos de borda de IoT. |
Extensão | GA |
az iot hub device-identity children add |
Adicione dispositivos como filhos a um dispositivo de borda de destino. |
Extensão | GA |
az iot hub device-identity children list |
Gera a coleta 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 |
Gerenciar 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 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 |
Gerenciar relacionamentos de dispositivo 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 |
Gerenciar a configuração do dispositivo gêmeo 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 de gêmeo do dispositivo pelo json de destino. |
Extensão | GA |
az iot hub device-twin show |
Obtenha uma definição de gêmeo de dispositivo. |
Extensão | GA |
az iot hub device-twin update |
Atualize as propriedades e tags desejadas do gêmeo do dispositivo. |
Extensão | GA |
az iot hub devicestream |
Gerenciar fluxos de dispositivo de um Hub IoT. |
Núcleo | Visualizar |
az iot hub devicestream show |
Obtenha os pontos de extremidade de fluxos de dispositivo do Hub IoT. |
Núcleo | 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 |
Invocar um comando de nível de raiz ou componente de um dispositivo de gêmeo digital. |
Extensão | GA |
az iot hub digital-twin show |
Mostrar 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 de gêmeo digital por meio da especificação de patch JSON. |
Extensão | GA |
az iot hub distributed-tracing |
Gerenciar configurações distribuídas por dispositivo. |
Extensão | Visualizar |
az iot hub distributed-tracing show |
Obtenha as configurações de rastreamento distribuído para um dispositivo. |
Extensão | Visualizar |
az iot hub distributed-tracing update |
Atualize as opções de rastreamento distribuído para um dispositivo. |
Extensão | 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 |
Gerenciar identidades de um hub IoT do Azure. |
Núcleo | GA |
az iot hub identity assign |
Atribua identidades gerenciadas a um Hub IoT. |
Núcleo | GA |
az iot hub identity remove |
Remover identidades gerenciadas de um Hub IoT. |
Núcleo | GA |
az iot hub identity show |
Mostrar as propriedades de identidade de um Hub IoT. |
Núcleo | 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 |
Listar 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. |
Núcleo | GA |
az iot hub list-skus |
Listar os tipos de preço disponíveis. |
Núcleo | GA |
az iot hub manual-failover |
Inicie um failover manual para o Hub IoT para a região de recuperação de desastre geograficamente emparelhada. |
Núcleo | GA |
az iot hub message-endpoint |
Gerenciar pontos de extremidade personalizados de um Hub IoT. |
Extensão | Visualizar |
az iot hub message-endpoint create |
Adicione um ponto de extremidade a um Hub IoT. |
Extensão | 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 | Visualizar |
az iot hub message-endpoint create eventhub |
Adicione um ponto de extremidade do Hub de Eventos para um Hub IoT. |
Extensão | Visualizar |
az iot hub message-endpoint create servicebus-queue |
Adicione um ponto de extremidade da Fila do Barramento de Serviço para um Hub IoT. |
Extensão | Visualizar |
az iot hub message-endpoint create servicebus-topic |
Adicione um ponto de extremidade do Tópico do Barramento de Serviço para um Hub IoT. |
Extensão | 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 | Visualizar |
az iot hub message-endpoint delete |
Exclua todo ou um ponto de extremidade específico de um Hub IoT. |
Extensão | Visualizar |
az iot hub message-endpoint list |
Obtenha informações sobre todos os pontos de extremidade de um Hub IoT. |
Extensão | Visualizar |
az iot hub message-endpoint show |
Obtenha informações sobre o ponto de extremidade mencionado para um Hub IoT. |
Extensão | Visualizar |
az iot hub message-endpoint update |
Atualize as propriedades de um ponto de extremidade existente para um Hub IoT. |
Extensão | 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 | 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 | Visualizar |
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. |
Extensão | Visualizar |
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. |
Extensão | 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 | Visualizar |
az iot hub message-enrichment |
Gerenciar enriquecimentos de mensagens para pontos de extremidade de um Hub IoT. |
Núcleo | GA |
az iot hub message-enrichment create |
Crie um enriquecimento de mensagens para pontos de extremidade escolhidos em seu Hub IoT. |
Núcleo | GA |
az iot hub message-enrichment delete |
Exclua um enriquecimento de mensagem em seu hub IoT (por chave). |
Núcleo | GA |
az iot hub message-enrichment list |
Obtenha informações sobre todos os enriquecimentos de mensagens para o seu Hub IoT. |
Núcleo | GA |
az iot hub message-enrichment update |
Atualize um enriquecimento de mensagem em seu hub IoT (por chave). |
Núcleo | GA |
az iot hub message-route |
Gerenciar rotas de um Hub IoT. |
Extensão | Visualizar |
az iot hub message-route create |
Adicione uma rota para um Hub IoT. |
Extensão | Visualizar |
az iot hub message-route delete |
Exclua todas as rotas ou uma rota mencionada em um Hub IoT. |
Extensão | Visualizar |
az iot hub message-route fallback |
Gerenciar a rota de fallback de um hub IoT. |
Extensão | Visualizar |
az iot hub message-route fallback set |
Habilite ou desabilite a rota de fallback em um Hub IoT. |
Extensão | Visualizar |
az iot hub message-route fallback show |
Mostrar a rota de fallback de um Hub IoT. |
Extensão | Visualizar |
az iot hub message-route list |
Obtenha todas as rotas em um Hub IoT. |
Extensão | Visualizar |
az iot hub message-route show |
Obtenha informações sobre a rota em um Hub IoT. |
Extensão | Visualizar |
az iot hub message-route test |
Teste todas as rotas ou uma rota mencionada em um Hub IoT. |
Extensão | Visualizar |
az iot hub message-route update |
Atualize uma rota para um Hub IoT. |
Extensão | Visualizar |
az iot hub module-identity |
Gerenciar módulos de dispositivo 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 |
Listar 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 |
Gerenciar a configuração do módulo gêmeo do 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 gêmeo de módulo. |
Extensão | GA |
az iot hub module-twin update |
Atualize as propriedades e tags desejadas do módulo twin. |
Extensão | GA |
az iot hub monitor-events |
Monitorar mensagens de telemetria de dispositivo e enviadas a um Hub IoT. |
Extensão | GA |
az iot hub monitor-feedback |
Monitore os comentários enviados por dispositivos para reconhecer mensagens da nuvem para dispositivo (C2D). |
Extensão | GA |
az iot hub policy |
Gerenciar políticas de acesso compartilhado de um Hub IoT. |
Núcleo | GA |
az iot hub policy create |
Crie uma nova política de acesso compartilhado em um hub IoT. |
Núcleo | GA |
az iot hub policy delete |
Exclua uma política de acesso compartilhado de um hub IoT. |
Núcleo | GA |
az iot hub policy list |
Listar políticas de acesso compartilhado de um hub IoT. |
Núcleo | GA |
az iot hub policy renew-key |
Regenerar chaves de uma política de acesso compartilhado de um hub IoT. |
Núcleo | GA |
az iot hub policy show |
Obtenha os detalhes de uma política de acesso compartilhado de um hub IoT. |
Núcleo | GA |
az iot hub query |
Confira um Hub IoT usando uma linguagem avançada semelhante a SQL. |
Extensão | GA |
az iot hub route |
Gerenciar rotas de um Hub IoT. |
Núcleo | Preterido |
az iot hub route create |
Crie uma rota no Hub IoT. |
Núcleo | Preterido |
az iot hub route delete |
Exclua toda a rota mencionada ou mencionada para seu Hub IoT. |
Núcleo | Preterido |
az iot hub route list |
Obtenha todas as rotas no Hub IoT. |
Núcleo | Preterido |
az iot hub route show |
Obtenha informações sobre a rota no Hub IoT. |
Núcleo | Preterido |
az iot hub route test |
Teste todas as rotas ou rotas mencionadas no Hub IoT. |
Núcleo | Preterido |
az iot hub route update |
Atualizar uma rota no Hub IoT. |
Núcleo | Preterido |
az iot hub routing-endpoint |
Gerenciar pontos de extremidade personalizados de um Hub IoT. |
Núcleo | Preterido |
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 show |
Obtenha os detalhes de um hub IoT. |
Núcleo | GA |
az iot hub show-connection-string |
Mostrar as cadeias de conexão de um hub IoT. |
Núcleo | Preterido |
az iot hub show-quota-metrics |
Obtenha as métricas de cota para um hub IoT. |
Núcleo | GA |
az iot hub show-stats |
Obtenha as estatísticas de um hub IoT. |
Núcleo | GA |
az iot hub state |
Gerenciar o estado de um Hub IoT. |
Extensão | Habilitação |
az iot hub state export |
Exporte o estado de um Hub IoT para um arquivo. |
Extensão | Habilitação |
az iot hub state import |
Importe um estado de Hub de um arquivo para um Hub IoT. |
Extensão | Habilitação |
az iot hub state migrate |
Migre o estado de um hub para outro hub sem salvar em um arquivo. |
Extensão | Habilitação |
az iot hub update |
Atualizar metadados para um hub IoT. |
Núcleo | GA |
az iot hub wait |
Aguarde até que uma operação em uma instância do Hub IoT seja concluída. |
Núcleo | GA |
az iot hub create
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ço gratuito 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 S1 e 4 da camada de preços padrão, 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 pelo 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}
Criar 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 desabilitará a recuperação de desastres entre regiões.
az iot hub create --resource-group MyResourceGroup --name MyIoTHub --edr
Parâmetros Exigidos
Nome do Hub IoT.
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
Parâmetros Opcionais
O número de vezes que o hub IoT tentará entregar uma mensagem de nuvem para dispositivo para um dispositivo, entre 1 e 100.
A quantidade de tempo que uma mensagem fica disponível para o dispositivo consumir antes de expirar pelo Hub IoT, entre 1 e 48 horas.
Um booleano indicando se todos os dispositivos (incluindo dispositivos de Borda, mas excluindo módulos) devem ou não desabilitar chaves SAS com escopo para autenticação.
Um booleano indicando se as chaves SAS com escopo do hub IoT devem ou não ser desabilitadas para autenticação.
Um booleano indicando se as chaves SAS com escopo de módulo devem ou não ser desabilitadas para autenticação.
Imponha a residência de dados para esse Hub IoT desabilitando a recuperação de desastres entre regiões. Essa propriedade é imutável uma vez definida no recurso. Disponível apenas em regiões selecionadas. Saiba mais em https://aka.ms/iothubdisabledr.
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.
A cadeia de conexão da conta de Armazenamento do Azure na qual os arquivos são carregados.
O número de vezes que o hub IoT tenta entregar uma mensagem na fila de comentários, entre 1 e 100.
A duração do bloqueio para a fila de comentários, entre 5 e 300 segundos.
O período de tempo pelo qual o hub IoT manterá o feedback para expiração ou entrega de mensagens de nuvem para dispositivo, entre 1 e 48 horas.
A duração do bloqueio para a fila de notificações de upload de arquivos, entre 5 e 300 segundos.
O número de vezes que o hub IoT tentará entregar uma mensagem de notificação de arquivo, entre 1 e 100.
A quantidade de tempo que uma notificação de carregamento de arquivo fica disponível para o serviço consumir antes de expirar pelo Hub IoT, entre 1 e 48 horas.
Um booleano indicando se as informações sobre arquivos carregados devem ser registradas no ponto de extremidade do Hub IoT messages/servicebound/filenotifications.
A quantidade de tempo que um URI SAS gerado pelo Hub IoT é válido antes de expirar, entre 1 e 24 horas.
O tipo de autenticação da conta de Armazenamento do Azure para a qual os arquivos são carregados.
A identidade gerenciada a ser usada para autenticação de upload de arquivos. Use '[system]' para se referir à identidade gerenciada atribuída pelo sistema ou a uma ID de recurso para se referir a uma identidade gerenciada atribuída pelo usuário.
Localização do seu Hub IoT. O padrão é o local do grupo de recursos de destino.
Habilite a identidade gerenciada atribuída pelo sistema para esse hub.
Habilite identidades gerenciadas atribuídas pelo usuário para esse hub. Aceite a lista separada por espaço de IDs de recursos de identidade.
Especifique a versão TLS mínima para oferecer suporte a esse hub. Pode ser definido como "1.2" para que os clientes que usam uma versão TLS abaixo de 1.2 sejam rejeitados.
Não aguarde a conclusão da operação de execução longa.
O número de partições do Hub de Eventos de backup para mensagens do dispositivo para a nuvem.
Especifica por quanto tempo esse hub IoT manterá eventos de dispositivo para nuvem, entre 1 e 7 dias.
Função a ser atribuída à identidade gerenciada atribuída ao sistema do hub.
Lista separada por espaço de escopos para atribuir a função (--role) para a identidade gerenciada atribuída pelo sistema.
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.
Tags separadas por espaço: key[=value] [key[=value] ...]. Use "" para limpar as tags existentes.
Unidades em seu Hub IoT.
Parâmetros Globais
Aumente o detalhamento do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
Aumentar o detalhamento do log. Use --debug para logs de depuração completos.
az iot hub delete
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
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'.
Nome do Hub IoT.
Não aguarde a conclusão da operação de execução longa.
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
Parâmetros Globais
Aumente o detalhamento do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
Aumentar o detalhamento do log. 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 de política é 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 de 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 do módulo usando uma cadeia de conexão do 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
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 do 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>
o .
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.
ID do dispositivo de destino.
Duração do token válida em segundos.
Nome do Hub IoT ou nome do host. Obrigatório se --login não for fornecido.
Tipo de chave de política de acesso compartilhado para autenticação.
Esse comando oferece suporte a uma cadeia de conexão de entidade com direitos para executar ações. Use para evitar o login da 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.
ID do módulo de destino.
Política de acesso compartilhado com permissões de operação para a entidade do Hub IoT de destino.
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
Parâmetros Globais
Aumente o detalhamento do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
Aumentar o detalhamento do log. 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
Invocar 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 Exigidos
ID do dispositivo de destino.
Método de destino para invocação.
Parâmetros Opcionais
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 do 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>
o .
Nome do Hub IoT ou nome do host. Obrigatório se --login não for fornecido.
Esse comando oferece suporte a uma cadeia de conexão de entidade com direitos para executar ações. Use para evitar o login da 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.
Json carga útil a ser passada para o método. Deve ser caminho do arquivo ou JSON bruto.
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
Número máximo de segundos para aguardar o resultado do método do dispositivo.
Parâmetros Globais
Aumente o detalhamento do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
Aumentar o detalhamento do log. Use --debug para logs de depuração completos.
az iot hub invoke-module-method
Invoque um método de módulo.
Esse comando oferece suporte a 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
Chame 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 Exigidos
ID do dispositivo de destino.
Método de destino para invocação.
ID do módulo de destino.
Parâmetros Opcionais
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 do 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>
o .
Nome do Hub IoT ou nome do host. Obrigatório se --login não for fornecido.
Esse comando oferece suporte a uma cadeia de conexão de entidade com direitos para executar ações. Use para evitar o login da 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.
Json carga útil a ser passada para o método. Deve ser caminho do arquivo ou JSON bruto.
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
Número máximo de segundos para aguardar o resultado do método do módulo.
Parâmetros Globais
Aumente o detalhamento do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
Aumentar o detalhamento do log. Use --debug para logs de depuração completos.
az iot hub list
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
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
Parâmetros Globais
Aumente o detalhamento do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
Aumentar o detalhamento do log. Use --debug para logs de depuração completos.
az iot hub list-skus
Listar os tipos de preço disponíveis.
az iot hub list-skus [--ids]
[--name]
[--resource-group]
[--subscription]
Exemplos
Listar os tipos de preço disponíveis. (gerado automaticamente)
az iot hub list-skus --name MyIoTHub
Parâmetros Opcionais
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'.
Nome do Hub IoT.
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
Parâmetros Globais
Aumente o detalhamento do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
Aumentar o detalhamento do log. Use --debug para logs de depuração completos.
az iot hub manual-failover
Inicie um failover manual para o Hub IoT para a região de recuperação de desastre geograficamente emparelhada.
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
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'.
Nome do Hub IoT.
Não aguarde a conclusão da operação de execução longa.
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
Parâmetros Globais
Aumente o detalhamento do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
Aumentar o detalhamento do log. Use --debug para logs de depuração completos.
az iot hub monitor-events
Monitorar mensagens de telemetria de dispositivo e enviadas a 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 se o corpo da mensagem não for decodificável unicode, nesse caso, a parte da carga útil do evento será exibida como {{carga 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
Uso básico
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 de destino
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 expire.
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
Receber todas as mensagens e analisar a carga útil das mensagens como JSON
az iot hub monitor-events -n {iothub_name} --content-type application/json
Receba o número especificado de mensagens do hub e desligue.
az iot hub monitor-events -n {iothub_name} --message-count {message_count}
Parâmetros Opcionais
Especifique o grupo de consumidores a ser usado ao se conectar ao ponto de extremidade do hub de eventos.
Especifique o Content-Type da carga da mensagem para formatar automaticamente a saída para esse tipo.
ID do dispositivo de destino.
Especifique uma consulta personalizada para filtrar dispositivos.
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.
Nome do Hub IoT ou nome do host. Obrigatório se --login não for fornecido.
Identificador de interface de destino para filtrar. Por exemplo: dtmi:com:example:TemperatureController;1.
Esse comando oferece suporte a uma cadeia de conexão de entidade com direitos para executar ações. Use para evitar o login da 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.
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.
ID do módulo de destino.
Indique as propriedades da mensagem chave para a saída. sys = propriedades do sistema, app = propriedades do aplicativo, anno = anotações.
Reinstale a dependência uamqp compatível com a versão da extensão. Padrão: falso.
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
Máximo de segundos para manter a conexão sem receber mensagem. Use 0 para infinito.
Ignorar prompts do usuário. Indica aceitação da ação. Usado principalmente para cenários de automação. Padrão: falso.
Parâmetros Globais
Aumente o detalhamento do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
Aumentar o detalhamento do log. Use --debug para logs de depuração completos.
az iot hub monitor-feedback
Monitore os comentários enviados por dispositivos para reconhecer mensagens da nuvem para dispositivo (C2D).
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
Uso básico
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 de destino
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
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 do 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>
o .
ID do dispositivo de destino.
Nome do Hub IoT ou nome do host. Obrigatório se --login não for fornecido.
Esse comando oferece suporte a uma cadeia de conexão de entidade com direitos para executar ações. Use para evitar o login da 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.
Reinstale a dependência uamqp compatível com a versão da extensão. Padrão: falso.
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
O monitor de comentários será bloqueado até que uma mensagem com ID específico (uuid) seja recebida.
Ignorar prompts do usuário. Indica aceitação da ação. Usado principalmente para cenários de automação. Padrão: falso.
Parâmetros Globais
Aumente o detalhamento do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
Aumentar o detalhamento do log. Use --debug para logs de depuração completos.
az iot hub query
Confira um Hub IoT usando uma linguagem avançada semelhante a 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
Consultar todos os dados de 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 Exigidos
Consulta do usuário a ser executada.
Parâmetros Opcionais
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 do 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>
o .
Nome do Hub IoT ou nome do host. Obrigatório se --login não for fornecido.
Esse comando oferece suporte a uma cadeia de conexão de entidade com direitos para executar ações. Use para evitar o login da 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.
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
Número máximo de elementos a serem retornados. Por padrão, a consulta não tem limite.
Parâmetros Globais
Aumente o detalhamento do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
Aumentar o detalhamento do log. Use --debug para logs de depuração completos.
az iot hub show
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
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'.
Nome do Hub IoT.
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
Parâmetros Globais
Aumente o detalhamento do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
Aumentar o detalhamento do log. Use --debug para logs de depuração completos.
az iot hub show-connection-string
Esse comando foi preterido e será removido em uma versão futura. Em vez disso, use 'IoT Extension (azure-iot) connection-string command (az iot hub connection-string show)'.
Mostrar as cadeias de conexão de 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 a política 'serviço' e a 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 de todos os hubs IoT em uma assinatura.
az iot hub show-connection-string
Mostrar as cadeias de conexão de um hub IoT. (gerado automaticamente)
az iot hub show-connection-string --key primary --policy-name MyPolicy
Parâmetros Opcionais
Permitir mostrar todas as políticas de acesso compartilhado.
Nome do Hub IoT.
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'.
A chave a ser usada.
Política de acesso compartilhado a ser usada.
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
Parâmetros Globais
Aumente o detalhamento do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
Aumentar o detalhamento do log. Use --debug para logs de depuração completos.
az iot hub show-quota-metrics
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
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'.
Nome do Hub IoT.
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
Parâmetros Globais
Aumente o detalhamento do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
Aumentar o detalhamento do log. Use --debug para logs de depuração completos.
az iot hub show-stats
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
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'.
Nome do Hub IoT.
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
Parâmetros Globais
Aumente o detalhamento do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
Aumentar o detalhamento do log. Use --debug para logs de depuração completos.
az iot hub update
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 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 de nuvem para 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 carregamento 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 arquivo do Hub IoT e a duração do bloqueio de 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, SAS do dispositivo e SAS do módulo do Hub IoT
az iot hub update -n MyIoTHub --disable-local-auth --disable-device-sas false --disable-module-sas true
Parâmetros Opcionais
Adicione um objeto a uma lista de objetos especificando um caminho e pares de valores de chave. Exemplo: --add property.listProperty <key=value, string or JSON string>
.
O número de vezes que o hub IoT tentará entregar uma mensagem de nuvem para dispositivo para um dispositivo, entre 1 e 100.
A quantidade de tempo que uma mensagem fica disponível para o dispositivo consumir antes de expirar pelo Hub IoT, entre 1 e 48 horas.
Um booleano indicando se todos os dispositivos (incluindo dispositivos de Borda, mas excluindo módulos) devem ou não desabilitar chaves SAS com escopo para autenticação.
Um booleano indicando se as chaves SAS com escopo do hub IoT devem ou não ser desabilitadas para autenticação.
Um booleano indicando se as chaves SAS com escopo de módulo devem ou não ser desabilitadas para autenticação.
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.
A cadeia de conexão da conta de Armazenamento do Azure na qual os arquivos são carregados.
O número de vezes que o hub IoT tenta entregar uma mensagem na fila de comentários, entre 1 e 100.
A duração do bloqueio para a fila de comentários, entre 5 e 300 segundos.
O período de tempo pelo qual o hub IoT manterá o feedback para expiração ou entrega de mensagens de nuvem para dispositivo, entre 1 e 48 horas.
A duração do bloqueio para a fila de notificações de upload de arquivos, entre 5 e 300 segundos.
O número de vezes que o hub IoT tentará entregar uma mensagem de notificação de arquivo, entre 1 e 100.
A quantidade de tempo que uma notificação de carregamento de arquivo fica disponível para o serviço consumir antes de expirar pelo Hub IoT, entre 1 e 48 horas.
Um booleano indicando se as informações sobre arquivos carregados devem ser registradas no ponto de extremidade do Hub IoT messages/servicebound/filenotifications.
A quantidade de tempo que um URI SAS gerado pelo Hub IoT é válido antes de expirar, entre 1 e 24 horas.
O tipo de autenticação da conta de Armazenamento do Azure para a qual os arquivos são carregados.
A identidade gerenciada a ser usada para autenticação de upload de arquivos. Use '[system]' para se referir à identidade gerenciada atribuída pelo sistema ou a uma ID de recurso para se referir a uma identidade gerenciada atribuída pelo usuário.
Ao usar 'set' ou 'add', preserve literais de cadeia de caracteres em vez de tentar converter para JSON.
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'.
Nome do Hub IoT.
Especifica por quanto tempo esse hub IoT manterá eventos de dispositivo para nuvem, entre 1 e 7 dias.
Remova uma propriedade ou um elemento de uma lista. Exemplo: --remove property.list <indexToRemove>
OU --remove propertyToRemove
.
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
Atualize um objeto especificando um caminho de propriedade e um valor a serem definidos. Exemplo: --set property1.property2=<value>
.
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.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
Tags separadas por espaço: key[=value] [key[=value] ...]. Use "" para limpar as tags existentes.
Unidades em seu Hub IoT.
Parâmetros Globais
Aumente o detalhamento do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
Aumentar o detalhamento do log. Use --debug para logs de depuração completos.
az iot hub wait
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
Aguarde até criar com 'provisioningState' em 'Succeeded'.
Aguarde até que a condição satisfaça uma consulta JMESPath personalizada. Por exemplo, provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Aguarde até ser excluído.
Aguarde até que o recurso exista.
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'.
Intervalo de sondagem em segundos.
Nome do Hub IoT.
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
Espera máxima em segundos.
Aguarde até que seja atualizado com provisioningState em 'Succeeded'.
Parâmetros Globais
Aumente o detalhamento do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
Aumentar o detalhamento do log. Use --debug para logs de depuração completos.