Compartilhar via

az iot device

Note

Essa referência faz parte da extensão azure-iot para o CLI do Azure (versão 2.70.0 ou superior). A extensão instalará 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

Nome Description Tipo Status
az iot device c2d-message

Comandos de mensagens da nuvem para o dispositivo.

 Extension GA
az iot device c2d-message abandon

Abandone uma mensagem da nuvem para o dispositivo.

 Extension GA
az iot device c2d-message complete

Conclua uma mensagem da nuvem para o dispositivo.

 Extension GA
az iot device c2d-message purge

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

 Extension GA
az iot device c2d-message receive

Receba uma mensagem da nuvem para o dispositivo.

 Extension GA
az iot device c2d-message reject

Rejeite ou envie mensagens mortas de uma mensagem da nuvem para o dispositivo.

 Extension GA
az iot device c2d-message send

Envie uma mensagem da nuvem para o dispositivo.

 Extension GA
az iot device registration

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

 Extension Preview
az iot device registration create

Registre um dispositivo IoT no Serviço de Provisionamento de Dispositivos IoT.

 Extension Preview
az iot device send-d2c-message

Envie uma mensagem mqtt do dispositivo para a nuvem.

 Extension GA
az iot device simulate

Simular um dispositivo em um Hub IoT do Azure.

 Extension Experimental
az iot device upload-file

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

 Extension GA

az iot device send-d2c-message

Envie uma mensagem mqtt do dispositivo para a nuvem.

O comando dá suporte ao envio de mensagens com conteúdo personalizado em cadeia de caracteres unicode ou formato binário. 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.

Observação: 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 de tipo de conteúdo deve ser application/JSON e a propriedade do sistema de codificação de conteúdo deve ser um dos valores de codificação UTF compatíveis com essa propriedade do sistema (UTF-8, UTF-16 ou UTF-32). Se a codificação de conteúdo não estiver definida quando Armazenamento do Azure for usada como ponto de extremidade de roteamento, Hub IoT gravará as mensagens no formato codificado em 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
                               [--acquire-policy-token]
                               [--certificate-file-path --cp]
                               [--change-reference]
                               [--da --data]
                               [--data-file-path --dfp]
                               [--dtmi --model-id]
                               [--hub-name]
                               [--key --symmetric-key]
                               [--key-file-path --kp]
                               [--login]
                               [--mc --msg-count]
                               [--pass --passphrase]
                               [--properties --props]
                               [--resource-group]

Exemplos

Uso Básico

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

Uso básico para o dispositivo que registra a 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 na qual o arquivo de chave tem uma frase secreta

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 de 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 codificação de conteúdo em 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}

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

--device-id -d

ID do dispositivo de destino.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--acquire-policy-token

Adquirir um token Azure Policy automaticamente para essa operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--certificate-file-path --cp

Caminho para o arquivo de certificado.

Propriedade Valor
Grupo de parâmetros: Device Authentication Arguments
--change-reference

A ID de referência de alteração relacionada para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--da --data

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

Propriedade Valor
Valor padrão: Ping from Az CLI IoT Extension
--data-file-path --dfp
Versão Prévia

Forneça o caminho para o arquivo para o conteúdo do corpo da mensagem. Observe quando o conteúdo precisa ser enviado no formato binário, defina o tipo de conteúdo como application/octet-stream.

--dtmi --model-id

A ID do Modelo de Gêmeo Digital que o dispositivo relatará ao se conectar ao hub. Consulte https://learn.microsoft.com/en-us/azure/iot-develop/overview-iot-plug-and-play para obter mais detalhes.

Propriedade Valor
Grupo de parâmetros: Digital Twin Arguments
--hub-name -n

Hub IoT nome ou nome do host. Necessário se --login não for fornecido.

Propriedade Valor
Grupo de parâmetros: IoT Hub Identifier Arguments
--key --symmetric-key

