Partilhar via

az iot central device command

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 será instalada automaticamente na primeira vez que você executar um comando comando az iot central device. Saiba mais sobre extensões.

Execute comandos de dispositivo.

Comandos

Name Description Tipo Status
az iot central device command history

Obtenha os detalhes da última solicitação de comando e resposta enviada ao dispositivo.

 Extension disponibilidade geral
az iot central device command run

Execute um comando em um dispositivo e visualize a resposta associada. NÃO monitora atualizações de propriedade que o comando pode executar.

 Extension disponibilidade geral

az iot central device command history

Obtenha os detalhes da última solicitação de comando e resposta enviada ao dispositivo.

Lista a solicitação de comando e a resposta mais recentes que foram enviadas para o dispositivo a partir do IoT Central. Qualquer atualização que o dispositivo executa nas propriedades do dispositivo como resultado da execução do comando não é incluída na resposta.

az iot central device command history --app-id
                                      --cn --command-name
                                      --device-id
                                      [--api-version --av {2022-06-30-preview, 2022-07-31}]
                                      [--central-api-uri --central-dns-suffix]
                                      [--co --component-name]
                                      [--interface-id]
                                      [--mn --module-name]
                                      [--token]

Exemplos

Mostrar resposta do comando

az iot central device command history --app-id {appid} --device-id {deviceid} --interface-id {interfaceid} --command-name {commandname}

Mostrar resposta do comando do componente

az iot central device command history --app-id {appid} --device-id {deviceid} --component-name {componentname} --command-name {commandname}

Mostrar resposta do comando do componente módulo

az iot central device command history --app-id {appid} --device-id {deviceid} --module-name {modulename} --component-name {componentname} --command-name {commandname}

Parâmetros Obrigatórios

--app-id -n

A ID do aplicativo IoT Central que você deseja gerenciar. Você pode encontrar o ID do aplicativo na página "Sobre" do seu aplicativo no menu de ajuda.

--cn --command-name

O nome do comando, conforme especificado no modelo de dispositivo. O nome do comando pode ser diferente do Nome para exibição do comando.

--device-id -d

O ID do dispositivo de destino. Você pode encontrar o ID do dispositivo clicando no botão Conectar na página Detalhes do dispositivo.

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.

--api-version --av
Preterido

O argumento 'api_version' foi preterido e será removido em uma versão futura.

Este parâmetro de comando foi preterido e será ignorado. Na versão futura, só suportaremos APIs do IoT Central a partir da versão mais recente do GA. Se alguma API ainda não for GA, chamaremos a versão de visualização mais recente.

Propriedade Valor
Default value: 2022-07-31
Valores aceites: 2022-06-30-preview, 2022-07-31
--central-api-uri --central-dns-suffix

O sufixo DNS do IoT Central associado ao seu aplicativo.

Propriedade Valor
Default value: azureiotcentral.com
--co --component-name

O nome do componente do dispositivo.

--interface-id -i

O nome da interface/componente, conforme especificado no modelo de dispositivo. Você pode encontrá-lo navegando até Modelo de dispositivo e visualizar a identidade da interface/componente sob o recurso de dispositivo correspondente.

--mn --module-name

O nome do módulo do dispositivo.

--token

Se preferir enviar sua solicitação sem autenticar na CLI do Azure, você pode especificar um token de usuário válido para autenticar sua solicitação. Você deve especificar o tipo de chave como parte da solicitação. Saiba mais em https://aka.ms/iotcentraldocsapi.

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 central device command run

Execute um comando em um dispositivo e visualize a resposta associada. NÃO monitora atualizações de propriedade que o comando pode executar.

--content pode ser JSON embutido ou caminho de arquivo.

az iot central device command run --app-id
                                  --cn --command-name
                                  --content
                                  --device-id
                                  [--api-version --av {2022-06-30-preview, 2022-07-31}]
                                  [--central-api-uri --central-dns-suffix]
                                  [--co --component-name]
                                  [--interface-id]
                                  [--mn --module-name]
                                  [--token]

Exemplos

Execute o comando com carga útil em linha. A carga útil deve estar em "request" na string json

az iot central device command run --app-id {appid} --device-id {deviceid} --interface-id {interfaceid} --command-name {commandname} --content '{"request": {payload}}'

Comando de execução curta com caminho de carga json.

az iot central device command run -n {appid} -d {deviceid} -i {interfaceid} --cn {commandname} -k {payload_file_path}

Execute o comando componente.

az iot central device command run -n {appid} -d {deviceid} --co {componentname} --cn {commandname} -k {payload}

Execute o comando module component.

az iot central device command run -n {appid} -d {deviceid} --mn {modulename} --co {componentname} --cn {commandname} -k {payload}

Parâmetros Obrigatórios

--app-id -n

A ID do aplicativo IoT Central que você deseja gerenciar. Você pode encontrar o ID do aplicativo na página "Sobre" do seu aplicativo no menu de ajuda.

--cn --command-name

O nome do comando, conforme especificado no modelo de dispositivo. O nome do comando pode ser diferente do Nome para exibição do comando.

--content -k

Configuração para solicitação. Forneça caminho para o arquivo JSON ou JSON stringified bruto. [Exemplo de caminho do arquivo: ./path/to/file.json] [Exemplo JSON stringificado: {'a': 'b'}].

--device-id -d

O ID do dispositivo de destino. Você pode encontrar o ID do dispositivo clicando no botão Conectar na página Detalhes do dispositivo.

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.

--api-version --av
Preterido

O argumento 'api_version' foi preterido e será removido em uma versão futura.

Este parâmetro de comando foi preterido e será ignorado. Na versão futura, só suportaremos APIs do IoT Central a partir da versão mais recente do GA. Se alguma API ainda não for GA, chamaremos a versão de visualização mais recente.

Propriedade Valor
Default value: 2022-07-31
Valores aceites: 2022-06-30-preview, 2022-07-31
--central-api-uri --central-dns-suffix

O sufixo DNS do IoT Central associado ao seu aplicativo.

Propriedade Valor
Default value: azureiotcentral.com
--co --component-name

O nome do componente do dispositivo.

--interface-id -i

O nome da interface/componente, conforme especificado no modelo de dispositivo. Você pode encontrá-lo navegando até Modelo de dispositivo e visualizar a identidade da interface/componente sob o recurso de dispositivo correspondente.

--mn --module-name

O nome do módulo do dispositivo.

--token

Se preferir enviar sua solicitação sem autenticar na CLI do Azure, você pode especificar um token de usuário válido para autenticar sua solicitação. Você deve especificar o tipo de chave como parte da solicitação. Saiba mais em https://aka.ms/iotcentraldocsapi.

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