az iot device c2d-message

  • Referência

Observação

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

Comandos de mensagens da nuvem para o dispositivo.

Comandos

Nome Description Tipo Status
az iot device c2d-message abandon

Abandone uma mensagem da nuvem para o dispositivo.

 Extensão GA
az iot device c2d-message complete

Conclua uma mensagem da nuvem para o dispositivo.

 Extensão GA
az iot device c2d-message purge

Limpar 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 enviar 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 c2d-message abandon

Abandone uma mensagem da nuvem para o dispositivo.

az iot device c2d-message abandon --device-id
                                  [--etag]
                                  [--hub-name]
                                  [--login]
                                  [--resource-group]

Parâmetros Exigidos

--device-id -d

ID do dispositivo de destino.

Parâmetros Opcionais

--etag -e

Etag ou tag de entidade correspondente ao último estado do recurso. Se nenhum etag for fornecido, o valor '*' será usado.

--hub-name -n

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

--login -l

Esse comando oferece suporte a uma cadeia de conexão de entidade com direitos para executar ações. Use para evitar o login da sessão via "az login". Se uma cadeia de conexão de entidade e um nome forem fornecidos, a cadeia de conexão terá prioridade. Obrigatório se --hub-name não for fornecido.

--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 o detalhamento 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 aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--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 o detalhamento do log. Use --debug para logs de depuração completos.

az iot device c2d-message complete

Conclua uma mensagem da nuvem para o dispositivo.

az iot device c2d-message complete --device-id
                                   [--etag]
                                   [--hub-name]
                                   [--login]
                                   [--resource-group]

Parâmetros Exigidos

--device-id -d

ID do dispositivo de destino.

Parâmetros Opcionais

--etag -e

Etag ou tag de entidade correspondente ao último estado do recurso. Se nenhum etag for fornecido, o valor '*' será usado.

--hub-name -n

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

--login -l

Esse comando oferece suporte a uma cadeia de conexão de entidade com direitos para executar ações. Use para evitar o login da sessão via "az login". Se uma cadeia de conexão de entidade e um nome forem fornecidos, a cadeia de conexão terá prioridade. Obrigatório se --hub-name não for fornecido.

--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 o detalhamento 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 aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--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 o detalhamento do log. Use --debug para logs de depuração completos.

az iot device c2d-message purge

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

az iot device c2d-message purge --device-id
                                [--hub-name]
                                [--login]
                                [--resource-group]

Parâmetros Exigidos

--device-id -d

ID do dispositivo de destino.

Parâmetros Opcionais

--hub-name -n

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

--login -l

Esse comando oferece suporte a uma cadeia de conexão de entidade com direitos para executar ações. Use para evitar o login da sessão via "az login". Se uma cadeia de conexão de entidade e um nome forem fornecidos, a cadeia de conexão terá prioridade. Obrigatório se --hub-name não for fornecido.

--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 o detalhamento 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 aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--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 o detalhamento do log. Use --debug para logs de depuração completos.

az iot device c2d-message receive

Receba uma mensagem da nuvem para o dispositivo.

O corpo da mensagem recebida só será decodificado quando sua codificação de conteúdo estiver definida como 'utf-8', 'utf-16' ou 'utf-32'. A carga da mensagem será exibida como {{carga não decodificável}} quando a codificação de conteúdo não estiver definida como uma das opções acima ou não conseguir decodificar mesmo quando a codificação de conteúdo estiver definida como uma das opções acima.

Nota: Apenas um argumento de ack de mensagem [--complete, --reject, --abandon] será aceito.

az iot device c2d-message receive --device-id
                                  [--abandon {false, true}]
                                  [--complete {false, true}]
                                  [--hub-name]
                                  [--lock-timeout]
                                  [--login]
                                  [--reject {false, true}]
                                  [--resource-group]

Exemplos

Uso básico

az iot device c2d-message receive -d {device_id} -n {hub_name} -g {resource_group}

Receber uma mensagem e definir um tempo limite de bloqueio de 30 segundos para essa mensagem

az iot device c2d-message receive -d {device_id} -n {hub_name} -g {resource_group} --lt {30}

Receba uma mensagem e coloque-a como 'completa' depois de recebida

az iot device c2d-message receive -d {device_id} -n {hub_name} -g {resource_group} --complete

Receber uma mensagem e rejeitá-la depois de recebida

az iot device c2d-message receive -d {device_id} -n {hub_name} -g {resource_group} --reject

Parâmetros Exigidos

--device-id -d

ID do dispositivo de destino.

Parâmetros Opcionais

--abandon

Abandone a mensagem de nuvem para dispositivo após o recebimento.

Valores aceitos: false, true
Valor padrão: False
--complete

Conclua a mensagem da nuvem para o dispositivo após o recebimento.

Valores aceitos: false, true
Valor padrão: False
--hub-name -n

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

--lock-timeout --lt

Especifica a quantidade de tempo que uma mensagem ficará invisível para outras chamadas recebidas.

Valor padrão: 60
--login -l

Esse comando oferece suporte a uma cadeia de conexão de entidade com direitos para executar ações. Use para evitar o login da sessão via "az login". Se uma cadeia de conexão de entidade e um nome forem fornecidos, a cadeia de conexão terá prioridade. Obrigatório se --hub-name não for fornecido.

--reject

Rejeite a mensagem da nuvem para o dispositivo após o recebimento.

Valores aceitos: false, true
Valor padrão: False
--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 o detalhamento 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 aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--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 o detalhamento do log. Use --debug para logs de depuração completos.

az iot device c2d-message reject

Rejeitar ou enviar uma mensagem de nuvem para dispositivo.