Chave simétrica a ser usada para o dispositivo. Se a chave simétrica e outros argumentos de autenticação de dispositivo forem fornecidos, a chave simétrica tem prioridade.

Propriedade Valor
Grupo de parâmetros: Device Authentication Arguments
--key-file-path --kp

Caminho para o arquivo de chave.

Propriedade Valor
Grupo de parâmetros: Device Authentication Arguments
--login -l

Esse comando dá suporte a uma entidade cadeia de conexão com direitos para executar a ação. Use para evitar o logon da sessão por meio de "az login". Se uma entidade cadeia de conexão e um nome forem fornecidos, o cadeia de conexão será priorizado. Obrigatório se --hub-name não for fornecido.

Propriedade Valor
Grupo de parâmetros: IoT Hub Identifier Arguments
--mc --msg-count

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

Propriedade Valor
Valor padrão: 1
--pass --passphrase

Frase secreta para o arquivo de chave.

Propriedade Valor
Grupo de parâmetros: Device Authentication Arguments
--properties --props -p

Recipiente de propriedades de mensagem em pares chave-valor com o seguinte formato: a=b; c=d. Para mensagens mqtt - você é capaz de enviar propriedades do sistema usando $. {name}=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

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

Parâmetros Globais
--debug

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

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade Valor
Valor padrão: False

az iot device simulate

Habilitação

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

Simular um dispositivo em um Hub IoT do Azure.

Enquanto a simulação do dispositivo estiver em execução, o dispositivo receberá e confirmará automaticamente mensagens da nuvem para o dispositivo (c2d). Para simulação mqtt, todas as mensagens c2d serão confirmadas com a conclusão. Para simulação http, a confirmação c2d é baseada na seleção do usuário, que pode ser completa, rejeitada ou abandonada. A simulação mqtt também suporta invocação direta de método que pode ser confirmada 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. Observação: se estiver usando métodos de autenticação x509, o certificado e os arquivos de chave (e senha, se necessário) devem ser fornecidos.

