Partilhar via

az iot device c2d-message

Note

Esta referência faz parte da extensão azure-iot para o CLI do Azure (versão 2.70.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

Name Description Tipo Status
az iot device c2d-message abandon

Abandone uma mensagem da nuvem para o dispositivo.

 Extension disponibilidade geral
az iot device c2d-message complete

Preencha uma mensagem da nuvem para o dispositivo.

 Extension disponibilidade geral
az iot device c2d-message purge

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

 Extension disponibilidade geral
az iot device c2d-message receive

Receba uma mensagem da nuvem para o dispositivo.

 Extension disponibilidade geral
az iot device c2d-message reject

Rejeitar ou enviar uma mensagem de nuvem para dispositivo.

 Extension disponibilidade geral
az iot device c2d-message send

Envie uma mensagem da nuvem para o dispositivo.

 Extension disponibilidade geral

az iot device c2d-message abandon

Abandone uma mensagem da nuvem para o dispositivo.

az iot device c2d-message abandon --device-id
                                  [--acquire-policy-token]
                                  [--change-reference]
                                  [--etag]
                                  [--hub-name]
                                  [--login]
                                  [--resource-group]

Parâmetros Obrigatórios

--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 tornar-se necessários para que o comando seja executado com êxito.

--acquire-policy-token

Aquisição automática de um token Azure Policy para esta operação de recurso.

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

O ID de referência de alteração relacionado para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--etag -e

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

--hub-name -n

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

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

Este comando suporta uma cadeia de ligação de entidade com direitos para executar ações. Use para evitar login de sessão via "az login". Se forem fornecidos tanto uma entidade, cadeia de ligação como o nome, a cadeia de ligaçã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 de Globais
--debug

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

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: 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 subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade Valor
Default value: False

az iot device c2d-message complete

Preencha uma mensagem da nuvem para o dispositivo.

az iot device c2d-message complete --device-id
                                   [--acquire-policy-token]
                                   [--change-reference]
                                   [--etag]
                                   [--hub-name]
                                   [--login]
                                   [--resource-group]

Parâmetros Obrigatórios

--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 tornar-se necessários para que o comando seja executado com êxito.

--acquire-policy-token

Aquisição automática de um token Azure Policy para esta operação de recurso.

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

O ID de referência de alteração relacionado para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--etag -e

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

--hub-name -n

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

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

Este comando suporta uma cadeia de ligação de entidade com direitos para executar ações. Use para evitar login de sessão via "az login". Se forem fornecidos tanto uma entidade, cadeia de ligação como o nome, a cadeia de ligaçã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 de Globais
--debug

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

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: 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 subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade Valor
Default value: 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
                                [--acquire-policy-token]
                                [--change-reference]
                                [--hub-name]
                                [--login]
                                [--resource-group]

Parâmetros Obrigatórios

--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 tornar-se necessários para que o comando seja executado com êxito.

--acquire-policy-token

Aquisição automática de um token Azure Policy para esta operação de recurso.

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

O ID de referência de alteração relacionado para esta operação de recurso.

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

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

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

Este comando suporta uma cadeia de ligação de entidade com direitos para executar ações. Use para evitar login de sessão via "az login". Se forem fornecidos tanto uma entidade, cadeia de ligação como o nome, a cadeia de ligaçã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 de Globais
--debug

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

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: 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 subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade Valor
Default value: 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 ack de mensagem [--complete, --reject, --abandon] será aceite.

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

Exemplos

Utilização básica

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 considere-a "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 Obrigatórios

--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 tornar-se necessários para que o comando seja executado com êxito.

--abandon

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

Propriedade Valor
Grupo de parâmetros: Message Ack Arguments
Default value: False
Valores aceites: false, true
--acquire-policy-token

Aquisição automática de um token Azure Policy para esta operação de recurso.

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

O ID de referência de alteração relacionado para esta operação de recurso.

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

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

Propriedade Valor
Grupo de parâmetros: Message Ack Arguments
Default value: False
Valores aceites: false, true
--hub-name -n

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

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

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

Propriedade Valor
Default value: 60
--login -l

Este comando suporta uma cadeia de ligação de entidade com direitos para executar ações. Use para evitar login de sessão via "az login". Se forem fornecidos tanto uma entidade, cadeia de ligação como o nome, a cadeia de ligaçã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
Default value: False
Valores aceites: 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 de Globais
--debug

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

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: 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 subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade Valor
Default value: False

az iot device c2d-message reject

Rejeitar ou enviar uma mensagem de nuvem para dispositivo.

az iot device c2d-message reject --device-id
                                 [--acquire-policy-token]
                                 [--change-reference]
                                 [--etag]
                                 [--hub-name]
                                 [--login]
                                 [--resource-group]

Parâmetros Obrigatórios

--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 tornar-se necessários para que o comando seja executado com êxito.

--acquire-policy-token

Aquisição automática de um token Azure Policy para esta operação de recurso.

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

O ID de referência de alteração relacionado para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--etag -e

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

--hub-name -n

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

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

Este comando suporta uma cadeia de ligação de entidade com direitos para executar ações. Use para evitar login de sessão via "az login". Se forem fornecidos tanto uma entidade, cadeia de ligação como o nome, a cadeia de ligaçã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 de Globais
--debug

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

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: 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 subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade Valor
Default value: False

az iot device c2d-message send

Envie uma mensagem da nuvem para o dispositivo.

Envie uma mensagem cloud para dispositivo via AMQP para um dispositivo alvo.

Nota: A codificação de conteúdo é padrão 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 a partir 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}]
                               [--acquire-policy-token]
                               [--auth-type {key, login}]
                               [--ce --content-encoding]
                               [--change-reference]
                               [--cid --correlation-id]
                               [--content-type --ct]
                               [--da --data]
                               [--data-file-path --dfp]
                               [--expiry --expiry-time-utc]
                               [--hub-name]
                               [--login]
                               [--message-id --mid]
                               [--properties --props]
                               [--resource-group]
                               [--uid --user-id]
                               [--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'

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 a partir de um ficheiro.

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 em formato JSON a partir 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 Obrigatórios

--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 tornar-se necessários para que o comando seja executado com êxito.

--ack

Solicite a entrega de feedback por mensagem sobre o estado final dessa mensagem. A descrição dos valores ack é a seguinte. Positivo: Se a mensagem c2d atingir o estado Completado, o Hub IoT gera uma mensagem de feedback. Negativo: Se a mensagem c2d atingir o estado Dead lettered, o Hub IoT gera uma mensagem de feedback. Completo: O Hub IoT gera uma mensagem de feedback em qualquer dos casos. Por padrão, nenhum ack é solicitado.

Propriedade Valor
Valores aceites: full, negative, positive
--acquire-policy-token

Aquisição automática de um token Azure Policy para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--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 de 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}.

Propriedade Valor
Grupo de parâmetros: Access Control Arguments
Default value: key
Valores aceites: key, login
--ce --content-encoding

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

Propriedade Valor
Default value: utf-8
--change-reference

O ID de referência de alteração relacionado para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--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.

Propriedade Valor
Default value: 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.

--expiry --expiry-time-utc

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

--hub-name -n

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

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

Este comando suporta uma cadeia de ligação de entidade com direitos para executar ações. Use para evitar login de sessão via "az login". Se forem fornecidos tanto uma entidade, cadeia de ligação como o nome, a cadeia de ligaçã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

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

--properties --props -p

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

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

Propriedade Valor
Default value: False
Valores aceites: false, true
--yes -y

Ignore os prompts do usuário. Indica a aceitação da ação. Usado principalmente para cenários de automação. Predefinição: false.

Propriedade Valor
Default value: False
Valores aceites: false, true
Parâmetros de Globais
--debug

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

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: 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 subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade Valor
Default value: False