az iot central device-template
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-template . Saiba mais sobre extensões.
Gerenciar e configurar modelos de dispositivo do IoT Central.
Comandos
Nome | Description | Tipo | Status |
---|---|---|---|
az iot central device-template create |
Crie um modelo de dispositivo no IoT Central. |
Extensão | GA |
az iot central device-template delete |
Exclua um modelo de dispositivo do IoT Central. |
Extensão | GA |
az iot central device-template list |
Obtenha a lista de modelos de dispositivo para um aplicativo do IoT Central. |
Extensão | GA |
az iot central device-template show |
Obtenha um modelo de dispositivo do IoT Central. |
Extensão | GA |
az iot central device-template update |
Atualizar um modelo de dispositivo no IoT Central. |
Extensão | GA |
az iot central device-template create
Crie um modelo de dispositivo no IoT Central.
az iot central device-template create --app-id
--content
--device-template-id
[--api-version {2022-06-30-preview, 2022-07-31}]
[--central-api-uri]
[--token]
Exemplos
Criar um modelo de dispositivo com carga útil lida de um arquivo
az iot central device-template create --app-id {appid} --content {pathtofile} --device-template-id {devicetemplateid}
Criar um modelo de dispositivo com carga útil lida de json bruto
az iot central device-template create --app-id {appid} --content {json} --device-template-id {devicetemplateid}
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.
A definição do modelo de dispositivo. Forneça caminho para o arquivo JSON ou JSON stringificado bruto. [Exemplo de caminho do arquivo: ./path/to/file.json] [Exemplo de JSON stringificado: {}]. O corpo da solicitação deve conter CapabilityModel.
Identificador de modelo de gêmeo digital do modelo de dispositivo. Saiba mais em https://aka.ms/iotcentraldtmi.
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.
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-template delete
Exclua um modelo de dispositivo do IoT Central.
Nota: espera-se que isso falhe se algum dispositivo ainda estiver associado a este modelo.
az iot central device-template delete --app-id
--device-template-id
[--api-version {2022-06-30-preview, 2022-07-31}]
[--central-api-uri]
[--token]
Exemplos
Excluir um modelo de dispositivo do IoT Central
az iot central device-template delete --app-id {appid} --device-template-id {devicetemplateid}
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.
A ID do modelo de dispositivo de destino. Exemplo: somedevicetemplate.
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.
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-template list
Obtenha a lista de modelos de dispositivo para um aplicativo do IoT Central.
az iot central device-template list --app-id
[--api-version {2022-06-30-preview, 2022-07-31}]
[--central-api-uri]
[--compact]
[--token]
Exemplos
Listar todos os modelos de dispositivo em um aplicativo, classificados por ID de modelo (padrão)
az iot central device-template list --app-id {appid}
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.
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.
Mostrar modelos no modo compacto. Para cada modelo serão exibidos apenas id, nome e tipos de modelo.
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-template show
Obtenha um modelo de dispositivo do IoT Central.
az iot central device-template show --app-id
--device-template-id
[--api-version {2022-06-30-preview, 2022-07-31}]
[--central-api-uri]
[--token]
Exemplos
Obter um modelo de dispositivo
az iot central device-template show --app-id {appid} --device-template-id {devicetemplateid}
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.
A ID do modelo de dispositivo de destino. Exemplo: somedevicetemplate.
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.
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-template update
Atualizar um modelo de dispositivo no IoT Central.
az iot central device-template update --app-id
--content
--device-template-id
[--api-version {2022-06-30-preview, 2022-07-31}]
[--central-api-uri]
[--token]
Exemplos
Atualizar um modelo de dispositivo com carga útil lida de um arquivo
az iot central device-template update --app-id {appid} --content {pathtofile} --device-template-id {devicetemplateid}
Atualizar um modelo de dispositivo com carga útil lida do json bruto
az iot central device-template update --app-id {appid} --content {json} --device-template-id {devicetemplateid}
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.
A definição do modelo de dispositivo. Forneça caminho para o arquivo JSON ou JSON stringificado bruto. [Exemplo de caminho do arquivo: ./path/to/file.json] [Exemplo de JSON stringificado: {}]. O corpo da solicitação deve conter CapabilityModel.
A ID do modelo de dispositivo de destino. Exemplo: somedevicetemplate.
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.
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.