az iot device simulate --device-id
                       [--acquire-policy-token]
                       [--certificate-file-path --cp]
                       [--change-reference]
                       [--da --data]
                       [--dtmi --model-id]
                       [--hub-name]
                       [--init-reported-properties --irp]
                       [--key --symmetric-key]
                       [--key-file-path --kp]
                       [--login]
                       [--mc --msg-count]
                       [--method-response-code --mrc]
                       [--method-response-payload --mrp]
                       [--mi --msg-interval]
                       [--pass --passphrase]
                       [--properties --props]
                       [--proto --protocol {http, mqtt}]
                       [--receive-settle --rs {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 a 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) em que o arquivo de chave tem uma frase secreta

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 de método direto e conteúdo de resposta de método direto 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 de método direto e conteúdo de resposta de método direto 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 relatadas do dispositivo gêmeo como json bruto para o dispositivo de destino (somente 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 relatadas do dispositivo gêmeo 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 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 Exigidos

--device-id -d

ID do dispositivo de destino.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--acquire-policy-token

Adquirir um token Azure Policy automaticamente para essa operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--certificate-file-path --cp

Caminho para o arquivo de certificado.

Propriedade Valor
Grupo de parâmetros: Device Authentication Arguments
--change-reference

A ID de referência de alteração relacionada para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--da --data

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

Propriedade Valor
Valor padrão: Ping from Az CLI IoT Extension
--dtmi --model-id

A ID do Modelo de Gêmeo Digital que o dispositivo relatará ao se conectar ao hub. Consulte https://learn.microsoft.com/en-us/azure/iot-develop/overview-iot-plug-and-play para obter mais detalhes.

Propriedade Valor
Grupo de parâmetros: Digital Twin Arguments
--hub-name -n

Hub IoT nome ou nome do host. Necessário se --login não for fornecido.

Propriedade Valor
Grupo de parâmetros: IoT Hub Identifier Arguments
--init-reported-properties --irp

Estado inicial das propriedades relatadas do gêmeo para o dispositivo de destino quando o simulador é executado. Parâmetro opcional, com suporte apenas para mqtt.

--key --symmetric-key

Chave simétrica a ser usada para o dispositivo. Se a chave simétrica e outros argumentos de autenticação de dispositivo forem fornecidos, a chave simétrica tem prioridade.

Propriedade Valor
Grupo de parâmetros: Device Authentication Arguments
--key-file-path --kp

Caminho para o arquivo de chave.

Propriedade Valor
Grupo de parâmetros: Device Authentication Arguments
--login -l

Esse comando dá suporte a uma entidade cadeia de conexão com direitos para executar a ação. Use para evitar o logon da sessão por meio de "az login". Se uma entidade cadeia de conexão e um nome forem fornecidos, o cadeia de conexão será priorizado. Obrigatório se --hub-name não for fornecido.

Propriedade Valor
Grupo de parâmetros: IoT Hub Identifier Arguments
--mc --msg-count

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

Propriedade Valor
Valor padrão: 100
--method-response-code --mrc

Código de status a ser retornado quando o método direto é executado no dispositivo. Parâmetro opcional, com suporte apenas para mqtt.

--method-response-payload --mrp

Carga a ser retornada quando o método direto é executado no dispositivo. Forneça o caminho do arquivo ou json bruto. Parâmetro opcional, com suporte apenas para mqtt.

--mi --msg-interval

Atraso em segundos entre mensagens do dispositivo para a nuvem.

Propriedade Valor
Valor padrão: 3
--pass --passphrase

Frase secreta para o arquivo de chave.

Propriedade Valor
Grupo de parâmetros: Device Authentication Arguments
--properties --props -p

Recipiente de propriedades de mensagem em pares chave-valor com o seguinte formato: a=b; c=d. Para mensagens mqtt - você é capaz de enviar propriedades do sistema usando $. {name}=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-{name}=value, por exemplo iothub-app-myprop=myvalue. As propriedades do sistema geralmente são prefixadas com iothub-{name} como iothub-correlationid, mas há exceções como tipo de conteúdo e codificação de conteúdo.

--proto --protocol

Indica o protocolo de mensagem do dispositivo para a nuvem.

Propriedade Valor
Valor padrão: mqtt
Valores aceitos: http, mqtt
--receive-settle --rs

Indica como liquidar mensagens de nuvem para dispositivo recebidas. Com suporte apenas com HTTP.

Propriedade Valor
Valor padrão: complete
Valores aceitos: abandon, complete, reject
--resource-group -g

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

Parâmetros Globais
--debug

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

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade Valor
Valor padrão: False

az iot device upload-file

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

az iot device upload-file --content-type --ct
                          --device-id
                          --file-path --fp
                          [--acquire-policy-token]
                          [--change-reference]
                          [--hub-name]
                          [--login]
                          [--resource-group]

Parâmetros Exigidos

--content-type --ct

Tipo mime de arquivo.

--device-id -d

ID do dispositivo de destino.

--file-path --fp

Caminho para o arquivo para upload.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--acquire-policy-token

Adquirir um token Azure Policy automaticamente para essa operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--change-reference

A ID de referência de alteração relacionada para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--hub-name -n

Hub IoT nome ou nome do host. Necessário se --login não for fornecido.

Propriedade Valor
Grupo de parâmetros: IoT Hub Identifier Arguments
--login -l

Esse comando dá suporte a uma entidade cadeia de conexão com direitos para executar a ação. Use para evitar o logon da sessão por meio de "az login". Se uma entidade cadeia de conexão e um nome forem fornecidos, o cadeia de conexão será priorizado. Obrigatório se --hub-name não for fornecido.

Propriedade Valor
Grupo de parâmetros: IoT Hub Identifier Arguments
--resource-group -g

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

Parâmetros Globais
--debug

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

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade Valor
Valor padrão: False