az iot hub

Gerir os centros Azure IoT.

Comandos

az iot hub certificate

Gerir Hub IoT certificados.

az iot hub certificate create

Criar/carregar um certificado de Hub IoT do Azure.

az iot hub certificate delete

Elimina um certificado de Hub IoT do Azure.

az iot hub certificate generate-verification-code

Gera um código de verificação para um certificado de Hub IoT do Azure.

az iot hub certificate list

Lista todos os certificados contidos num Hub IoT do Azure.

az iot hub certificate show

Mostra informações sobre um determinado certificado de Hub IoT do Azure.

az iot hub certificate update

Atualize um certificado de Hub IoT do Azure.

az iot hub certificate verify

Verifica um certificado de Hub IoT do Azure.

az iot hub configuration

Gestão da configuração da gestão automática de dispositivos IoT em escala.

az iot hub configuration create

Crie uma configuração automática de gestão de dispositivos IoT num Hub IoT-alvo.

az iot hub configuration delete

Elimine uma configuração do dispositivo IoT.

az iot hub configuration list

Listar configurações automáticas de gestão de dispositivos IoT numa Hub IoT.

az iot hub configuration show

Obtenha os detalhes de uma configuração automática de gestão de dispositivos IoT.

az iot hub configuration show-metric

Avalie uma métrica de utilizador ou sistema alvo definida numa configuração do dispositivo IoT.

az iot hub configuration update

Atualizar propriedades especificadas de uma configuração automática de gestão de dispositivos IoT.

Use --conjunto seguido de atribuições de propriedade para atualizar uma configuração.

Nota: O conteúdo da configuração é imutável. As propriedades de configuração que podem ser atualizadas são 'labels', 'metrics', 'priority' e 'targetCondition'.

az iot hub connection-string

Gerencie Hub IoT cordas de ligação.

az iot hub connection-string show

Mostrar as cadeias de ligação para os hubs IoT especificados utilizando o nome e a chave de política.

az iot hub consumer-group

Gerir os grupos de consumidores de centros de eventos de um hub IoT.

az iot hub consumer-group create

Crie um grupo de consumidores de centros de eventos.

az iot hub consumer-group delete

Apague um grupo de consumidores de centros de eventos.

az iot hub consumer-group list

Lista grupos de consumidores de centros de eventos.

az iot hub consumer-group show

Obtenha os detalhes de um grupo de consumidores de centros de eventos.

az iot hub create

Crie um hub Azure IoT.

az iot hub delete

Apague um hub IoT.

az iot hub device-identity

Gerencie os dispositivos IoT.

az iot hub device-identity children

Gerir relações com dispositivos infantis para dispositivos de borda IoT.

az iot hub device-identity children add

Adicione os dispositivos em criança a um dispositivo de borda alvo.

az iot hub device-identity children list

Outputs a recolha de dispositivos infantis atribuídos.

az iot hub device-identity children remove

Retire os dispositivos para crianças de um dispositivo de borda do alvo.

az iot hub device-identity connection-string

Gerencie a cadeia de ligação do dispositivo IoT.

az iot hub device-identity connection-string show

Mostre uma determinada Hub IoT cadeia de ligação do dispositivo.

az iot hub device-identity create

Crie um dispositivo num Hub IoT.

az iot hub device-identity delete

Elimine um dispositivo Hub IoT.

az iot hub device-identity export

Exporte todas as identidades do dispositivo de um Hub IoT para um recipiente de bolhas Azure Armazenamento. Para o recipiente blob inline ENTRADA SAS uri, por favor reveja as regras de entrada do seu ambiente.

az iot hub device-identity import

Importar identidades de dispositivos para um Hub IoT de uma bolha. Para o recipiente blob inline ENTRADA SAS uri, por favor reveja as regras de entrada do seu ambiente.

az iot hub device-identity list

Listar dispositivos num Hub IoT.

az iot hub device-identity parent

Gerir as relações dos dispositivos parentais para dispositivos IoT.

az iot hub device-identity parent set

Desaponte o dispositivo-mãe de um dispositivo alvo.

az iot hub device-identity parent show

Arranja o dispositivo dos pais de um dispositivo alvo.

az iot hub device-identity renew-key

Renovar as teclas-alvo de um dispositivo Hub IoT com autenticação sas.

az iot hub device-identity show

Obtenha os detalhes de um dispositivo Hub IoT.

az iot hub device-identity update

Atualize um dispositivo Hub IoT.

