az iot central device-template
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 na primeira vez que você executar um comando az iot central device-template. Saiba mais sobre extensões.
Gerencie e configure 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. |
Extension | GA |
| az iot central device-template delete |
Exclua um modelo de dispositivo do IoT Central. |
Extension | GA |
| az iot central device-template list |
Obtenha a lista de modelos de dispositivo para um aplicativo do IoT Central. |
Extension | GA |
| az iot central device-template show |
Obtenha um modelo de dispositivo do IoT Central. |
Extension | GA |
| az iot central device-template update |
Atualize um modelo de dispositivo no IoT Central. |
Extension | 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 --dtid
[--api-version --av {2022-06-30-preview, 2022-07-31}]
[--central-api-uri --central-dns-suffix]
[--token]
Exemplos
Criar um modelo de dispositivo com conteúdo lido de um arquivo
az iot central device-template create --app-id {appid} --content {pathtofile} --device-template-id {devicetemplateid}
Criar um modelo de dispositivo com conteúdo lido do 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 a ID do aplicativo na página "Sobre" para seu aplicativo no menu de ajuda.
A definição do modelo de dispositivo. 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 de JSON em cadeia de caracteres: {Modelo de dispositivo JSON}]. 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
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.
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 |
O sufixo DNS do IoT Central associado ao seu aplicativo.
| Propriedade | Valor |
|---|---|
| Valor padrão: | azureiotcentral.com |
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
Aumente a verbosidade de log para mostrar todos os logs de depuração.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Mostre esta mensagem de ajuda e saia.
Mostrar apenas erros, suprimindo avisos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Formato de saída.
| Propriedade | Valor |
|---|---|
| Valor padrão: | json |
| Valores aceitos: | json, jsonc, none, table, tsv, yaml, yamlc |
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 a verbosidade do registro em log. Use --debug para logs de depuração completos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
az iot central device-template delete
Exclua um modelo de dispositivo do IoT Central.
Observação: espera-se que isso falhe se algum dispositivo ainda estiver associado a esse modelo.
az iot central device-template delete --app-id
--device-template-id --dtid
[--api-version --av {2022-06-30-preview, 2022-07-31}]
[--central-api-uri --central-dns-suffix]
[--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 a ID do aplicativo na página "Sobre" para seu aplicativo no menu de ajuda.
A ID do modelo de dispositivo de destino. Exemplo: somedevicetemplate.
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.
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 |
O sufixo DNS do IoT Central associado ao seu aplicativo.
| Propriedade | Valor |
|---|---|
| Valor padrão: | azureiotcentral.com |
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
Aumente a verbosidade de log para mostrar todos os logs de depuração.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Mostre esta mensagem de ajuda e saia.
Mostrar apenas erros, suprimindo avisos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Formato de saída.
| Propriedade | Valor |
|---|---|
| Valor padrão: | json |
| Valores aceitos: | json, jsonc, none, table, tsv, yaml, yamlc |
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 a verbosidade do registro em log. Use --debug para logs de depuração completos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
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 --av {2022-06-30-preview, 2022-07-31}]
[--central-api-uri --central-dns-suffix]
[--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 a ID do aplicativo na página "Sobre" para seu aplicativo no menu de ajuda.
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.
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 |
O sufixo DNS do IoT Central associado ao seu aplicativo.
| Propriedade | Valor |
|---|---|
| Valor padrão: | azureiotcentral.com |
Mostrar modelos no modo compacto. Para cada modelo exibirá apenas id, nome e tipos de modelo.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
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
Aumente a verbosidade de log para mostrar todos os logs de depuração.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Mostre esta mensagem de ajuda e saia.
Mostrar apenas erros, suprimindo avisos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Formato de saída.
| Propriedade | Valor |
|---|---|
| Valor padrão: | json |
| Valores aceitos: | json, jsonc, none, table, tsv, yaml, yamlc |
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 a verbosidade do registro em log. Use --debug para logs de depuração completos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
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 --dtid
[--api-version --av {2022-06-30-preview, 2022-07-31}]
[--central-api-uri --central-dns-suffix]
[--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 a ID do aplicativo na página "Sobre" para seu aplicativo no menu de ajuda.
A ID do modelo de dispositivo de destino. Exemplo: somedevicetemplate.
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.
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 |
O sufixo DNS do IoT Central associado ao seu aplicativo.
| Propriedade | Valor |
|---|---|
| Valor padrão: | azureiotcentral.com |
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
Aumente a verbosidade de log para mostrar todos os logs de depuração.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Mostre esta mensagem de ajuda e saia.
Mostrar apenas erros, suprimindo avisos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Formato de saída.
| Propriedade | Valor |
|---|---|
| Valor padrão: | json |
| Valores aceitos: | json, jsonc, none, table, tsv, yaml, yamlc |
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 a verbosidade do registro em log. Use --debug para logs de depuração completos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
az iot central device-template update
Atualize um modelo de dispositivo no IoT Central.
az iot central device-template update --app-id
--content
--device-template-id --dtid
[--api-version --av {2022-06-30-preview, 2022-07-31}]
[--central-api-uri --central-dns-suffix]
[--token]
Exemplos
Atualizar um modelo de dispositivo com conteúdo lido de um arquivo
az iot central device-template update --app-id {appid} --content {pathtofile} --device-template-id {devicetemplateid}
Atualizar um modelo de dispositivo com conteúdo lido 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 a ID do aplicativo na página "Sobre" para seu aplicativo no menu de ajuda.
A definição do modelo de dispositivo. 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 de JSON em cadeia de caracteres: {Modelo de dispositivo JSON}]. O corpo da solicitação deve conter CapabilityModel.
A ID do modelo de dispositivo de destino. Exemplo: somedevicetemplate.
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.
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 |
O sufixo DNS do IoT Central associado ao seu aplicativo.
| Propriedade | Valor |
|---|---|
| Valor padrão: | azureiotcentral.com |
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
Aumente a verbosidade de log para mostrar todos os logs de depuração.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Mostre esta mensagem de ajuda e saia.
Mostrar apenas erros, suprimindo avisos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Formato de saída.
| Propriedade | Valor |
|---|---|
| Valor padrão: | json |
| Valores aceitos: | json, jsonc, none, table, tsv, yaml, yamlc |
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 a verbosidade do registro em log. Use --debug para logs de depuração completos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |