Compartilhar via

az iot device c2d-message

Note

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

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

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.

--etag -e

Marca de etag ou entidade correspondente ao último estado do recurso. Se nenhuma etag for fornecida, o valor '*' será usado.

--hub-name -n

Nome ou nome do host do Hub IoT. 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 cadeia de conexão de entidade com direitos para executar a ação. Use para evitar o logon da 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 tem prioridade. 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

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

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.

--etag -e

Marca de etag ou entidade correspondente ao último estado do recurso. Se nenhuma etag for fornecida, o valor '*' será usado.

--hub-name -n

Nome ou nome do host do Hub IoT. 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 cadeia de conexão de entidade com direitos para executar a ação. Use para evitar o logon da 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 tem prioridade. 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

az iot device c2d-message purge

Limpe 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

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.

--hub-name -n

Nome ou nome do host do Hub IoT. 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 cadeia de conexão de entidade com direitos para executar a ação. Use para evitar o logon da 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 tem prioridade. 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

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 útil da mensagem será exibida como {{carga útil não decodificável}} quando a codificação de conteúdo não estiver definida como uma das opções acima, ou falhar ao decodificar mesmo quando a codificação de conteúdo estiver definida como uma das opções acima.

Nota: Apenas um argumento de confirmação 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 --lt]
                                  [--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}

Receber uma mensagem e escolhê-la como "concluída" depois de ser recebida

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

Receber uma mensagem e rejeitá-la depois que ela for 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

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.

--abandon

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

Propriedade Valor
Grupo de parâmetros: Message Ack Arguments
Valor padrão: False
Valores aceitos: false, true
--complete

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

Propriedade Valor
Grupo de parâmetros: Message Ack Arguments
Valor padrão: False
Valores aceitos: false, true
--hub-name -n

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

Propriedade Valor
Grupo de parâmetros: IoT Hub Identifier Arguments
--lock-timeout --lt

Especifica o tempo em que uma mensagem ficará invisível para outras chamadas de recebimento.

Propriedade Valor
Valor padrão: 60
--login -l

Esse comando dá suporte a uma cadeia de conexão de entidade com direitos para executar a ação. Use para evitar o logon da 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 tem prioridade. Obrigatório se --hub-name não for fornecido.

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

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

Propriedade Valor
Grupo de parâmetros: Message Ack Arguments
Valor padrão: False
Valores aceitos: false, true
--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 c2d-message reject

Rejeite ou envie mensagens mortas de uma mensagem da nuvem para o 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

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.

--etag -e

Marca de etag ou entidade correspondente ao último estado do recurso. Se nenhuma etag for fornecida, o valor '*' será usado.

--hub-name -n

Nome ou nome do host do Hub IoT. 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 cadeia de conexão de entidade com direitos para executar a ação. Use para evitar o logon da 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 tem prioridade. 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

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

Observação: a codificação de conteúdo é padronizada para utf-8. O comando enviará o corpo da mensagem com a ação de codificação quando a propriedade content-encoding 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 a partir de um arquivo (via --data-file-path) e content-type deve ser definido como application/octet-stream.

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

Exemplos

Uso básico com o corpo da mensagem padrão

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

Enviar mensagem de nuvem para 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'

Enviar uma mensagem C2D e aguardar 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

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.

--ack

Solicite a entrega de comentários 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 comentários. Negativo: se a mensagem c2d atingir o estado de letra morta, o Hub IoT gerará uma mensagem de comentários. Completo: o Hub IoT gera uma mensagem de comentários em ambos os casos. Por padrão, nenhum ack é solicitado.

Propriedade Valor
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 logon e o nome do host do recurso for fornecido, a pesquisa de recursos será ignorada, a menos que seja necessário. Você pode configurar o padrão usando az configure --defaults iothub-data-auth-type={auth-type-value}.

Propriedade Valor
Grupo de parâmetros: Access Control Arguments
Valor padrão: key
Valores aceitos: key, login
--ce --content-encoding

A codificação do corpo da mensagem C2D.

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

A ID de correlação associada à mensagem C2D.

--content-type --ct

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

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

--expiry --expiry-time-utc

As unidades são milissegundos desde a época do unix. Se nenhuma hora for indicada, a TTL de mensagem C2D do Hub IoT padrão será usada.

--hub-name -n

Nome ou nome do host do Hub IoT. 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 cadeia de conexão de entidade com direitos para executar a ação. Use para evitar o logon da 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 tem prioridade. Obrigatório se --hub-name não for fornecido.

Propriedade Valor
Grupo de parâmetros: IoT Hub Identifier Arguments
--message-id --mid

A ID da mensagem C2D. Se nenhuma ID de mensagem for fornecida, uma UUID será gerada.

--properties --props -p

Recipiente 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 de extensão. Padrão: false.

Propriedade Valor
Valor padrão: False
Valores aceitos: false, true
--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, a propriedade de ID do usuário.

--wait -w

Se definir a operação de envio c2d será bloqueada até que os comentários do dispositivo sejam recebidos.

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

Ignore as solicitações do usuário. Indica a aceitação da ação. Usado principalmente para cenários de automação. Padrão: false.

Propriedade Valor
Valor padrão: False
Valores aceitos: false, true
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