az iot hub devicestream

Gerencie os fluxos de dispositivos de um hub IoT.

az iot hub devicestream show

Obter Hub IoT dispositivo streams pontos finais.

az iot hub device-twin

Gerir a configuração dupla do dispositivo IoT.

az iot hub device-twin replace

Substitua a definição de twin do dispositivo por json alvo.

az iot hub device-twin show

Obter uma definição de dois dispositivos.

az iot hub device-twin update

Atualizar o dispositivo twin propriedades e tags desejadas.

az iot hub digital-twin

Manipular e interagir com o gémeo digital de um dispositivo Hub IoT.

az iot hub digital-twin invoke-command

Invocar um comando de raiz ou nível de componente de um dispositivo digital twin.

az iot hub digital-twin show

Mostre o gémeo digital de um dispositivo Hub IoT.

az iot hub digital-twin update

Atualize as propriedades de leitura-escrita de um dispositivo digital twin através da especificação de patch JSON.

az iot hub distributed-tracing

Gerir as definições distribuídas por dispositivo.

az iot hub distributed-tracing show

Obtenha as definições de rastreio distribuídas para um dispositivo.

az iot hub distributed-tracing update

Atualize as opções de rastreio distribuídos para um dispositivo.

az iot hub generate-sas-token

Gere um símbolo SAS para um Hub IoT, dispositivo ou módulo de destino.

az iot hub identity

Gerir identidades de um hub Azure IoT.

az iot hub identity assign

Atribua identidades geridas a um Hub IoT.

az iot hub identity remove

Remova as identidades geridas de um Hub IoT.

az iot hub identity show

Mostre as propriedades identitárias de um Hub IoT.

az iot hub invoke-device-method

Invoque um método de dispositivo.

az iot hub invoke-module-method

Invoque um método de módulo Edge.

az iot hub job

Gerir Hub IoT empregos (v2).

az iot hub job cancel

Cancele um trabalho de Hub IoT.

az iot hub job create

Criar e agendar um trabalho Hub IoT para execução.

az iot hub job list

Enumerar os trabalhos históricos de um Hub IoT.

az iot hub job show

Mostre detalhes de um trabalho Hub IoT existente.

az iot hub list

Lista de centros IoT.

az iot hub list-skus

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

az iot hub manual-failover

Inicie uma falha manual para a Hub IoT para a região de recuperação de desastres geo-emparelhada.

az iot hub message-enrichment

Gerir enriquecimentos de mensagens para pontos finais de um Hub IoT.

az iot hub message-enrichment create

Crie um enriquecimento de mensagens para os pontos finais escolhidos no seu Hub IoT.

az iot hub message-enrichment delete

Elimine um enriquecimento de mensagens no seu hub IoT (por chave).

az iot hub message-enrichment list

Obtenha informações sobre todos os enriquecimentos de mensagens para o seu Hub IoT.

az iot hub message-enrichment update

Atualize um enriquecimento de mensagens no seu hub IoT (por chave).

az iot hub module-identity

Gerir módulos de dispositivo ioT.

az iot hub module-identity connection-string

Gerir a cadeia de ligação do módulo de dispositivo IoT.

az iot hub module-identity connection-string show

Mostrar uma cadeia de ligação do módulo do dispositivo IoT alvo.

az iot hub module-identity create

Crie um módulo num dispositivo IoT alvo num Hub IoT.

az iot hub module-identity delete

Elimine um dispositivo num Hub IoT.

az iot hub module-identity list

Listar módulos localizados num dispositivo IoT num Hub IoT.

az iot hub module-identity renew-key

Renovar as teclas-alvo de um módulo de dispositivo Hub IoT com autenticação sas.

az iot hub module-identity show

Obtenha os detalhes de um módulo de dispositivo IoT em Hub IoT.

az iot hub module-identity update

Atualize um módulo de dispositivo Hub IoT.

az iot hub module-twin

Gerir a configuração dupla do módulo do dispositivo IoT.

az iot hub module-twin replace

Substitua uma definição de módulo twin por json alvo.

az iot hub module-twin show

Mostre uma definição de módulo twin.

az iot hub module-twin update

Atualizar o módulo twin propriedades e tags desejadas.

az iot hub monitor-events

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

az iot hub monitor-feedback

Monitorize o feedback enviado por dispositivos para reconhecer mensagens cloud-to-device (C2D).

az iot hub policy

Gerir políticas de acesso compartilhado de um hub IoT.

az iot hub policy create

