az dt model

Referência

Nota

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 dt model . Saiba mais sobre extensões.

Gerencie modelos e definições DTDL em uma instância de Digital Twins.

Comandos

Name	Description	Tipo	Estado
az dt model create	Carrega um ou mais modelos.	Extensão	GA
az dt model delete	Exclua um modelo. Um modelo só pode ser excluído se nenhum outro modelo fizer referência a ele.	Extensão	GA
az dt model delete-all	Exclua todos os modelos em uma instância do Digital Twins.	Extensão	GA
az dt model list	Listar metadados, definições e dependências do modelo.	Extensão	GA
az dt model show	Recupere um modelo de destino ou uma definição de modelo.	Extensão	GA
az dt model update	Atualiza os metadados de um modelo. Atualmente, um modelo só pode ser descomissionado.	Extensão	GA

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
                   [--failure-policy {None, Rollback}]
                   [--fd]
                   [--max-models-per-batch]
                   [--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

--dt-name --dtn -n

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

--failure-policy --fp

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.

valores aceites: None, Rollback

valor predefinido: Rollback

--fd --from-directory

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.

--max-models-per-batch --mmpb

Experimental

O tamanho máximo do modelo por lote ao criar mais de 250 modelos. Reduza esse número para evitar um erro DTDLParser.

valor predefinido: 30

--models

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

--resource-group -g

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

--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceites: json, jsonc, none, table, tsv, yaml, yamlc

valor predefinido: json

--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

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
                   --dtmi
                   [--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

--dt-name --dtn -n

--dtmi --model-id -m

Digital Twins model Id. Exemplo: dtmi:com:example:Room;2.

Parâmetros Opcionais

--resource-group -g

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

--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceites: json, jsonc, none, table, tsv, yaml, yamlc

valor predefinido: json

--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

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
                       [--resource-group]
                       [--yes]

Exemplos

Exclua todos os modelos.

az dt model delete-all -n {instance_or_hostname}

Parâmetros Obrigatórios

--dt-name --dtn -n

Parâmetros Opcionais

--resource-group -g

Grupo de recursos de instância de gêmeos digitais. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--yes -y

Não solicite confirmação.

valor predefinido: False

Parâmetros de Globais

--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceites: json, jsonc, none, table, tsv, yaml, yamlc

valor predefinido: json

--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az dt model list

Listar metadados, definições e dependências do modelo.

az dt model list --dt-name
                 [--def {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

--dt-name --dtn -n

Parâmetros Opcionais

--def --definition

A operação recuperará a definição do modelo.

valores aceites: false, true

valor predefinido: False

--dependencies-for

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.

--resource-group -g

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

--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceites: json, jsonc, none, table, tsv, yaml, yamlc

valor predefinido: json

--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az dt model show

Recupere um modelo de destino ou uma definição de modelo.

az dt model show --dt-name
                 --dtmi
                 [--def {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

--dt-name --dtn -n

--dtmi --model-id -m

Digital Twins model Id. Exemplo: dtmi:com:example:Room;2.

Parâmetros Opcionais

--def --definition

A operação recuperará a definição do modelo.

valores aceites: false, true

valor predefinido: False

--resource-group -g

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

--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceites: json, jsonc, none, table, tsv, yaml, yamlc

valor predefinido: json

--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az dt model update

Atualiza os metadados de um modelo. Atualmente, um modelo só pode ser descomissionado.

az dt model update --dt-name
                   --dtmi
                   [--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

--dt-name --dtn -n

--dtmi --model-id -m

Digital Twins model Id. Exemplo: dtmi:com:example:Room;2.

Parâmetros Opcionais

--decommission

Indica a intenção de desativar um modelo de destino.

valores aceites: false, true

--resource-group -g

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

--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceites: json, jsonc, none, table, tsv, yaml, yamlc

valor predefinido: json

--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Partilhar via

az dt model

Comandos

az dt model create

Exemplos

Parâmetros Obrigatórios

Parâmetros Opcionais

az dt model delete

Exemplos

Parâmetros Obrigatórios

Parâmetros Opcionais

az dt model delete-all

Exemplos

Parâmetros Obrigatórios

Parâmetros Opcionais

az dt model list

Exemplos

Parâmetros Obrigatórios

Parâmetros Opcionais

az dt model show

Exemplos

Parâmetros Obrigatórios

Parâmetros Opcionais

az dt model update

Exemplos

Parâmetros Obrigatórios

Parâmetros Opcionais

Recursos adicionais