az dt twin

  • Referencia

Nota:

Esta referencia forma parte de la extensión azure-iot para la CLI de Azure (versión 2.37.0 o posterior). La extensión instalará automáticamente la primera vez que ejecute un comando az dt twin . Obtenga más información sobre las extensiones.

Administre y configure los gemelos digitales de una instancia de Digital Twins.

Comandos

Nombre Description Tipo Estado
az dt twin component

Mostrar y actualizar los componentes del gemelo digital de una instancia de Digital Twins.

 Extensión GA
az dt twin component show

Mostrar detalles de un componente de gemelo digital.

 Extensión GA
az dt twin component update

Actualice un componente de gemelo digital mediante la especificación de revisión JSON.

 Extensión GA
az dt twin create

Cree un gemelo digital en una instancia de .

 Extensión GA
az dt twin delete

Quite un gemelo digital. Todas las relaciones que hacen referencia a este gemelo ya deben eliminarse.

 Extensión GA
az dt twin delete-all

Elimina todos los gemelos digitales dentro de una instancia de Digital Twins, incluidas todas las relaciones de esos gemelos.

 Extensión GA
az dt twin query

Consulte los gemelos digitales de una instancia. Permite atravesar relaciones y filtrar por valores de propiedad.

 Extensión GA
az dt twin relationship

Administre y configure las relaciones de gemelos digitales de una instancia de Digital Twins.

 Extensión GA
az dt twin relationship create

Cree una relación entre gemelos digitales de origen y destino.

 Extensión GA
az dt twin relationship delete

Elimine una relación de gemelo digital en una instancia de Digital Twins.

 Extensión GA
az dt twin relationship delete-all

Elimina todas las relaciones de gemelos digitales dentro de una instancia de Digital Twins, incluidas las relaciones entrantes.

 Extensión GA
az dt twin relationship list

Enumerar las relaciones de un gemelo digital.

 Extensión GA
az dt twin relationship show

Mostrar detalles de una relación de gemelo digital.

 Extensión GA
az dt twin relationship update

Novedades las propiedades de una relación entre dos gemelos digitales mediante la especificación de revisión JSON.

 Extensión GA
az dt twin show

Muestra los detalles de un gemelo digital.

 Extensión GA
az dt twin telemetry

Pruebe y valide las rutas de eventos y los puntos de conexión de una instancia de Digital Twins.

 Extensión GA
az dt twin telemetry send

Envía telemetría en nombre de un gemelo digital. Si se proporciona la ruta de acceso del componente, la telemetría emitida está en nombre del componente.

 Extensión GA
az dt twin update

Actualice un gemelo digital de instancia mediante la especificación de revisión JSON.

 Extensión GA

az dt twin create

Cree un gemelo digital en una instancia de .

--properties puede ser código JSON insertado o una ruta de acceso de archivo. Nota: --properties son necesarias para los gemelos que contienen componentes.

az dt twin create --dt-name
                  --dtmi
                  --twin-id
                  [--if-none-match]
                  [--properties]
                  [--resource-group]

Ejemplos

Cree un gemelo digital a partir de un modelo existente (creado previamente).

az dt twin create -n {instance_or_hostname} --dtmi "dtmi:com:example:Room;1" --twin-id {twin_id}

Cree un gemelo digital a partir de un modelo existente (creado previamente) con la etiqueta if-none-match.

az dt twin create -n {instance_or_hostname} --dtmi "dtmi:com:example:Room;1" --twin-id {twin_id} --if-none-match

Cree un gemelo digital a partir de un modelo existente (creado previamente). Cree una instancia con valores de propiedad.

az dt twin create -n {instance_or_hostname} --dtmi "dtmi:com:example:DeviceInformation;1" --twin-id {twin_id} --properties '{"manufacturer": "Microsoft"}'

Cree un gemelo digital con componentes a partir de modelos existentes (creados previamente). Cree una instancia del componente con propiedades mínimas.

az dt twin create -n {instance_or_hostname} --dtmi "dtmi:com:example:TemperatureController;1" --twin-id {twin_id} --properties '{
    "Thermostat": {
        "$metadata": {},
    }
}'

Cree un gemelo digital con componentes a partir de modelos existentes (creados previamente). Cree una instancia con valores de propiedad.

az dt twin create -n {instance_or_hostname} --dtmi "dtmi:com:example:TemperatureController;1" --twin-id {twin_id} --properties '{
    "Temperature": 10.2,
    "Thermostat": {
        "$metadata": {},
        "setPointTemp": 23.12
    }
}'

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.

--twin-id -t

Identificador del gemelo digital.

Parámetros opcionales

--if-none-match

Indica que se debe producir un error en la operación de creación si existe un gemelo existente con el mismo identificador.

valor predeterminado: False
--properties -p

Valores de propiedad iniciales para crear instancias de un gemelo digital o componentes relacionados. Proporcione la ruta de acceso del archivo o JSON insertado. Las propiedades son necesarias para los gemelos que contienen componentes, como mínimo, debe proporcionar un objeto $metadata vacío para cada componente.

--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 de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--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 de registro. Use --debug para obtener registros de depuración completos.

az dt twin delete

Quite un gemelo digital. Todas las relaciones que hacen referencia a este gemelo ya deben eliminarse.

az dt twin delete --dt-name
                  --twin-id
                  [--etag]
                  [--resource-group]