Crie uma nova política de acesso partilhado num hub IoT.

az iot hub policy delete

Elimine uma política de acesso partilhado de um hub IoT.

az iot hub policy list

Lista políticas de acesso compartilhado de um hub IoT.

az iot hub policy renew-key

Regenerar chaves de uma política de acesso compartilhado de um hub IoT.

az iot hub policy show

Obtenha os detalhes de uma política de acesso compartilhado de um hub IoT.

az iot hub query

Consultar uma Hub IoT usando uma linguagem poderosa SQL.

az iot hub route

Gerir rotas de um hub IoT.

az iot hub route create

Crie uma rota em Hub IoT.

az iot hub route delete

Elimine a rota total ou mencionada para o seu Hub IoT.

az iot hub route list

Pegue todas as rotas em Hub IoT.

az iot hub route show

Obtenha informações sobre a rota em Hub IoT.

az iot hub route test

Teste todas as rotas ou rota mencionada em Hub IoT.

az iot hub route update

Atualize uma rota em Hub IoT.

az iot hub routing-endpoint

Gerir pontos finais personalizados de um hub IoT.

az iot hub routing-endpoint create

Adicione um ponto final ao seu Hub IoT.

az iot hub routing-endpoint delete

Elimine o ponto final total ou mencionado para o seu Hub IoT.

az iot hub routing-endpoint list

Obtenha informações sobre todos os pontos finais para o seu Hub IoT.

az iot hub routing-endpoint show

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

az iot hub show

Obtenha os detalhes de um hub IoT.

az iot hub show-connection-string

Mostre as cordas de ligação para um hub IoT.

az iot hub show-quota-metrics

Obtenha as métricas de quota para um centro de IoT.

az iot hub show-stats

Obtenha as estatísticas de um centro de IoT.

az iot hub update

Atualize metadados para um hub IoT.

az iot hub create

Crie um hub Azure IoT.

Para uma introdução à Hub IoT do Azure, vejahttps://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]
                  [--fcu]
                  [--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]
                  [--partition-count]
                  [--rd]
                  [--role]
                  [--scopes]
                  [--sku {B1, B2, B3, F1, S1, S2, S3}]
                  [--tags]
                  [--unit]

Exemplos

Crie um Hub IoT com o nível de preços gratuitos F1, na região do grupo de recursos.

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

Crie uma Hub IoT com as divisórias de nível de preços padrão S1 e 4, na região 'westus', com etiquetas.

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

Criar um Hub IoT com uma identidade gerida atribuída pelo sistema e atribuir uma função e âmbito 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 do dispositivo e chaves SAS do módulo todas desativadas

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

Criar uma Hub IoT com a residência de dados aplicada. Isto irá 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

Hub IoT nome.

--resource-group -g

o nome do grupo de recursos. Pode configurar o grupo predefinido utilizando 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 nuvem-a-dispositivo a um dispositivo, entre 1 e 100.

valor predefinido: 10
--c2d-ttl --ct

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

valor predefinido: 1
--dds --disable-device-sas

Um boolean que indica se deve ou não desativar todos os dispositivos (incluindo dispositivos Edge, mas excluindo módulos) examinou as teclas SAS para a autenticação.

valores aceites: false, true
--disable-local-auth --dla

Um boolean que indica se desativar ou não o hub IoT examinou as teclas SAS para a autenticação.

valores aceites: false, true
--disable-module-sas --dms

Um boolean que indica se deve ou não desativar as teclas SAS com âmbito de módulo para a autenticação.

valores aceites: false, true
--edr --enforce-data-residency

Impor 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 recipiente de raiz onde se fazem o upload de ficheiros. O recipiente não precisa de existir, mas deve ser avelusável utilizando a ligação Desinspecitada.

--fcs --fileupload-storage-connectionstring

O fio de ligação da conta Azure Armazenamento para a qual os ficheiros são carregados.

--fcu --fileupload-storage-container-uri

O URI do contentor para a conta Azure Armazenamento para a qual os ficheiros são carregados.

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

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

valor predefinido: 10
--feedback-lock-duration --fld

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

valor predefinido: 5
--feedback-ttl --ft

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

valor predefinido: 1
--fileupload-notification-lock-duration --fnld

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

valor predefinido: 5
--fileupload-notification-max-delivery-count --fnd

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

valor predefinido: 10
--fileupload-notification-ttl --fnt

O tempo que uma notificação de upload de ficheiros está disponível para o serviço consumir antes de expirar por Hub IoT, entre 1 e 48 horas.

