Share via

az iot device

  • Referência

Nota

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

Aproveite a simulação de dispositivos e outras operações centradas no dispositivo, como recursos de mensagens de dispositivo para nuvem ou de nuvem para dispositivo.

Comandos

Name Description Tipo Estado
az iot device c2d-message

Comandos de mensagens da nuvem para o dispositivo.

 Extensão GA
az iot device c2d-message abandon

Abandone uma mensagem da nuvem para o dispositivo.

 Extensão GA
az iot device c2d-message complete

Preencha uma mensagem da nuvem para o dispositivo.

 Extensão GA
az iot device c2d-message purge

Limpe a fila de mensagens da nuvem para o dispositivo de um dispositivo de destino.

 Extensão GA
az iot device c2d-message receive

Receba uma mensagem da nuvem para o dispositivo.

 Extensão GA
az iot device c2d-message reject

Rejeitar ou fazer uma mensagem de nuvem para dispositivo.

 Extensão GA
az iot device c2d-message send

Envie uma mensagem da nuvem para o dispositivo.

 Extensão GA
az iot device registration

Gerencie registros de dispositivos IoT para o Serviço de Provisionamento de Dispositivos IoT.

 Extensão Pré-visualizar
az iot device registration create

Registre um dispositivo IoT com o Serviço de Provisionamento de Dispositivo IoT.

 Extensão Pré-visualizar
az iot device send-d2c-message

Envie uma mensagem de dispositivo mqtt para a nuvem.

 Extensão GA
az iot device simulate

Simule um dispositivo em um Hub IoT do Azure.

 Extensão Experimental
az iot device upload-file

Carregue um arquivo local como um dispositivo para um contêiner de armazenamento de blob pré-configurado.

 Extensão GA

az iot device send-d2c-message

Envie uma mensagem de dispositivo mqtt para a nuvem.

O comando suporta o envio de mensagens com carga personalizada em formato binário ou cadeia de caracteres unicode. Ao pretender enviar binário, os dados devem vir de um arquivo (via --data-file-path) e o tipo de conteúdo deve ser definido como application/octet-stream.

Nota: O comando só funciona para dispositivos baseados em autenticação de chave simétrica (SAS). Para habilitar a consulta em um corpo de mensagem no roteamento de mensagens, a propriedade do sistema contentType deve ser application/JSON e a propriedade do sistema contentEncoding deve ser um dos valores de codificação UTF suportados por essa propriedade do sistema (UTF-8, UTF-16 ou UTF-32). Se a codificação de conteúdo não estiver definida quando o Armazenamento do Azure for usado como ponto de extremidade de roteamento, o Hub IoT gravará as mensagens no formato codificado base 64. Se estiver usando métodos de autenticação x509, o certificado e os arquivos de chave (e a senha, se necessário) devem ser fornecidos.

az iot device send-d2c-message --device-id
                               [--certificate-file-path]
                               [--da]
                               [--data-file-path]
                               [--dtmi]
                               [--hub-name]
                               [--key]
                               [--key-file-path]
                               [--login]
                               [--mc]
                               [--pass]
                               [--properties]
                               [--resource-group]

Exemplos

Utilização básica

az iot device send-d2c-message -n {iothub_name} -d {device_id}

Uso básico para o dispositivo que registra o ID do modelo de 'dtmi:com:example:Thermostat; 1' após a conexão

az iot device send-d2c-message -n {iothub_name} -d {device_id} --model-id 'dtmi:com:example:Thermostat;1'

Uso básico para dispositivo com autenticação x509

az iot device send-d2c-message -n {iothub_name} -d {device_id} --cp {certificate_file_path} --kp {key_file_path}

Uso básico para dispositivo com autenticação x509 no qual o arquivo de chave tem uma senha

az iot device send-d2c-message -n {iothub_name} -d {device_id} --cp {certificate_file_path} --kp {key_file_path} --pass {passphrase}

Uso básico com dados personalizados

az iot device send-d2c-message -n {iothub_name} -d {device_id} --data {message_body}

Enviar propriedades do aplicativo

az iot device send-d2c-message -n {iothub_name} -d {device_id} --props 'key0=value0;key1=value1'

Enviar propriedades do sistema (ID da mensagem e ID da correlação)

az iot device send-d2c-message -n {iothub_name} -d {device_id} --props '$.mid=<id>;$.cid=<id>'

Enviar dados personalizados especificando o tipo de conteúdo e a codificação de conteúdo nas propriedades do sistema

az iot device send-d2c-message -n {iothub_name} -d {device_id} --props '$.ct=<content-type>;$.ce=<content-encoding>' --data {message_body}

Enviar dados personalizados em formato binário especificando a codificação de conteúdo nas propriedades do sistema

az iot device send-d2c-message -n {iothub_name} -d {device_id} --props '$.ct=application/octet-stream' --data-file-path {file_path}

Envie dados personalizados no formato JSON especificando o tipo de conteúdo e a codificação de conteúdo nas propriedades do sistema