Ejemplos

Quite un gemelo digital por id.

az dt twin delete -n {instance_or_hostname} --twin-id {twin_id}

Quite un gemelo digital mediante id. mediante etag.

az dt twin delete -n {instance_or_hostname} --twin-id {twin_id} --etag {etag}

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.

--twin-id -t

Identificador del gemelo digital.

Parámetros opcionales

--etag -e

Valor de etiqueta de entidad. El comando se realizará correctamente si la etag coincide con la etag actual del recurso.

--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 de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--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 de registro. Use --debug para obtener registros de depuración completos.

az dt twin delete-all

Elimina todos los gemelos digitales dentro de una instancia de Digital Twins, incluidas todas las relaciones de esos gemelos.

az dt twin delete-all --dt-name
                      [--resource-group]
                      [--yes]

Ejemplos

Elimine todos los gemelos digitales. También se eliminarán las relaciones que hagan referencia a los gemelos.

az dt twin 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

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

valor predeterminado: False
Parámetros globales
--debug

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

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--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 de registro. Use --debug para obtener registros de depuración completos.

az dt twin query

Consulte los gemelos digitales de una instancia. Permite atravesar relaciones y filtrar por valores de propiedad.

En muchas consultas de gemelos, el carácter $ se usa para hacer referencia a la propiedad $dtId de un gemelo. En shells similares a Bash o powershell, el $ carácter tiene significado funcional y debe ser de escape como parte de la entrada de consulta. Consulte el documento https://docs.microsoft.com/en-us/azure/digital-twins/concepts-cli conceptos de la CLI de Digital Twins para más información.

az dt twin query --dt-name
                 --query-command
                 [--cost {false, true}]
                 [--resource-group]

Ejemplos

Consulte todos los gemelos digitales en la instancia de destino y proyecte todos los atributos. También se muestra el costo en las unidades de consulta.

az dt twin query -n {instance_or_hostname} -q "select * from digitaltwins" --show-cost

Consulte por modelo y proyecte todos los atributos.

az dt twin query -n {instance_or_hostname} -q "select * from digitaltwins T where IS_OF_MODEL(T, 'dtmi:com:example:Room;2')"

Consulta que aprovecha "$dtId" con sintaxis compatible con Bash

az dt twin query -n {instance_or_hostname} --query-command "SELECT * FROM DigitalTwins T Where T.\$dtId = 'room0'"

Consulta que aprovecha "$dtId" con sintaxis compatible con PowerShell

az dt twin query -n {instance_or_hostname} --query-command "SELECT * FROM DigitalTwins T Where T.`$dtId = 'room0'"

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.

--query-command -q

Consulta de usuario que se va a ejecutar.

Parámetros opcionales

--cost --show-cost

Calcula y muestra el cargo de consulta.

valores aceptados: false, true
valor predeterminado: False
--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 de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--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 de registro. Use --debug para obtener registros de depuración completos.

az dt twin show

Muestra los detalles de un gemelo digital.

az dt twin show --dt-name
                --twin-id
                [--resource-group]

Ejemplos

Muestra los detalles de un gemelo digital.

az dt twin show -n {instance_or_hostname} --twin-id {twin_id}

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.

--twin-id -t

Identificador del gemelo digital.

Parámetros opcionales

--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 de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--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 de registro. Use --debug para obtener registros de depuración completos.

az dt twin update

Actualice un gemelo digital de instancia mediante la especificación de revisión JSON.

Novedades los valores de propiedad y los elementos $model pueden producirse en la misma solicitud. Las operaciones se limitan a agregar, reemplazar y quitar.

az dt twin update --dt-name
                  --json-patch
                  --twin-id
                  [--etag]
                  [--resource-group]

Ejemplos

Actualice un gemelo digital mediante la especificación de revisión JSON.

az dt twin update -n {instance_or_hostname} --twin-id {twin_id} --json-patch '{"op":"replace", "path":"/Temperature", "value": 20.5}'

Actualice un gemelo digital a través de la especificación de revisión JSON y use etag.

az dt twin update -n {instance_or_hostname} --twin-id {twin_id} --etag {etag} --json-patch '{"op":"replace", "path":"/Temperature", "value": 20.5}'

Actualice un gemelo digital mediante la especificación de revisión JSON.

az dt twin update -n {instance_or_hostname} --twin-id {twin_id} --json-patch '[
  {"op":"replace", "path":"/Temperature", "value": 20.5},
  {"op":"add", "path":"/Areas", "value": ["ControlSystem"]}
]'

Actualice un gemelo digital a través de la especificación de revisión JSON definida en un archivo.

az dt twin update -n {instance_or_hostname} --twin-id {twin_id} --json-patch ./my/patch/document.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.

--json-patch --patch

Especificación de actualización descrita por JSON-patch. Novedades los valores de propiedad y los elementos $model pueden producirse en la misma solicitud. Las operaciones se limitan a agregar, reemplazar y quitar. Proporcione la ruta de acceso del archivo o JSON insertado.

--twin-id -t

Identificador del gemelo digital.

Parámetros opcionales

--etag -e

Valor de etiqueta de entidad. El comando se realizará correctamente si la etag coincide con la etag actual del recurso.

--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 de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--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 de registro. Use --debug para obtener registros de depuración completos.