valor predefinido: 1
--fileupload-notifications --fn

Um boolean que indica se deve registar informações sobre ficheiros carregados para as mensagens/notificaçãos de serviço/ficheiro Hub IoT ponto final.

valores aceites: false, true
--fileupload-sas-ttl --fst

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

valor predefinido: 1
--fileupload-storage-auth-type --fsa

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

valores aceites: identityBased, keyBased
--fileupload-storage-identity --fsi

A identidade gerida para usar para autenticação de upload de ficheiros. Utilize o '[sistema]' para se referir à identidade gerida atribuída ao sistema ou a um ID de recurso para se referir a uma identidade gerida atribuída pelo utilizador.

--location -l

A localização do seu Hub IoT. O padrão é a localização do grupo de recursos-alvo.

--mi-system-assigned

Ativar a identidade gerida atribuída pelo sistema para este hub.

valores aceites: false, true
--mi-user-assigned

Ativar as identidades geridas atribuídas pelo utilizador para este hub. Aceite a lista de identificação de recursos de identidade separados pelo espaço.

--min-tls-version --mintls

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

--partition-count

O número de divisórias do Centro de Eventos de suporte para mensagens dispositivo-a-nuvem.

valor predefinido: 4
--rd --retention-day

Especifica quanto tempo este hub IoT manterá eventos dispositivo-nuvem, entre 1 e 7 dias.

valor predefinido: 1
--role

Papel para atribuir à identidade gerida do sistema do centro.

--scopes

Lista de âmbitos separados do espaço para atribuir a função (--papel) para a identidade gerida atribuída pelo sistema.

--sku

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

valores aceites: B1, B2, B3, F1, S1, S2, S3
valor predefinido: S1
--tags

Etiquetas separadas pelo espaço: chave[=valor] [chave[=valor] ...]. Utilize "" para limpar as etiquetas existentes.

--unit

Unidades na sua Hub IoT.

valor predefinido: 1

az iot hub delete

Apague um hub IoT.

az iot hub delete [--ids]
                  [--name]
                  [--resource-group]

Exemplos

Apague um hub IoT. (autogerado)

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

Parâmetros Opcionais

--ids

Um ou mais IDs de recursos (espaço-delimitado). Deve ser um ID completo de recursos contendo todas as informações dos argumentos de "Identificação de Recursos". Deve fornecer ou ids ou outros argumentos de "Identificação de Recursos".

--name -n

Hub IoT nome.

--resource-group -g

o nome do grupo de recursos. Pode configurar o grupo predefinido utilizando az configure --defaults group=<name>.

az iot hub generate-sas-token

Gere um símbolo SAS para um Hub IoT, dispositivo ou módulo de destino.

Para os tokens SAS do dispositivo, o parâmetro de política é utilizado apenas para aceder ao registo do dispositivo. Por conseguinte, a política deveria ter lido o acesso ao registo. Para Hub IoT fichas, 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 Hub IoT ficha SAS usando a política do iothubowner e a chave primária.

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

Gere um Hub IoT ficha SAS utilizando a política de registroRead e a chave secundária.

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

Gere um símbolo SAS do dispositivo utilizando a política do iothubowner para aceder ao registo do dispositivo {iothub_name}.

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

Gere um símbolo SAS do dispositivo utilizando uma cadeia de ligação Hub IoT (com acesso ao registo)

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

Gere um token Iot Hub SAS usando uma cadeia de ligação Hub IoT

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

Gere um símbolo SAS do dispositivo utilizando uma cadeia de ligação do dispositivo

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

Gere um token SAS do módulo usando uma cadeia de ligação 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 utilizar a sessão AD Azure atual. Pode configurar o padrão utilizando az configure --defaults iothub-data-auth-type=<auth-type-value>.

valores aceites: key, login
valor predefinido: key
--connection-string --cs

Cadeia de ligação do alvo. Isto contorna o registo Hub IoT e gera o token SAS diretamente da chave simétrica fornecida sem validação adicional. Todos os outros parâmetros de comando, para além da duração, serão ignorados. Tipos de cordas de ligação suportados: Iot Hub, Dispositivo, Módulo.

--device-id -d

Dispositivo alvo.

--du --duration

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

valor predefinido: 3600
--hub-name -n

Hub IoT nome. Necessário se não for fornecido o login.

--key-type --kt

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

valores aceites: primary, secondary
valor predefinido: primary
--login -l