az iot device c2d-message reject --device-id
                                 [--etag]
                                 [--hub-name]
                                 [--login]
                                 [--resource-group]

Parâmetros Exigidos

--device-id -d

ID do dispositivo de destino.

Parâmetros Opcionais

--etag -e

Etag ou tag de entidade correspondente ao último estado do recurso. Se nenhum etag for fornecido, o valor '*' será usado.

--hub-name -n

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

--login -l

Esse comando oferece suporte a uma cadeia de conexão de entidade com direitos para executar ações. Use para evitar o login da sessão via "az login". Se uma cadeia de conexão de entidade e um nome forem fornecidos, a cadeia de conexão terá prioridade. Obrigatório se --hub-name não for fornecido.

--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 o detalhamento 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 aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--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 o detalhamento do log. Use --debug para logs de depuração completos.

az iot device c2d-message send

Envie uma mensagem da nuvem para o dispositivo.

Este comando depende e pode instalar o pacote Cython dependente (uamqp) na primeira execução. https://github.com/Azure/azure-uamqp-python

Nota: A codificação de conteúdo é padronizada para utf-8. O comando enviará o corpo da mensagem com ação de codificação quando a propriedade de codificação de conteúdo for utf-8, utf-16 ou utf-32. Se o valor de codificação de conteúdo não for um desses, a propriedade ainda será enviada sem nenhuma ação de codificação executada.

Ao enviar um corpo de mensagem binária, o conteúdo deve ser fornecido de um arquivo (via --data-file-path) e o tipo de conteúdo deve ser definido como application/octet-stream.

az iot device c2d-message send --device-id
                               [--ack {full, negative, positive}]
                               [--auth-type {key, login}]
                               [--ce]
                               [--cid]
                               [--content-type]
                               [--da]
                               [--data-file-path]
                               [--expiry]
                               [--hub-name]
                               [--login]
                               [--message-id]
                               [--properties]
                               [--repair {false, true}]
                               [--resource-group]
                               [--uid]
                               [--wait {false, true}]
                               [--yes {false, true}]

Exemplos

Uso básico com corpo de mensagem padrão

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

Envie mensagens da nuvem para o dispositivo com dados e propriedades personalizados.

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

Envie uma mensagem C2D e aguarde a confirmação do dispositivo

az iot device c2d-message send -d {device_id} -n {iothub_name} --ack full --wait

Envie uma mensagem C2D em formato binário de um arquivo.

az iot device c2d-message send -d {device_id} -n {iothub_name} --data-file-path {file_path} --content-type 'application/octet-stream'

Envie uma mensagem C2D no formato JSON de um arquivo.

az iot device c2d-message send -d {device_id} -n {iothub_name} --data-file-path {file_path} --content-type 'application/json'

Parâmetros Exigidos

--device-id -d

ID do dispositivo de destino.

Parâmetros Opcionais

--ack

Solicite a entrega de feedback por mensagem sobre o estado final dessa mensagem. A descrição dos valores de ack é a seguinte. Positivo: se a mensagem c2d atingir o estado Concluído, o Hub IoT gerará uma mensagem de feedback. Negativo: se a mensagem c2d atingir o estado Letra morta, o Hub IoT gerará uma mensagem de feedback. Completo: o Hub IoT gera uma mensagem de feedback em ambos os casos. Por padrão, nenhum ack é solicitado.

Valores aceitos: full, negative, positive
--auth-type

Indica se a operação deve derivar automaticamente uma chave de política ou usar a sessão atual do Azure AD. Se o tipo de autenticação for login e o nome do host do recurso for fornecido, a pesquisa de recursos será ignorada, a menos que necessário. Você pode configurar o padrão usando az configure --defaults iothub-data-auth-type=<auth-type-value>o .

Valores aceitos: key, login
Valor padrão: key
--ce --content-encoding

A codificação para o corpo da mensagem C2D.

Valor padrão: utf-8
--cid --correlation-id

O ID de correlação associado à mensagem C2D.

--content-type --ct

O tipo de conteúdo para o corpo da mensagem C2D.

--da --data

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

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 a carga útil do corpo da mensagem. Observe que quando a carga precisa ser enviada em formato binário, defina o tipo de conteúdo como application/octet-stream.

--expiry --expiry-time-utc

As unidades são milissegundos desde a época unix. Se nenhum momento for indicado, a mensagem padrão do Hub IoT C2D TTL será usada.

--hub-name -n

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

--login -l

Esse comando oferece suporte a uma cadeia de conexão de entidade com direitos para executar ações. Use para evitar o login da sessão via "az login". Se uma cadeia de conexão de entidade e um nome forem fornecidos, a cadeia de conexão terá prioridade. Obrigatório se --hub-name não for fornecido.

--message-id --mid

O ID da mensagem C2D. Se nenhuma mensagem Id for fornecida, um UUID será gerado.

--properties --props -p

Conjunto de propriedades de mensagem em pares chave-valor com o seguinte formato: a=b; c=d.

--repair -r

Reinstale a dependência uamqp compatível com a versão da extensão. Padrão: falso.

Valores aceitos: false, true
Valor padrão: False
--resource-group -g

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

--uid --user-id

A mensagem C2D, propriedade Id do usuário.

--wait -w

Se definido, a operação de envio c2d será bloqueada até que o feedback do dispositivo tenha sido recebido.

Valores aceitos: false, true
Valor padrão: False
--yes -y

Ignorar prompts do usuário. Indica aceitação da ação. Usado principalmente para cenários de automação. Padrão: falso.

Valores aceitos: false, true
Valor padrão: False
Parâmetros Globais
--debug

Aumente o detalhamento 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 aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--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 o detalhamento do log. Use --debug para logs de depuração completos.