az iot device send-d2c-message -n {iothub_name} -d {device_id} --props '$.ct=application/json;$.ce=utf-8' --data-file-path {file_path}

Parâmetros Obrigatórios

--device-id -d

ID do dispositivo de destino.

Parâmetros Opcionais

--certificate-file-path --cp

Caminho para o arquivo de certificado.

--da --data

Corpo da mensagem. Forneça texto ou json bruto.

valor predefinido: Ping from Az CLI IoT Extension
--data-file-path --dfp
Pré-visualizar

Forneça o caminho para o arquivo para a carga útil do corpo da mensagem. Observe que, quando a carga precisar ser enviada em formato binário, defina o tipo de conteúdo como application/octet-stream.

--dtmi --model-id

O Digital Twin Model Id que o dispositivo informará ao se conectar ao hub. Consulte https://docs.microsoft.com/en-us/azure/iot-develop/overview-iot-plug-and-play para obter mais detalhes.

--hub-name -n

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

--key --symmetric-key

Chave simétrica a utilizar para o dispositivo. Se a chave simétrica e outros argumentos de autenticação de dispositivo forem fornecidos, a chave simétrica terá prioridade.

--key-file-path --kp

Caminho para o arquivo de chave.

--login -l

Este comando suporta uma cadeia de conexão de entidade com direitos para executar a ação. 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.

--mc --msg-count

Número de mensagens de dispositivo a serem enviadas ao Hub IoT.

valor predefinido: 1
--pass --passphrase

Senha para arquivo de chave.

--properties --props -p

Pacote de propriedades de mensagem em pares chave-valor com o seguinte formato: a=b; c=d. Para mensagens mqtt - você pode enviar propriedades do sistema usando $.=value. Por exemplo, $.cid=12345 define a propriedade Id de correlação do sistema. Outros exemplos de identificador de propriedade do sistema incluem $.ct para tipo de conteúdo, $.mid para ID de mensagem e $.ce para codificação de conteúdo.

--resource-group -g

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

Parâmetros de Globais
--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

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

--subscription

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

--verbose

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

az iot device simulate

Experimental

Este comando é experimental e está em desenvolvimento. Níveis de referência e de apoio: https://aka.ms/CLI_refstatus

Simule um dispositivo em um Hub IoT do Azure.

Enquanto a simulação do dispositivo estiver em execução, o dispositivo receberá e reconhecerá automaticamente mensagens da nuvem para o dispositivo (c2d). Para simulação mqtt, todas as mensagens c2d serão reconhecidas com conclusão. Para simulação http c2d reconhecimento é baseado na seleção do usuário que pode ser completa, rejeitar ou abandonar. A simulação mqtt também suporta invocação direta do método, que pode ser reconhecida por um código de status de resposta e carga útil de resposta. Nota: O comando por padrão definirá content-type como application/json e content-encoding como utf-8. Isso pode ser substituído. Nota: Se estiver usando métodos de autenticação x509, o certificado e os arquivos de chave (e a senha, se necessário) devem ser fornecidos.

az iot device simulate --device-id
                       [--certificate-file-path]
                       [--da]
                       [--dtmi]
                       [--hub-name]
                       [--init-reported-properties]
                       [--key]
                       [--key-file-path]
                       [--login]
                       [--mc]
                       [--method-response-code]
                       [--method-response-payload]
                       [--mi]
                       [--pass]
                       [--properties]
                       [--proto {http, mqtt}]
                       [--receive-settle {abandon, complete, reject}]
                       [--resource-group]

Exemplos

Uso básico (mqtt)

az iot device simulate -n {iothub_name} -d {device_id}

Uso básico para o dispositivo que registra o ID do modelo de 'dtmi:com:example:Thermostat; 1' após a conexão (MQTT)

az iot device simulate -n {iothub_name} -d {device_id} --model-id 'dtmi:com:example:Thermostat;1'

Uso básico para dispositivo com autenticação x509 (mqtt)

az iot device simulate -n {iothub_name} -d {device_id} --cp {certificate_file_path} --kp {key_file_path}

Uso básico para dispositivo com autenticação x509 (mqtt) no qual o arquivo de chave tem uma senha

az iot device simulate -n {iothub_name} -d {device_id} --cp {certificate_file_path} --kp {key_file_path} --pass {passphrase}

Enviar propriedades mistas (mqtt)

az iot device simulate -n {iothub_name} -d {device_id} --properties "myprop=myvalue;$.ct=application/json"

Enviar código de status de resposta direta do método e carga útil de resposta direta do método como json bruto (somente mqtt)

az iot device simulate -n {iothub_name} -d {device_id} --method-response-code 201 --method-response-payload '{"result":"Direct method successful"}'

Enviar código de status de resposta direta do método e carga útil de resposta direta do método como caminho para o arquivo local (somente mqtt)

az iot device simulate -n {iothub_name} -d {device_id} --method-response-code 201 --method-response-payload '../my_direct_method_payload.json'