Este comando suporta uma cadeia de ligação de entidade com direitos para realizar a ação. Utilize para evitar o login de sessão através de "az login". Se uma cadeia de ligação de entidade e o nome forem fornecidos, a cadeia de ligação tem prioridade. Necessário se não for fornecido o nome do hub.

--module-id -m

Módulo alvo.

--pn --policy-name

Política de acesso partilhado com permissões de operação para Hub IoT entidade alvo.

valor predefinido: iothubowner
--resource-group -g

o nome do grupo de recursos. Pode configurar o grupo predefinido utilizando az configure --defaults group=<name>.

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 no dispositivo a partir da nuvem.

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

Dispositivo alvo.

--method-name --mn

Método-alvo para a invocação.

Parâmetros Opcionais

--auth-type

Indica se a operação deve derivar automaticamente uma chave de política ou utilizar a sessão AD Azure atual. Pode configurar o padrão utilizando az configure --defaults iothub-data-auth-type=<auth-type-value>.

valores aceites: key, login
valor predefinido: key
--hub-name -n

Hub IoT nome. Necessário se não for fornecido o login.

--login -l

Este comando suporta uma cadeia de ligação de entidade com direitos para realizar a ação. Utilize para evitar o login de sessão através de "az login". Se uma cadeia de ligação de entidade e o nome forem fornecidos, a cadeia de ligação tem prioridade. Necessário se não for fornecido o nome do hub.

--method-payload --mp

Json carga útil para ser passado para o método. Deve ser o caminho do arquivo ou o json cru.

valor predefinido: {}
--resource-group -g

o nome do grupo de recursos. Pode configurar o grupo predefinido utilizando az configure --defaults group=<name>.

--timeout --to

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

valor predefinido: 30

az iot hub invoke-module-method

Invoque um método de módulo Edge.

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 no dispositivo de borda usando um módulo da nuvem.

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

Dispositivo alvo.

--method-name --mn

Método-alvo para a invocação.

--module-id -m

Módulo alvo.

Parâmetros Opcionais

--auth-type

Indica se a operação deve derivar automaticamente uma chave de política ou utilizar a sessão AD Azure atual. Pode configurar o padrão utilizando az configure --defaults iothub-data-auth-type=<auth-type-value>.

valores aceites: key, login
valor predefinido: key
--hub-name -n

Hub IoT nome. Necessário se não for fornecido o login.

--login -l

Este comando suporta uma cadeia de ligação de entidade com direitos para realizar a ação. Utilize para evitar o login de sessão através de "az login". Se uma cadeia de ligação de entidade e o nome forem fornecidos, a cadeia de ligação tem prioridade. Necessário se não for fornecido o nome do hub.

--method-payload --mp

Json carga útil para ser passado para o método. Deve ser o caminho do arquivo ou o json cru.

valor predefinido: {}
--resource-group -g

o nome do grupo de recursos. Pode configurar o grupo predefinido utilizando az configure --defaults group=<name>.

--timeout --to

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

valor predefinido: 30

az iot hub list

Lista de centros IoT.

az iot hub list [--resource-group]

Exemplos

Enuse todos os hubs IoT numa subscrição.

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. Pode configurar o grupo predefinido utilizando az configure --defaults group=<name>.

az iot hub list-skus

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

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

Exemplos

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

az iot hub list-skus --name MyIoTHub

Parâmetros Opcionais

--ids

Um ou mais IDs de recursos (espaço-delimitado). Deve ser um ID completo de recursos contendo todas as informações dos argumentos de "Identificação de Recursos". Deve fornecer ou ids ou outros argumentos de "Identificação de Recursos".

--name -n

Hub IoT nome.

--resource-group -g

o nome do grupo de recursos. Pode configurar o grupo predefinido utilizando az configure --defaults group=<name>.

az iot hub manual-failover

Inicie uma falha manual para a Hub IoT para a região de recuperação de desastres geo-emparelhada.

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

Exemplos

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

az iot hub manual-failover -n myhub

Parâmetros Opcionais

--ids

Um ou mais IDs de recursos (espaço-delimitado). Deve ser um ID completo de recursos contendo todas as informações dos argumentos de "Identificação de Recursos". Deve fornecer ou ids ou outros argumentos de "Identificação de Recursos".

--name -n

Hub IoT nome.

--no-wait

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

--resource-group -g

o nome do grupo de recursos. Pode configurar o grupo predefinido utilizando az configure --defaults group=<name>.

