az dt model

Note

This reference is part of the azure-iot extension for the Azure CLI (version 2.59.0 or higher). La extensión instalará automáticamente la primera vez que ejecute un comando az dt model. Learn more about extensions.

Administre modelos y definiciones de DTDL en una instancia de Digital Twins.

Comandos

Nombre	Description	Tipo	Estado
az dt model create	Carga uno o varios modelos.	Extension	GA
az dt model delete	Eliminar un modelo. Un modelo solo se puede eliminar si ningún otro modelo hace referencia a él.	Extension	GA
az dt model delete-all	Elimine todos los modelos de una instancia de Digital Twins.	Extension	GA
az dt model list	Enumerar metadatos, definiciones y dependencias del modelo.	Extension	GA
az dt model show	Recupere un modelo de destino o una definición de modelo.	Extension	GA
az dt model update	Actualiza los metadatos de un modelo. Actualmente solo se puede descommisionar un modelo.	Extension	GA

az dt model create

Carga uno o varios modelos.

--models puede ser json insertado o ruta de acceso de archivo. El tamaño del conjunto de modelos de entrada (ontología) está restringido por el número máximo de modelos que la instancia de DT puede almacenar (el valor predeterminado es 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]

Ejemplos

Cargue en bloque todos los archivos de modelo .json o .dtdl desde un directorio de destino. El procesamiento de modelos es recursivo.

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

Cargue el json del modelo insertado o desde la ruta de acceso del archivo.

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

Parámetros requeridos

--dt-name --dtn -n

Nombre de instancia o nombre de host de Digital Twins. Si se proporciona un nombre de instancia, primero se consulta la suscripción de usuario para que la instancia de destino recupere el nombre de host. Si se proporciona un nombre de host, se omite la consulta de suscripción y el valor proporcionado se usa para la interacción posterior.

Parámetros opcionales

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 la directiva de error cuando se produce un error al procesar un lote de modelos. En el modo "Reversión", todos los modelos creados en lotes anteriores se eliminan de uno en uno. Cuando se selecciona como "Ninguno", los modelos creados en lotes anteriores no se eliminan de la instancia de DT.

Propiedad	Valor
Parameter group:	Models Input Arguments
Valor predeterminado:	Rollback
Valores aceptados:	None, Rollback

--fd --from-directory

Los archivos de modelo JSON del directorio se analizarán desde. Nota: Los modelos se crean de forma atómica cuando el directorio contiene 250 o menos modelos, por lo que, en caso de error, no se crea ninguno de los modelos. El conjunto de modelos de entrada se fragmenta & crea en lotes cuando el directorio tiene más de 250 modelos (límite de API). En el caso de un error que procesa un lote, el comportamiento viene determinado por el parámetro --failure-policy.

Propiedad	Valor
Parameter group:	Models Input Arguments

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

Habilitación de características

Tamaño máximo del modelo por lote al crear más de 250 modelos. Reduzca este número para evitar un error DTDLParser.

Propiedad	Valor
Parameter group:	Models Input Arguments
Valor predeterminado:	30

--models

Json de modelo insertado o ruta de acceso de archivo al json del modelo. Nota: Los modelos se crean de forma atómica cuando el json del modelo contiene 250 o menos modelos, por lo que, en caso de error, ninguno de los modelos se crea. El conjunto de modelos de entrada se fragmenta & crea en lotes cuando json del modelo tiene más de 250 modelos (límite de API). En el caso de un error que procesa un lote, el comportamiento viene determinado por el parámetro --failure-policy.

Propiedad	Valor
Parameter group:	Models Input Arguments

--resource-group -g

Grupo de recursos de instancia de Digital Twins. Puede configurar el grupo predeterminado mediante az configure --defaults group={name}.

Parámetros globales

--debug

Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.

Propiedad	Valor
Valor predeterminado:	False

--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad	Valor
Valor predeterminado:	False

--output -o

Output format.

Propiedad	Valor
Valor predeterminado:	json
Valores aceptados:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--subscription

Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.

Propiedad	Valor
Valor predeterminado:	False

az dt model delete

Eliminar un modelo. Un modelo solo se puede eliminar si ningún otro modelo hace referencia a él.

az dt model delete --dt-name --dtn
                   --dtmi --model-id
                   [--resource-group]

Ejemplos

Elimine un modelo de destino.

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

Parámetros requeridos

--dt-name --dtn -n

Nombre de instancia o nombre de host de Digital Twins. Si se proporciona un nombre de instancia, primero se consulta la suscripción de usuario para que la instancia de destino recupere el nombre de host. Si se proporciona un nombre de host, se omite la consulta de suscripción y el valor proporcionado se usa para la interacción posterior.

--dtmi --model-id -m

Id. de modelo de Digital Twins. Ejemplo: dtmi:com:example:Room;2.

Parámetros opcionales

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 de instancia de Digital Twins. Puede configurar el grupo predeterminado mediante az configure --defaults group={name}.

Parámetros globales

--debug

Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.

Propiedad	Valor
Valor predeterminado:	False

--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad	Valor
Valor predeterminado:	False

--output -o

Output format.

Propiedad	Valor
Valor predeterminado:	json
Valores aceptados:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--subscription

Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.

Propiedad	Valor
Valor predeterminado:	False

az dt model delete-all

Elimine todos los modelos de una instancia de Digital Twins.

Las configuraciones de gemelos no se ven afectadas, pero pueden interrumpirse sin definiciones de modelo.

