az dt model
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 dt model. Saiba mais sobre extensões.
Gerencie modelos e definições DTDL em uma instância de Digital Twins.
Comandos
| Name | Description | Tipo | Status |
|---|---|---|---|
| az dt model create |
Carrega um ou mais modelos. |
Extension | disponibilidade geral |
| az dt model delete |
Exclua um modelo. Um modelo só pode ser excluído se nenhum outro modelo fizer referência a ele. |
Extension | disponibilidade geral |
| az dt model delete-all |
Exclua todos os modelos em uma instância do Digital Twins. |
Extension | disponibilidade geral |
| az dt model list |
Listar metadados, definições e dependências do modelo. |
Extension | disponibilidade geral |
| az dt model show |
Recupere um modelo de destino ou uma definição de modelo. |
Extension | disponibilidade geral |
| az dt model update |
Atualiza os metadados de um modelo. Atualmente, um modelo só pode ser descomissionado. |
Extension | disponibilidade geral |
az dt model create
Carrega um ou mais modelos.
--models podem ser JSON embutido ou caminho de arquivo. O tamanho do conjunto de modelos de entrada (ontologia) é limitado pelo número máximo de modelos que a instância DT pode armazenar (o padrão é 10000 modelos).
az dt model create --dt-name --dtn
[--failure-policy --fp {None, Rollback}]
[--fd --from-directory]
[--max-models-per-batch --mmpb]
[--models]
[--resource-group]
Exemplos
Carregue em massa todos os arquivos de modelo .json ou .dtdl de um diretório de destino. O processamento do modelo é recursivo.
az dt model create -n {instance_or_hostname} --from-directory {directory_path}
Carregue o modelo json em linha ou a partir do caminho do arquivo.
az dt model create -n {instance_or_hostname} --models {file_path_or_inline_json}
Parâmetros Obrigatórios
Nome da instância ou nome do host do Digital Twins. Se um nome de instância for fornecido, a assinatura do usuário será consultada primeiro para que a instância de destino recupere o nome do host. Se um nome de host for fornecido, a consulta de assinatura será ignorada e o valor fornecido será usado para interação subsequente.
Parâmetros Opcionais
Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.
Indica a política de falha quando ocorre um erro durante o processamento de um lote de modelos. No modo 'Reversão', todos os modelos criados em lotes anteriores são excluídos um de cada vez. Quando selecionados como 'Nenhum', os modelos criados em lotes anteriores não são excluídos da instância DT.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Models Input Arguments |
| Default value: | Rollback |
| Valores aceites: | None, Rollback |
Os arquivos de modelo JSON do diretório serão analisados. Observação: Os modelos são criados atomicamente quando o diretório contém 250 ou menos modelos, portanto, em caso de erro, nenhum dos modelos é criado. O conjunto de modelos de entrada é fragmentado & criado em lotes quando o diretório tem mais de 250 modelos (limite de API). No caso de um erro ao processar um lote, o comportamento é determinado pelo parâmetro --failure-policy.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Models Input Arguments |
O tamanho máximo do modelo por lote ao criar mais de 250 modelos. Reduza esse número para evitar um erro DTDLParser.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Models Input Arguments |
| Default value: | 30 |
JSON modelo embutido ou caminho de arquivo para o modelo JSON. Observação: Os modelos são criados atomicamente quando o modelo JSON contém 250 ou menos modelos, portanto, em caso de erro, nenhum dos modelos é criado. O conjunto de modelos de entrada é fragmentado & criado em lotes quando o JSON do modelo tem mais de 250 modelos (limite de API). No caso de um erro ao processar um lote, o comportamento é determinado pelo parâmetro --failure-policy.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Models Input Arguments |
Grupo de recursos de instância de gêmeos digitais. Você pode configurar o grupo padrão usando az configure --defaults group={name}.
Parâmetros de Globais
Aumente a verbosidade do log para mostrar todos os logs de depuração.
| Propriedade | Valor |
|---|---|
| Default value: | False |
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
| Propriedade | Valor |
|---|---|
| Default value: | False |
Formato de saída.
| Propriedade | Valor |
|---|---|
| Default value: | json |
| Valores aceites: | 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 subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.
Aumente a verbosidade do registro. Use --debug para logs de depuração completos.
| Propriedade | Valor |
|---|---|
| Default value: | False |
az dt model delete
Exclua um modelo. Um modelo só pode ser excluído se nenhum outro modelo fizer referência a ele.
az dt model delete --dt-name --dtn
--dtmi --model-id
[--resource-group]
Exemplos
Exclua um modelo de destino.
az dt model delete -n {instance_or_hostname} --dtmi "dtmi:com:example:Floor;1"
Parâmetros Obrigatórios
Nome da instância ou nome do host do Digital Twins. Se um nome de instância for fornecido, a assinatura do usuário será consultada primeiro para que a instância de destino recupere o nome do host. Se um nome de host for fornecido, a consulta de assinatura será ignorada e o valor fornecido será usado para interação subsequente.
Digital Twins model Id. Exemplo: dtmi:com:example:Room;2.
Parâmetros Opcionais
Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.
Grupo de recursos de instância de gêmeos digitais. Você pode configurar o grupo padrão usando az configure --defaults group={name}.
Parâmetros de Globais
Aumente a verbosidade do log para mostrar todos os logs de depuração.
| Propriedade | Valor |
|---|---|
| Default value: | False |
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
| Propriedade | Valor |
|---|---|
| Default value: | False |
Formato de saída.
| Propriedade | Valor |
|---|---|
| Default value: | json |
| Valores aceites: | 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 subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.
Aumente a verbosidade do registro. Use --debug para logs de depuração completos.
| Propriedade | Valor |
|---|---|
| Default value: | False |
az dt model delete-all
Exclua todos os modelos em uma instância do Digital Twins.
As configurações de gêmeos não são afetadas, mas podem ser quebradas sem definições de modelo.
az dt model delete-all --dt-name --dtn
[--resource-group]
[--yes]
Exemplos
Exclua todos os modelos.
az dt model delete-all -n {instance_or_hostname}
Parâmetros Obrigatórios
Nome da instância ou nome do host do Digital Twins. Se um nome de instância for fornecido, a assinatura do usuário será consultada primeiro para que a instância de destino recupere o nome do host. Se um nome de host for fornecido, a consulta de assinatura será ignorada e o valor fornecido será usado para interação subsequente.
Parâmetros Opcionais
Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.
Grupo de recursos de instância de gêmeos digitais. Você pode configurar o grupo padrão usando az configure --defaults group={name}.
Não solicite confirmação.
| Propriedade | Valor |
|---|---|
| Default value: | False |
Parâmetros de Globais
Aumente a verbosidade do log para mostrar todos os logs de depuração.
| Propriedade | Valor |
|---|---|
| Default value: | False |
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
| Propriedade | Valor |
|---|---|
| Default value: | False |
Formato de saída.
| Propriedade | Valor |
|---|---|
| Default value: | json |
| Valores aceites: | 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 subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.
Aumente a verbosidade do registro. Use --debug para logs de depuração completos.
| Propriedade | Valor |
|---|---|
| Default value: | False |
az dt model list
Listar metadados, definições e dependências do modelo.
az dt model list --dt-name --dtn
[--def --definition {false, true}]
[--dependencies-for]
[--resource-group]
Exemplos
Listar metadados do modelo
az dt model list -n {instance_or_hostname}
Listar definições de modelo
az dt model list -n {instance_or_hostname} --definition
Listar dependências de determinados modelos pré-existentes. Espaço separar valores dtmi.
az dt model list -n {instance_or_hostname} --dependencies-for {model_id0} {model_id1}
Parâmetros Obrigatórios
Nome da instância ou nome do host do Digital Twins. Se um nome de instância for fornecido, a assinatura do usuário será consultada primeiro para que a instância de destino recupere o nome do host. Se um nome de host for fornecido, a consulta de assinatura será ignorada e o valor fornecido será usado para interação subsequente.
Parâmetros Opcionais
Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.
A operação recuperará a definição do modelo.
| Propriedade | Valor |
|---|---|
| Default value: | False |
| Valores aceites: | false, true |
O conjunto de modelos que terão suas dependências recuperadas. Se omitido, todos os modelos são recuperados. Formato é uma lista separada por espaços em branco.
Grupo de recursos de instância de gêmeos digitais. Você pode configurar o grupo padrão usando az configure --defaults group={name}.
Parâmetros de Globais
Aumente a verbosidade do log para mostrar todos os logs de depuração.
| Propriedade | Valor |
|---|---|
| Default value: | False |
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
| Propriedade | Valor |
|---|---|
| Default value: | False |
Formato de saída.
| Propriedade | Valor |
|---|---|
| Default value: | json |
| Valores aceites: | 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 subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.
Aumente a verbosidade do registro. Use --debug para logs de depuração completos.
| Propriedade | Valor |
|---|---|
| Default value: | False |
az dt model show
Recupere um modelo de destino ou uma definição de modelo.
az dt model show --dt-name --dtn
--dtmi --model-id
[--def --definition {false, true}]
[--resource-group]
Exemplos
Mostrar metadados do modelo
az dt model show -n {instance_or_hostname} --dtmi "dtmi:com:example:Floor;1"
Mostrar metadados e definição do modelo
az dt model show -n {instance_or_hostname} --dtmi "dtmi:com:example:Floor;1" --definition
Parâmetros Obrigatórios
Nome da instância ou nome do host do Digital Twins. Se um nome de instância for fornecido, a assinatura do usuário será consultada primeiro para que a instância de destino recupere o nome do host. Se um nome de host for fornecido, a consulta de assinatura será ignorada e o valor fornecido será usado para interação subsequente.
Digital Twins model Id. Exemplo: dtmi:com:example:Room;2.
Parâmetros Opcionais
Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.
A operação recuperará a definição do modelo.
| Propriedade | Valor |
|---|---|
| Default value: | False |
| Valores aceites: | false, true |
Grupo de recursos de instância de gêmeos digitais. Você pode configurar o grupo padrão usando az configure --defaults group={name}.
Parâmetros de Globais
Aumente a verbosidade do log para mostrar todos os logs de depuração.
| Propriedade | Valor |
|---|---|
| Default value: | False |
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
| Propriedade | Valor |
|---|---|
| Default value: | False |
Formato de saída.
| Propriedade | Valor |
|---|---|
| Default value: | json |
| Valores aceites: | 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 subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.
Aumente a verbosidade do registro. Use --debug para logs de depuração completos.
| Propriedade | Valor |
|---|---|
| Default value: | False |
az dt model update
Atualiza os metadados de um modelo. Atualmente, um modelo só pode ser descomissionado.
az dt model update --dt-name --dtn
--dtmi --model-id
[--decommission {false, true}]
[--resource-group]
Exemplos
Decommision um modelo alvo
az dt model update -n {instance_or_hostname} --dtmi "dtmi:com:example:Floor;1" --decommission
Parâmetros Obrigatórios
Nome da instância ou nome do host do Digital Twins. Se um nome de instância for fornecido, a assinatura do usuário será consultada primeiro para que a instância de destino recupere o nome do host. Se um nome de host for fornecido, a consulta de assinatura será ignorada e o valor fornecido será usado para interação subsequente.
Digital Twins model Id. Exemplo: dtmi:com:example:Room;2.
Parâmetros Opcionais
Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.
Indica a intenção de desativar um modelo de destino.
| Propriedade | Valor |
|---|---|
| Valores aceites: | false, true |
Grupo de recursos de instância de gêmeos digitais. Você pode configurar o grupo padrão usando az configure --defaults group={name}.
Parâmetros de Globais
Aumente a verbosidade do log para mostrar todos os logs de depuração.
| Propriedade | Valor |
|---|---|
| Default value: | False |
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
| Propriedade | Valor |
|---|---|
| Default value: | False |
Formato de saída.
| Propriedade | Valor |
|---|---|
| Default value: | json |
| Valores aceites: | 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 subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.
Aumente a verbosidade do registro. Use --debug para logs de depuração completos.
| Propriedade | Valor |
|---|---|
| Default value: | False |