az iot hub monitor-events

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

EXPERIMENTAL requer Python 3.5+ Este comando depende e pode instalar o pacote Cython dependente (uamqp) após a primeira execução. https://github.com/Azure/azure-uamqp-python.

az iot hub monitor-events [--cg]
                          [--content-type]
                          [--device-id]
                          [--device-query]
                          [--enqueued-time]
                          [--hub-name]
                          [--interface]
                          [--login]
                          [--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 ligação Hub IoT

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

Utilização básica ao filtrar no dispositivo-alvo

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

Utilização básica ao filtrar dispositivos direcionados com um wildcard no ID

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

Filtrar dispositivos que usam linguagem de consulta Hub IoT

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

Filtrar o dispositivo e especificar um grupo de consumidores event Hub para se ligar.

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

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

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

Receber anotações de mensagens + propriedades do sistema. Nunca sair do tempo.

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

Receba todos os atributos de mensagens de todas as mensagens do dispositivo

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

Receba todas as mensagens e análise de carga útil de mensagens como JSON

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

Parâmetros Opcionais

--cg --consumer-group -c

Especifique o grupo de consumidores para utilizar ao ligar-se ao ponto final do centro de eventos.

valor predefinido: $Default
--content-type --ct

Especificar o Tipo de Conteúdo da carga útil da mensagem para formatar automaticamente a saída para esse tipo.

--device-id -d

Dispositivo alvo.

--device-query -q

Especifique uma consulta personalizada para filtrar dispositivos.

--enqueued-time --et -e

Indica a hora que deve ser usada como ponto de partida para ler mensagens das divisórias. As unidades são milissegundos desde a época unix. Se não for indicado tempo ,agora, é utilizado um tempo.

--hub-name -n

Hub IoT nome. Necessário se não for fornecido o login.

--interface -i

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

--login -l

Este comando suporta uma cadeia de ligação de entidade com direitos para realizar a ação. Utilize para evitar o login de sessão através de "az login". Se uma cadeia de ligação de entidade e o nome forem fornecidos, a cadeia de ligação tem prioridade. Necessário se não for fornecido o nome do hub.

--module-id -m

Módulo alvo.

--properties --props -p

Indicar as propriedades da mensagem chave para a saída. sys = propriedades do sistema, app = propriedades de aplicação, anno = anotações.

valores aceites: all, anno, app, sys
--repair -r

Reinstalar a dependência do uamqp compatível com a versão de extensão. Predefinição: false.

valores aceites: false, true
--resource-group -g

o nome do grupo de recursos. Pode configurar o grupo predefinido utilizando az configure --defaults group=<name>.

--timeout --to -t

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

valor predefinido: 300
--yes -y

Ignore as indicações do utilizador. Indica a aceitação da instalação de dependência (se necessário). Usado principalmente para cenários de automação. Predefinição: false.

valores aceites: false, true

az iot hub monitor-feedback

Monitorize o feedback enviado por dispositivos para reconhecer mensagens cloud-to-device (C2D).

EXPERIMENTAL requer Python 3.4+ Este comando depende e pode instalar o pacote Cython dependente (uamqp) após a 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 ligação Hub IoT

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

Utilização básica ao filtrar no dispositivo-alvo

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

Monitor de feedback de saída 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

Indica se a operação deve derivar automaticamente uma chave de política ou utilizar a sessão AD Azure atual. Pode configurar o padrão utilizando az configure --defaults iothub-data-auth-type=<auth-type-value>.

valores aceites: key, login
valor predefinido: key
--device-id -d

Dispositivo alvo.

--hub-name -n

Hub IoT nome. Necessário se não for fornecido o login.

--login -l

Este comando suporta uma cadeia de ligação de entidade com direitos para realizar a ação. Utilize para evitar o login de sessão através de "az login". Se uma cadeia de ligação de entidade e o nome forem fornecidos, a cadeia de ligação tem prioridade. Necessário se não for fornecido o nome do hub.

--repair -r

Reinstalar a dependência do uamqp compatível com a versão de extensão. Predefinição: false.

valores aceites: false, true
--resource-group -g

o nome do grupo de recursos. Pode configurar o grupo predefinido utilizando az configure --defaults group=<name>.

--wait-on-msg -w

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

--yes -y

Ignore as indicações do utilizador. Indica a aceitação da instalação de dependência (se necessário). Usado principalmente para cenários de automação. Predefinição: false.

valores aceites: false, true

az iot hub query

Consultar uma Hub IoT usando uma linguagem poderosa SQL.

Consultar um Hub IoT usando uma linguagem poderosa SQL para recuperar informações sobre o dispositivo e gémeos módulos, empregos e encaminhamento 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

Consulta todos os dados gémeos do dispositivo numa Hub IoT do Azure.

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

Consultar todos os dados gémeos do módulo no dispositivo alvo.

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 do utilizador a ser executada.

Parâmetros Opcionais

--auth-type

Indica se a operação deve derivar automaticamente uma chave de política ou utilizar a sessão AD Azure atual. Pode configurar o padrão utilizando az configure --defaults iothub-data-auth-type=<auth-type-value>.

valores aceites: key, login
valor predefinido: key
--hub-name -n

Hub IoT nome. Necessário se não for fornecido o login.

--login -l

Este comando suporta uma cadeia de ligação de entidade com direitos para realizar a ação. Utilize para evitar o login de sessão através de "az login". Se uma cadeia de ligação de entidade e o nome forem fornecidos, a cadeia de ligação tem prioridade. Necessário se não for fornecido o nome do hub.

--resource-group -g

o nome do grupo de recursos. Pode configurar o grupo predefinido utilizando az configure --defaults group=<name>.

--top

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

az iot hub show

Obtenha os detalhes de um hub IoT.

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

Exemplos

Obtenha os detalhes de um hub IoT. (autogerado)

az iot hub show --name MyIoTHub

Parâmetros Opcionais

--ids

Um ou mais IDs de recursos (espaço-delimitado). Deve ser um ID completo de recursos contendo todas as informações dos argumentos de "Identificação de Recursos". Deve fornecer ou ids ou outros argumentos de "Identificação de Recursos".

--name -n

Hub IoT nome.

--resource-group -g

o nome do grupo de recursos. Pode configurar o grupo predefinido utilizando az configure --defaults group=<name>.

az iot hub show-connection-string

Mostre as cordas de ligação para um hub IoT.

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

Exemplos

Mostrar a cadeia de ligação de um hub IoT utilizando a política predefinida e a chave primária.

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

Mostrar a cadeia de ligação de um Hub IoT utilizando a chave de 'serviço' e a chave secundária.

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

Mostre as cordas de ligação para todos os centros IoT de um grupo de recursos.

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

Mostre as cordas de ligação para todos os hubs IoT numa subscrição.

az iot hub show-connection-string

Mostre as cordas de ligação para um hub IoT. (autogerado)

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

Parâmetros Opcionais

--all

Permita mostrar todas as políticas de acesso partilhado.

--hub-name --name -n

Hub IoT nome.

--ids

Um ou mais IDs de recursos (espaço-delimitado). Deve ser um ID completo de recursos contendo todas as informações dos argumentos de "Identificação de Recursos". Deve fornecer ou ids ou outros argumentos de "Identificação de Recursos".

--key

A chave a usar.

valores aceites: primary, secondary
valor predefinido: primary
--policy-name

Política de acesso compartilhado a ser utilizada.

valor predefinido: iothubowner
--resource-group -g

o nome do grupo de recursos. Pode configurar o grupo predefinido utilizando az configure --defaults group=<name>.

az iot hub show-quota-metrics

Obtenha as métricas de quota para um centro de IoT.

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

Exemplos

Obtenha as métricas de quota para um centro de IoT. (autogerado)

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

Obtenha as métricas de quota para um centro de IoT. (autogerado)

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

Parâmetros Opcionais

--ids

Um ou mais IDs de recursos (espaço-delimitado). Deve ser um ID completo de recursos contendo todas as informações dos argumentos de "Identificação de Recursos". Deve fornecer ou ids ou outros argumentos de "Identificação de Recursos".

--name -n

Hub IoT nome.

--resource-group -g

o nome do grupo de recursos. Pode configurar o grupo predefinido utilizando az configure --defaults group=<name>.

az iot hub show-stats

Obtenha as estatísticas de um centro de IoT.

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

Exemplos

Obtenha as estatísticas de um centro de IoT. (autogerado)

az iot hub show-stats --name MyIoTHub

Parâmetros Opcionais

--ids

Um ou mais IDs de recursos (espaço-delimitado). Deve ser um ID completo de recursos contendo todas as informações dos argumentos de "Identificação de Recursos". Deve fornecer ou ids ou outros argumentos de "Identificação de Recursos".

--name -n

Hub IoT nome.

--resource-group -g

o nome do grupo de recursos. Pode configurar o grupo predefinido utilizando az configure --defaults group=<name>.

az iot hub update

Atualize 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]
                  [--fcu]
                  [--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}]
                  [--tags]
                  [--unit]