az dt model delete-all --dt-name --dtn
                       [--resource-group]
                       [--yes]

Ejemplos

Elimine todos los modelos.

az dt model delete-all -n {instance_or_hostname}

Parámetros requeridos

--dt-name --dtn -n

Nombre de instancia o nombre de host de Digital Twins. Si se proporciona un nombre de instancia, primero se consulta la suscripción de usuario para que la instancia de destino recupere el nombre de host. Si se proporciona un nombre de host, se omite la consulta de suscripción y el valor proporcionado se usa para la interacción posterior.

Parámetros opcionales

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 de instancia de Digital Twins. Puede configurar el grupo predeterminado mediante az configure --defaults group={name}.

--yes -y

No solicita confirmación.

Propiedad	Valor
Valor predeterminado:	False

Parámetros globales

--debug

Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.

Propiedad	Valor
Valor predeterminado:	False

--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad	Valor
Valor predeterminado:	False

--output -o

Output format.

Propiedad	Valor
Valor predeterminado:	json
Valores aceptados:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--subscription

Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.

Propiedad	Valor
Valor predeterminado:	False

az dt model list

Enumerar metadatos, definiciones y dependencias del modelo.

az dt model list --dt-name --dtn
                 [--def --definition {false, true}]
                 [--dependencies-for]
                 [--resource-group]

Ejemplos

Enumerar metadatos del modelo

az dt model list -n {instance_or_hostname}

Enumerar definiciones de modelo

az dt model list -n {instance_or_hostname} --definition

Enumerar las dependencias de determinados modelos preexistentes. Espaciar valores dtmi independientes.

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

Parámetros requeridos

--dt-name --dtn -n

Nombre de instancia o nombre de host de Digital Twins. Si se proporciona un nombre de instancia, primero se consulta la suscripción de usuario para que la instancia de destino recupere el nombre de host. Si se proporciona un nombre de host, se omite la consulta de suscripción y el valor proporcionado se usa para la interacción posterior.

Parámetros opcionales

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

--def --definition

La operación recuperará la definición del modelo.

Propiedad	Valor
Valor predeterminado:	False
Valores aceptados:	false, true

--dependencies-for

Conjunto de modelos que tendrán sus dependencias recuperadas. Si se omite, se recuperan todos los modelos. El formato es una lista separada por espacios en blanco.

--resource-group -g

Grupo de recursos de instancia de Digital Twins. Puede configurar el grupo predeterminado mediante az configure --defaults group={name}.

Parámetros globales

--debug

Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.

Propiedad	Valor
Valor predeterminado:	False

--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad	Valor
Valor predeterminado:	False

--output -o

Output format.

Propiedad	Valor
Valor predeterminado:	json
Valores aceptados:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--subscription

Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.

Propiedad	Valor
Valor predeterminado:	False

az dt model show

Recupere un modelo de destino o una definición de modelo.

az dt model show --dt-name --dtn
                 --dtmi --model-id
                 [--def --definition {false, true}]
                 [--resource-group]

Ejemplos

Mostrar metadatos del modelo

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

Mostrar metadatos y definiciones del modelo

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

Parámetros requeridos

--dt-name --dtn -n

Nombre de instancia o nombre de host de Digital Twins. Si se proporciona un nombre de instancia, primero se consulta la suscripción de usuario para que la instancia de destino recupere el nombre de host. Si se proporciona un nombre de host, se omite la consulta de suscripción y el valor proporcionado se usa para la interacción posterior.

--dtmi --model-id -m

Id. de modelo de Digital Twins. Ejemplo: dtmi:com:example:Room;2.

Parámetros opcionales

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

--def --definition

La operación recuperará la definición del modelo.

Propiedad	Valor
Valor predeterminado:	False
Valores aceptados:	false, true

--resource-group -g

Grupo de recursos de instancia de Digital Twins. Puede configurar el grupo predeterminado mediante az configure --defaults group={name}.

Parámetros globales

--debug

Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.

Propiedad	Valor
Valor predeterminado:	False

--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad	Valor
Valor predeterminado:	False

--output -o

Output format.

Propiedad	Valor
Valor predeterminado:	json
Valores aceptados:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--subscription

Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.

Propiedad	Valor
Valor predeterminado:	False

az dt model update

Actualiza los metadatos de un modelo. Actualmente solo se puede descommisionar un modelo.

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

Ejemplos

Descommisionar un modelo de destino

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

Parámetros requeridos

--dt-name --dtn -n

Nombre de instancia o nombre de host de Digital Twins. Si se proporciona un nombre de instancia, primero se consulta la suscripción de usuario para que la instancia de destino recupere el nombre de host. Si se proporciona un nombre de host, se omite la consulta de suscripción y el valor proporcionado se usa para la interacción posterior.

--dtmi --model-id -m

Id. de modelo de Digital Twins. Ejemplo: dtmi:com:example:Room;2.

Parámetros opcionales

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

--decommission

Indica la intención de retirar un modelo de destino.

Propiedad	Valor
Valores aceptados:	false, true

--resource-group -g

Grupo de recursos de instancia de Digital Twins. Puede configurar el grupo predeterminado mediante az configure --defaults group={name}.

Parámetros globales

--debug

Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.

Propiedad	Valor
Valor predeterminado:	False

--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad	Valor
Valor predeterminado:	False

--output -o

Output format.

Propiedad	Valor
Valor predeterminado:	json
Valores aceptados:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--subscription

Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.

Propiedad	Valor
Valor predeterminado:	False