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 será instalada 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	Descrição	Tipo	Estado
az iot central device-template create	Crie um modelo de dispositivo no IoT Central.	Extension	disponibilidade geral
az iot central device-template delete	Exclua um modelo de dispositivo do IoT Central.	Extension	disponibilidade geral
az iot central device-template list	Obtenha a lista de modelos de dispositivo para um aplicativo do IoT Central.	Extension	disponibilidade geral
az iot central device-template show	Obtenha um modelo de dispositivo do IoT Central.	Extension	disponibilidade geral
az iot central device-template update	Atualize um modelo de dispositivo no IoT Central.	Extension	disponibilidade geral

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 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 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.

--content -k

A definição do modelo de dispositivo. Forneça caminho para o arquivo JSON ou JSON stringified bruto. [Exemplo de caminho do arquivo: ./path/to/file.json] [Exemplo de JSON stringified: {Device Template JSON}]. O corpo da solicitação deve conter CapabilityModel.

--device-template-id --dtid

Digital Twin Model Identifier do modelo de dispositivo. Saiba mais em https://aka.ms/iotcentraldtmi.

Parâmetros Opcionais

Os parâmetros seguintes são opcionais, mas dependendo do contexto, podem ser necessários um ou mais para que o comando seja executado com sucesso.

--api-version --av

Descontinuado

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
Valor padrão:	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
Valor padrão:	azureiotcentral.com

--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 globais

--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

Propriedade	Valor
Valor padrão:	False

--help -h

Mostrar esta mensagem de ajuda e sair.

--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 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
Valor padrão:	False

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 --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 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.

--device-template-id --dtid

A ID do modelo de dispositivo de destino. Exemplo: somedevicetemplate.

Parâmetros Opcionais

Os parâmetros seguintes são opcionais, mas dependendo do contexto, podem ser necessários um ou mais para que o comando seja executado com sucesso.

--api-version --av

Descontinuado

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

Propriedade	Valor
Valor padrão:	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
Valor padrão:	azureiotcentral.com

--token

Parâmetros globais

--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

Propriedade	Valor
Valor padrão:	False

--help -h

Mostrar esta mensagem de ajuda e sair.

--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 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
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 do modelo (padrão)

az iot central device-template list --app-id {appid}

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.

Parâmetros Opcionais

Os parâmetros seguintes são opcionais, mas dependendo do contexto, podem ser necessários um ou mais para que o comando seja executado com sucesso.

--api-version --av

Descontinuado

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

Propriedade	Valor
Valor padrão:	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
Valor padrão:	azureiotcentral.com

--compact -c

Mostrar modelos no modo compacto. Para cada modelo será exibido apenas id, nome e tipos de modelo.

Propriedade	Valor
Valor padrão:	False

--token

Parâmetros globais

--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

Propriedade	Valor
Valor padrão:	False

--help -h

Mostrar esta mensagem de ajuda e sair.

--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 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
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 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.

--device-template-id --dtid

A ID do modelo de dispositivo de destino. Exemplo: somedevicetemplate.

Parâmetros Opcionais

Os parâmetros seguintes são opcionais, mas dependendo do contexto, podem ser necessários um ou mais para que o comando seja executado com sucesso.

--api-version --av

Descontinuado

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

Propriedade	Valor
Valor padrão:	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
Valor padrão:	azureiotcentral.com

--token

Parâmetros globais

--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

Propriedade	Valor
Valor padrão:	False

--help -h

Mostrar esta mensagem de ajuda e sair.

--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 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
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 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 de json bruto

az iot central device-template update --app-id {appid} --content {json} --device-template-id {devicetemplateid}

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.

--content -k

--device-template-id --dtid

A ID do modelo de dispositivo de destino. Exemplo: somedevicetemplate.

Parâmetros Opcionais

Os parâmetros seguintes são opcionais, mas dependendo do contexto, podem ser necessários um ou mais para que o comando seja executado com sucesso.

--api-version --av

Descontinuado

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

Propriedade	Valor
Valor padrão:	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
Valor padrão:	azureiotcentral.com

--token

Parâmetros globais

--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

Propriedade	Valor
Valor padrão:	False

--help -h

Mostrar esta mensagem de ajuda e sair.

--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 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
Valor padrão:	False

Feedback

Esta página foi útil?

Partilhar via

az iot central device-template

Comandos

az iot central device-template create

Exemplos

Parâmetros Obrigatórios

Parâmetros Opcionais

az iot central device-template delete

Exemplos

Parâmetros Obrigatórios

Parâmetros Opcionais

az iot central device-template list

Exemplos

Parâmetros Obrigatórios

Parâmetros Opcionais

az iot central device-template show

Exemplos

Parâmetros Obrigatórios

Parâmetros Opcionais

az iot central device-template update

Exemplos

Parâmetros Obrigatórios

Parâmetros Opcionais

Feedback