Exemplos

Adicione as definições do contentor de armazenamento para carregar ficheiros

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

Adicione uma regra do 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

Atualize metadados para um hub IoT. (autogerado)

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

Atualizar unidades de um Hub IoT a 2 e adicionar tags

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

Atualizar o nível de preços para um Hub IoT como S2

az iot hub update -n MyIotHub --sku S2

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

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

Atualizar as definições de mensagens cloud-to-device Hub IoT

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

Atualizar as definições de fila de feedback Hub IoT

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

Atualizar as definições de upload de ficheiros Hub IoT e atribuir uma identidade gerida ao utilizador para o upload de ficheiros

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

Atualizar as definições de notificação de upload de ficheiros 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 definições Hub IoT de autenticação local, dispositivo SAS e módulo SAS

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 chave. Exemplo: --adicionar propriedade.listProperty <chave=valor, string ou> de cadeia JSON.

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

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

--c2d-ttl --ct

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

--dds --disable-device-sas

Um boolean que indica se deve ou não desativar todos os dispositivos (incluindo dispositivos Edge, mas excluindo módulos) examinou as teclas SAS para a autenticação.

valores aceites: false, true
--disable-local-auth --dla

Um boolean que indica se desativar ou não o hub IoT examinou as teclas SAS para a autenticação.

