az dt model

Note

This reference is part of the azure-iot extension for the Azure CLI (version 2.59.0 or higher). A extensão instalará automaticamente na primeira vez que você executar um comando az dt model. Learn more about extensions.

Gerencie modelos e definições de DTDL em uma instância dos Gêmeos Digitais.

Comandos

Nome	Description	Tipo	Status
az dt model create	Carrega um ou mais modelos.	Extension	GA
az dt model delete	Excluir um modelo. Um modelo só poderá ser excluído se nenhum outro modelo fizer referência a ele.	Extension	GA
az dt model delete-all	Exclua todos os modelos em uma instância dos Gêmeos Digitais.	Extension	GA
az dt model list	Listar metadados, definições e dependências do modelo.	Extension	GA
az dt model show	Recupere um modelo de destino ou uma definição de modelo.	Extension	GA
az dt model update	Atualiza os metadados de um modelo. Atualmente, um modelo só pode ser descodisionado.	Extension	GA

az dt model create

Carrega um ou mais modelos.

--models pode ser json embutido ou caminho de arquivo. O tamanho do conjunto de modelos de entrada (ontologia) é restringido pelo número máximo de modelos que a instância de 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 de .json ou .dtdl de um diretório de destino. O processamento de modelo é recursivo.

az dt model create -n {instance_or_hostname} --from-directory {directory_path}

Carregue o json do modelo embutido ou do caminho do arquivo.

az dt model create -n {instance_or_hostname} --models {file_path_or_inline_json}

Parâmetros Exigidos

--dt-name --dtn -n

Nome da instância ou nome do host dos Gêmeos Digitais. Se um nome de instância for fornecido, a assinatura do usuário será consultada pela primeira vez 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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Propriedade	Valor
Parameter group:	Models Input Arguments
Valor padrão:	Rollback
Valores aceitos:	None, 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 modelos ou menos, portanto, em caso de erro, nenhum dos modelos é criado. O conjunto de modelos de entrada é agrupado & criados 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
Parameter group:	Models Input Arguments

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

Habilitação

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
Parameter group:	Models Input Arguments
Valor padrão:	30

--models

JSON de 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 modelos ou menos, portanto, em caso de erro, nenhum dos modelos é criado. O conjunto de modelos de entrada é agrupado & criados 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
Parameter group:	Models Input Arguments

--resource-group -g

Grupo de recursos da instância dos Gêmeos Digitais. Você pode configurar o grupo padrão usando az configure --defaults group={name}.

Parâmetros Globais

--debug

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

Propriedade	Valor
Valor padrão:	False

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Valor padrão:	False

--output -o

Output format.

Propriedade	Valor
Valor padrão:	json
Valores aceitos:	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 assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade	Valor
Valor padrão:	False

az dt model delete

Excluir um modelo. Um modelo só poderá 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 Exigidos

--dt-name --dtn -n

Nome da instância ou nome do host dos Gêmeos Digitais. Se um nome de instância for fornecido, a assinatura do usuário será consultada pela primeira vez 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.

--dtmi --model-id -m

ID do modelo dos Gêmeos Digitais. Exemplo: dtmi:com:example:Room;2.

Parâmetros Opcionais

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--resource-group -g

Grupo de recursos da instância dos Gêmeos Digitais. Você pode configurar o grupo padrão usando az configure --defaults group={name}.

Parâmetros Globais

--debug

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

Propriedade	Valor
Valor padrão:	False

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Valor padrão:	False

--output -o

Output format.

Propriedade	Valor
Valor padrão:	json
Valores aceitos:	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 assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade	Valor
Valor padrão:	False

az dt model delete-all

Exclua todos os modelos em uma instância dos Gêmeos Digitais.

As configurações dos gêmeos não são afetadas, mas podem ser interrompidas 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 Exigidos

--dt-name --dtn -n

Nome da instância ou nome do host dos Gêmeos Digitais. Se um nome de instância for fornecido, a assinatura do usuário será consultada pela primeira vez 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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--resource-group -g

Grupo de recursos da instância dos Gêmeos Digitais. Você pode configurar o grupo padrão usando az configure --defaults group={name}.

--yes -y

Não solicite confirmação.

Propriedade	Valor
Valor padrão:	False

Parâmetros Globais

--debug

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

Propriedade	Valor
Valor padrão:	False

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Valor padrão:	False

--output -o

Output format.

Propriedade	Valor
Valor padrão:	json
Valores aceitos:	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 assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade	Valor
Valor padrão:	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 modelos pré-existentes específicos. Valores de dtmi separados por espaço.

az dt model list -n {instance_or_hostname} --dependencies-for {model_id0} {model_id1}

Parâmetros Exigidos

--dt-name --dtn -n

Nome da instância ou nome do host dos Gêmeos Digitais. Se um nome de instância for fornecido, a assinatura do usuário será consultada pela primeira vez 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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--def --definition

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

Propriedade	Valor
Valor padrão:	False
Valores aceitos:	false, true

--dependencies-for

O conjunto de modelos que terão suas dependências recuperadas. Se omitido, todos os modelos serão recuperados. O formato é uma lista separada por espaço em branco.

--resource-group -g

Grupo de recursos da instância dos Gêmeos Digitais. Você pode configurar o grupo padrão usando az configure --defaults group={name}.

Parâmetros Globais

--debug

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

Propriedade	Valor
Valor padrão:	False

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Valor padrão:	False

--output -o

Output format.

Propriedade	Valor
Valor padrão:	json
Valores aceitos:	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 assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

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

--dt-name --dtn -n

Nome da instância ou nome do host dos Gêmeos Digitais. Se um nome de instância for fornecido, a assinatura do usuário será consultada pela primeira vez 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.

--dtmi --model-id -m

ID do modelo dos Gêmeos Digitais. Exemplo: dtmi:com:example:Room;2.

Parâmetros Opcionais

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--def --definition

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

Propriedade	Valor
Valor padrão:	False
Valores aceitos:	false, true

--resource-group -g

Grupo de recursos da instância dos Gêmeos Digitais. Você pode configurar o grupo padrão usando az configure --defaults group={name}.

Parâmetros Globais

--debug

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

Propriedade	Valor
Valor padrão:	False

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Valor padrão:	False

--output -o

Output format.

Propriedade	Valor
Valor padrão:	json
Valores aceitos:	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 assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade	Valor
Valor padrão:	False

az dt model update

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

az dt model update --dt-name --dtn
                   --dtmi --model-id
                   [--decommission {false, true}]
                   [--resource-group]

Exemplos

Descodificar um modelo de destino

az dt model update -n {instance_or_hostname} --dtmi "dtmi:com:example:Floor;1" --decommission

Parâmetros Exigidos

--dt-name --dtn -n

Nome da instância ou nome do host dos Gêmeos Digitais. Se um nome de instância for fornecido, a assinatura do usuário será consultada pela primeira vez 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.

--dtmi --model-id -m

ID do modelo dos Gêmeos Digitais. Exemplo: dtmi:com:example:Room;2.

Parâmetros Opcionais

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--decommission

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

Propriedade	Valor
Valores aceitos:	false, true

--resource-group -g

Grupo de recursos da instância dos Gêmeos Digitais. Você pode configurar o grupo padrão usando az configure --defaults group={name}.

Parâmetros Globais

--debug

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

Propriedade	Valor
Valor padrão:	False

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Valor padrão:	False

--output -o

Output format.

Propriedade	Valor
Valor padrão:	json
Valores aceitos:	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 assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade	Valor
Valor padrão:	False