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

Execute comandos do dispositivo.

Comandos

Nome Description Tipo Status
az iot central device command history

Obtenha os detalhes da solicitação de comando e da resposta mais recentes enviadas ao dispositivo.

 Extension GA
az iot central device command run

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

 Extension GA

az iot central device command history

Obtenha os detalhes da solicitação de comando e da resposta mais recentes enviadas ao dispositivo.

Lista a solicitação de comando e a resposta mais recentes que foram enviadas ao dispositivo 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 de comando

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

Mostrar resposta de comando do componente

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

Mostrar resposta de comando do componente do 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 Exigidos

--app-id -n

A ID do aplicativo do IoT Central que você deseja gerenciar. Você pode encontrar a ID do aplicativo na página "Sobre" para 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 de Exibição do comando.

--device-id -d

A ID do dispositivo de destino. Você pode encontrar a 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 se tornar obrigatórios para que o comando seja executado com sucesso.

--api-version --av
Preterido

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

Esse parâmetro de comando foi preterido e será ignorado. Na versão futura, só ofereceremos suporte a APIs do IoT Central da versão mais recente da GA. Se alguma API ainda não for GA, chamaremos a versão prévia mais recente.

Propriedade Valor
Valor padrão: 2022-07-31
Valores aceitos: 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
Valor padrão: 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é o Modelo de Dispositivo e exibindo a identidade de interface/componente sob a funcionalidade do dispositivo correspondente.

--mn --module-name

O nome do módulo do dispositivo.

--token

Se preferir enviar sua solicitação sem se autenticar na CLI do Azure, você poderá 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 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 central device command run

Execute um comando em um dispositivo e exiba a resposta associada. NÃO monitora as 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 conteúdo embutido. O conteúdo deve estar em "solicitação" na cadeia de caracteres 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 o caminho de conteúdo json.

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

Execute o comando de componente.

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

Execute o comando de componente do módulo.

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

Parâmetros Exigidos

--app-id -n

A ID do aplicativo do IoT Central que você deseja gerenciar. Você pode encontrar a ID do aplicativo na página "Sobre" para 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 de Exibição do comando.

--content -k

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

--device-id -d

A ID do dispositivo de destino. Você pode encontrar a 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 se tornar obrigatórios para que o comando seja executado com sucesso.

--api-version --av
Preterido

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

Esse parâmetro de comando foi preterido e será ignorado. Na versão futura, só ofereceremos suporte a APIs do IoT Central da versão mais recente da GA. Se alguma API ainda não for GA, chamaremos a versão prévia mais recente.

Propriedade Valor
Valor padrão: 2022-07-31
Valores aceitos: 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
Valor padrão: 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é o Modelo de Dispositivo e exibindo a identidade de interface/componente sob a funcionalidade do dispositivo correspondente.

--mn --module-name

O nome do módulo do dispositivo.

--token

Se preferir enviar sua solicitação sem se autenticar na CLI do Azure, você poderá 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 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