valores aceites: false, true
--disable-module-sas --dms

Um boolean que indica se deve ou não desativar as teclas SAS com âmbito de módulo para a autenticação.

valores aceites: false, true
--fc --fileupload-storage-container-name

O nome do recipiente de raiz onde se fazem o upload de ficheiros. O recipiente não precisa de existir, mas deve ser avelusável utilizando a ligação Desinspecitada.

--fcs --fileupload-storage-connectionstring

O fio de ligação da conta Azure Armazenamento para a qual os ficheiros são carregados.

--fcu --fileupload-storage-container-uri

O URI do contentor para a conta Azure Armazenamento para a qual os ficheiros são carregados.

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

O número de vezes que o hub IoT tenta entregar uma mensagem na fila de comentários, 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 para o qual o hub IoT manterá o feedback para a expiração ou entrega de mensagens nuvem-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 ficheiros, 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 ficheiros, entre 1 e 100.

--fileupload-notification-ttl --fnt

O tempo que uma notificação de upload de ficheiros está disponível para o serviço consumir antes de expirar por Hub IoT, entre 1 e 48 horas.

--fileupload-notifications --fn

Um boolean que indica se deve registar informações sobre ficheiros carregados para as mensagens/notificaçãos de serviço/ficheiro Hub IoT ponto final.

valores aceites: false, true
--fileupload-sas-ttl --fst

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

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

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

valores aceites: identityBased, keyBased
--fileupload-storage-identity --fsi

A identidade gerida para usar para autenticação de upload de ficheiros. Utilize o '[sistema]' para se referir à identidade gerida atribuída ao sistema ou a um ID de recurso para se referir a uma identidade gerida atribuída pelo utilizador.

--force-string

Ao utilizar 'set' ou 'add', preserve as cordas literais em vez de tentar converter-se em JSON.

--ids

Um ou mais IDs de recursos (espaço-delimitado). Deve ser um ID completo de recursos contendo todas as informações dos argumentos de "Identificação de Recursos". Deve fornecer ou ids ou outros argumentos de "Identificação de Recursos".

--name -n

Hub IoT nome.

--rd --retention-day

Especifica quanto tempo este hub IoT manterá eventos dispositivo-nuvem, entre 1 e 7 dias.

--remove

Remova uma propriedade ou um elemento de uma lista. Exemplo: --remover propriedade.list OR --remover propriedadeToRemove.

--resource-group -g

o nome do grupo de recursos. Pode configurar o grupo predefinido utilizando az configure --defaults group=<name>.

--set

Atualize um objeto especificando um caminho de propriedade e valor a definir. Exemplo: --set property1.property2=.

--sku

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

valores aceites: B1, B2, B3, F1, S1, S2, S3
--tags

Etiquetas separadas pelo espaço: chave[=valor] [chave[=valor] ...]. Utilize "" para limpar as etiquetas existentes.

--unit

Unidades na sua Hub IoT.