Enviar o estado inicial das propriedades geminadas do dispositivo como json bruto para o dispositivo de destino (apenas mqtt)

az iot device simulate -n {iothub_name} -d {device_id} --init-reported-properties '{"reported_prop_1":"val_1", "reported_prop_2":val_2}'

Enviar o estado inicial das propriedades geminadas do dispositivo como caminho para o arquivo local para o dispositivo de destino (somente mqtt)

az iot device simulate -n {iothub_name} -d {device_id} --init-reported-properties '../my_device_twin_reported_properties.json'

Uso básico (http)

az iot device simulate -n {iothub_name} -d {device_id} --protocol http

Enviar propriedades mistas (http)

az iot device simulate -n {iothub_name} -d {device_id} --protocol http --properties "iothub-app-myprop=myvalue;content-type=application/json;iothub-correlationid=12345"

Escolha a contagem total de mensagens e o intervalo entre as mensagens

az iot device simulate -n {iothub_name} -d {device_id} --msg-count 1000 --msg-interval 5

Rejeitar mensagens c2d (somente http)

az iot device simulate -n {iothub_name} -d {device_id} --rs reject --protocol http

Abandonar mensagens c2d (somente http)

az iot device simulate -n {iothub_name} -d {device_id} --rs abandon --protocol http

Parâmetros Obrigatórios

--device-id -d

ID do dispositivo de destino.

Parâmetros Opcionais

--certificate-file-path --cp

Caminho para o arquivo de certificado.

--da --data

Corpo da mensagem. Forneça texto ou json bruto.

valor predefinido: Ping from Az CLI IoT Extension
--dtmi --model-id

O Digital Twin Model Id que o dispositivo informará ao se conectar ao hub. Consulte https://docs.microsoft.com/en-us/azure/iot-develop/overview-iot-plug-and-play para obter mais detalhes.

--hub-name -n

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

--init-reported-properties --irp

Estado inicial das propriedades geminadas reportadas para o dispositivo de destino quando o simulador é executado. Param opcional, suportado apenas para mqtt.

--key --symmetric-key

Chave simétrica a utilizar para o dispositivo. Se a chave simétrica e outros argumentos de autenticação de dispositivo forem fornecidos, a chave simétrica terá prioridade.

--key-file-path --kp

Caminho para o arquivo de chave.

--login -l

Este comando suporta uma cadeia de conexão de entidade com direitos para executar a ação. 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.

--mc --msg-count

Número de mensagens de dispositivo a serem enviadas ao Hub IoT.

valor predefinido: 100
--method-response-code --mrc

Código de status a ser retornado quando o método direto é executado no dispositivo. Param opcional, suportado apenas para mqtt.

--method-response-payload --mrp

Carga útil a ser devolvida quando o método direto é executado no dispositivo. Forneça o caminho do arquivo ou json bruto. Param opcional, suportado apenas para mqtt.

--mi --msg-interval

Atraso em segundos entre mensagens do dispositivo para a nuvem.

valor predefinido: 3
--pass --passphrase

Senha para arquivo de chave.

--properties --props -p

Pacote de propriedades de mensagem em pares chave-valor com o seguinte formato: a=b; c=d. Para mensagens mqtt - você pode enviar propriedades do sistema usando $.=value. Por exemplo, $.cid=12345 define a propriedade Id de correlação do sistema. Outros exemplos de identificador de propriedade do sistema incluem $.ct para tipo de conteúdo, $.mid para ID de mensagem e $.ce para codificação de conteúdo. Para mensagens http - as propriedades do aplicativo são enviadas usando iothub-app-=value, por exemplo, iothub-app-myprop=myvalue. As propriedades do sistema geralmente são prefixadas com iothub- como iothub-correlationid, mas há exceções como content-type e content-encoding.

--proto --protocol

Indica o protocolo de mensagem do dispositivo para a nuvem.

valores aceites: http, mqtt
valor predefinido: mqtt
--receive-settle --rs

Indica como liquidar mensagens recebidas da nuvem para o dispositivo. Suportado apenas com HTTP.

valores aceites: abandon, complete, reject
valor predefinido: complete
--resource-group -g

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

Parâmetros de Globais
--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

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

--subscription

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

--verbose

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

az iot device upload-file

Carregue um arquivo local como um dispositivo para um contêiner de armazenamento de blob pré-configurado.

az iot device upload-file --content-type
                          --device-id
                          --file-path
                          [--hub-name]
                          [--login]
                          [--resource-group]

Parâmetros Obrigatórios

--content-type --ct

Tipo de ficheiro MIME.

--device-id -d

ID do dispositivo de destino.

--file-path --fp

Caminho para o arquivo para upload.

Parâmetros Opcionais

--hub-name -n

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

--login -l

Este comando suporta uma cadeia de conexão de entidade com direitos para executar a ação. 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.

--resource-group -g

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

Parâmetros de Globais
--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

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

--subscription

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

--verbose

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