az iot device

Observação

Esta referência faz parte da extensão Azure-IOT para CLI do Azure e requer a versão 2.0.70 ou superior. A extensão será instalada automaticamente na primeira vez que você executar um comando AZ IOT Device . Saiba mais sobre extensões.

Utilizar os recursos de mensagens de dispositivo para nuvem e nuvem para dispositivo.

Comandos

az iot device c2d-message

Comandos de mensagens da nuvem para o dispositivo.

az iot device c2d-message abandon

Abandone uma mensagem da nuvem para o dispositivo.

az iot device c2d-message complete

Concluir uma mensagem da nuvem para o dispositivo.

az iot device c2d-message purge

Limpar fila de mensagens da nuvem para o dispositivo para um dispositivo de destino.

az iot device c2d-message receive

Receber uma mensagem da nuvem para o dispositivo.

az iot device c2d-message reject

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

az iot device c2d-message send

Enviar uma mensagem da nuvem para o dispositivo.

az iot device send-d2c-message

Envie uma mensagem do dispositivo para a nuvem do MQTT. O comando dá suporte ao envio de mensagens com propriedades do aplicativo e do sistema.

az iot device simulate

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 as mensagens da nuvem para o dispositivo (C2D). Para a simulação de MQTT, todas as mensagens de C2D serão confirmadas com a conclusão. Para a C2D de simulação de http, a confirmação é baseada na seleção do usuário que pode ser concluída, rejeitar ou abandonar.

Observação: o comando, por padrão, definirá Content-Type como Application/JSON e Content-Encoding como UTF-8. Isso pode ser substituído.

az iot device upload-file

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

az iot device send-d2c-message

Envie uma mensagem do dispositivo para a nuvem do MQTT. O comando dá suporte ao envio de mensagens com propriedades do aplicativo e do sistema.

az iot device send-d2c-message --device-id
                               [--da]
                               [--hub-name]
                               [--login]
                               [--mc]
                               [--properties]
                               [--qos {0, 1}]
                               [--resource-group]

Exemplos

Uso básico

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

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

Parâmetros Exigidos

--device-id -d

Dispositivo de destino.

Parâmetros Opcionais

--da --data

Corpo da mensagem.

valor padrão: Ping from Az CLI IoT Extension
--hub-name -n

Nome do Hub IoT.

--login -l

Este comando dá suporte a uma cadeia de conexão de entidade com direitos para executar a ação. Use para evitar o logon de sessão por meio de "AZ login". Se uma cadeia de conexão de entidade e o nome forem fornecidos, a cadeia de conexão terá prioridade.

--mc --msg-count

Número de mensagens do dispositivo a enviar ao Hub IoT.

valor padrão: 1
--properties --props -p

Recipiente de propriedades de mensagem em pares de chave-valor com o seguinte formato: a = b; c = d. Para o MQTT Messaging-você pode enviar propriedades do sistema usando $. = valor. Por exemplo, $. CID = 12345 define a propriedade de 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.

--qos

Qualidade do serviço. 0 = no máximo uma vez, 1 = pelo menos uma vez. 2 (exatamente uma vez) não é suportado.

valores aceitos: 0, 1
valor padrão: 1
--resource-group -g

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

az iot device simulate

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 as mensagens da nuvem para o dispositivo (C2D). Para a simulação de MQTT, todas as mensagens de C2D serão confirmadas com a conclusão. Para a C2D de simulação de http, a confirmação é baseada na seleção do usuário que pode ser concluída, rejeitar ou abandonar.

Observação: o comando, por padrão, definirá Content-Type como Application/JSON e Content-Encoding como UTF-8. Isso pode ser substituído.

az iot device simulate --device-id
                       [--da]
                       [--hub-name]
                       [--login]
                       [--mc]
                       [--mi]
                       [--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 (MQTT) com o envio de propriedades mistas

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

Uso básico (http)

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

Uso básico (http) com o envio de propriedades mistas

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

Escolher contagem total de mensagens e 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

Dispositivo de destino.

Parâmetros Opcionais

--da --data

Corpo da mensagem.

valor padrão: Ping from Az CLI IoT Extension
--hub-name -n

Nome do Hub IoT.

--login -l

Este comando dá suporte a uma cadeia de conexão de entidade com direitos para executar a ação. Use para evitar o logon de sessão por meio de "AZ login". Se uma cadeia de conexão de entidade e o nome forem fornecidos, a cadeia de conexão terá prioridade.

--mc --msg-count

Número de mensagens do dispositivo a enviar ao Hub IoT.

valor padrão: 100
--mi --msg-interval

Atraso em segundos entre as mensagens do dispositivo para a nuvem.

valor padrão: 3
--properties --props -p

Recipiente de propriedades de mensagem em pares de chave-valor com o seguinte formato: a = b; c = d. Para o MQTT Messaging-você pode enviar propriedades do sistema usando $. = valor. Por exemplo, $. CID = 12345 define a propriedade de 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. Geralmente, as propriedades do sistema são prefixadas com iothub 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.

valores aceitos: http, mqtt
valor padrão: mqtt
--receive-settle --rs

Indica como liquidar mensagens recebidas da nuvem para o dispositivo. Com suporte apenas para HTTP.

valores aceitos: abandon, complete, reject
valor padrão: complete
--resource-group -g

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

az iot device upload-file

Carregar um arquivo local como um dispositivo em 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 Exigidos

--content-type --ct

Tipo MIME de arquivo.

--device-id -d

Dispositivo de destino.

--file-path --fp

Caminho para o carregamento do arquivo.

Parâmetros Opcionais

--hub-name -n

Nome do Hub IoT.

--login -l

Este comando dá suporte a uma cadeia de conexão de entidade com direitos para executar a ação. Use para evitar o logon de sessão por meio de "AZ login". Se uma cadeia de conexão de entidade e o nome forem fornecidos, a cadeia de conexão terá prioridade.

--resource-group -g

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