az iot central device command
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 central device command . Saiba mais sobre extensões.
Execute comandos de dispositivo.
Comandos
Nome | Description | Tipo | Status |
---|---|---|---|
az iot central device command history |
Obtenha os detalhes da solicitação de comando e resposta mais recentes enviadas ao dispositivo. |
Extensão | 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. |
Extensão | GA |
az iot central device command history
Obtenha os detalhes da solicitação de comando e resposta mais recentes enviadas 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 execute para as propriedades do dispositivo como resultado da execução do comando não será incluída na resposta.
az iot central device command history --app-id
--cn
--device-id
[--api-version {2022-06-30-preview, 2022-07-31}]
[--central-api-uri]
[--co]
[--interface-id]
[--mn]
[--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 do 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
A ID do aplicativo do IoT Central que você deseja gerenciar. Você pode encontrar o ID do aplicativo na página "Sobre" do seu aplicativo no menu de ajuda.
O nome do comando conforme especificado no modelo de dispositivo. O nome do comando pode ser diferente do Nome para exibição do comando.
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
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ó daremos suporte às APIs do IoT Central da versão mais recente do GA. Se alguma API ainda não for GA, chamaremos a versão de visualização mais recente.
O sufixo DNS do IoT Central associado ao seu aplicativo.
O nome do componente do dispositivo.
O nome da interface/componente, conforme especificado no modelo de dispositivo. Você pode encontrá-lo navegando até o Modelo de dispositivo e exibir a identidade da interface/componente sob o recurso de dispositivo correspondente.
O nome do módulo do dispositivo.
Se preferir enviar sua solicitação sem 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
Aumente o detalhamento do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
Aumentar o detalhamento do log. Use --debug para logs de depuração completos.
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
--content
--device-id
[--api-version {2022-06-30-preview, 2022-07-31}]
[--central-api-uri]
[--co]
[--interface-id]
[--mn]
[--token]
Exemplos
Execute o comando com carga embutida. A carga útil 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 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 do 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
A ID do aplicativo do IoT Central que você deseja gerenciar. Você pode encontrar o ID do aplicativo na página "Sobre" do seu aplicativo no menu de ajuda.
O nome do comando conforme especificado no modelo de dispositivo. O nome do comando pode ser diferente do Nome para exibição do comando.
Configuração para solicitação. Forneça caminho para o arquivo JSON ou JSON stringificado bruto. [Exemplo de caminho do arquivo: ./path/to/file.json] [Exemplo JSON stringificado: {'a': 'b'}].
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
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ó daremos suporte às APIs do IoT Central da versão mais recente do GA. Se alguma API ainda não for GA, chamaremos a versão de visualização mais recente.
O sufixo DNS do IoT Central associado ao seu aplicativo.
O nome do componente do dispositivo.
O nome da interface/componente, conforme especificado no modelo de dispositivo. Você pode encontrá-lo navegando até o Modelo de dispositivo e exibir a identidade da interface/componente sob o recurso de dispositivo correspondente.
O nome do módulo do dispositivo.
Se preferir enviar sua solicitação sem 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
Aumente o detalhamento do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
Aumentar o detalhamento do log. Use --debug para logs de depuração completos.