az dt twin relationship

Nota:

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

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

Comandos

Nombre	Description	Tipo	Estado
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	Actualiza las propiedades de una relación entre dos gemelos digitales mediante la especificación de revisión JSON.	Extensión	GA

az dt twin relationship create

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

--properties puede ser código JSON insertado o una ruta de acceso de archivo.

az dt twin relationship create --dt-name
                               --kind
                               --relationship-id
                               --source
                               --target
                               [--if-none-match]
                               [--properties]
                               [--resource-group]

Ejemplos

Cree una relación entre dos gemelos digitales.

az dt twin relationship create -n {instance_or_hostname} --relationship-id {relationship_id} --relationship contains --twin-id {source_twin_id} --target {target_twin_id}

Creación de una relación entre dos gemelos digitales con etiqueta if-none-match

az dt twin relationship create -n {instance_or_hostname} --relationship-id {relationship_id} --relationship contains --twin-id {source_twin_id} --target {target_twin_id} --if-none-match

Cree una relación con las propiedades inicializadas entre dos gemelos digitales.

az dt twin relationship create -n {instance_or_hostname} --relationship-id {relationship_id} --relationship contains --twin-id {source_twin_id} --target {target_twin_id} --properties '{"ownershipUser": "me", "ownershipDepartment": "Computer Science"}'

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.

--kind --relationship

Nombre o tipo de relación. Por ejemplo: "contains".

--relationship-id -r

Id. de relación.

--source --twin-id -t

Identificador del gemelo de origen de una relación.

--target --target-twin-id

Identificador de gemelo de destino para una relación.

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 una relación de gemelo digital. Proporcione la ruta de acceso del archivo o JSON insertado.

--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 relationship delete

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

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

Ejemplos

Elimina una relación de gemelo digital.

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

Elimine una relación de gemelo digital mediante etag.

az dt twin relationship delete -n {instance_or_hostname} --twin-id {twin_id} --relationship-id {relationship_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.

--relationship-id -r

Id. de relación.

--source --twin-id -t

Identificador del gemelo de origen de una relación.

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 relationship delete-all

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

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

Ejemplos

Elimine todas las relaciones de gemelo digital asociadas al gemelo.

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

Elimine todas las relaciones de gemelos digitales dentro de la instancia de Digital Twins.

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

--source --twin-id -t

Identificador del gemelo de origen de una relación.

--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 relationship list

Enumerar las relaciones de un gemelo digital.

az dt twin relationship list --dt-name
                             --source
                             [--incoming {false, true}]
                             [--kind]
                             [--resource-group]

Ejemplos

Enumerar las relaciones salientes de un gemelo digital.

az dt twin relationship list -n {instance_or_hostname} --twin-id {twin_id}

Enumerar las relaciones salientes de un gemelo digital y filtrar por la relación "contains"

az dt twin relationship list -n {instance_or_hostname} --twin-id {twin_id} --relationship contains

Enumerar las relaciones entrantes de un gemelo digital.

az dt twin relationship list -n {instance_or_hostname} --twin-id {twin_id} --incoming

Enumere las relaciones entrantes de un gemelo digital y filtre por la relación "contains".

az dt twin relationship list -n {instance_or_hostname} --twin-id {twin_id} --relationship contains --incoming

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.

--source --twin-id -t

Identificador del gemelo de origen de una relación.

Parámetros opcionales

--incoming

Recupera todas las relaciones entrantes de un gemelo digital.

valores aceptados: false, true

valor predeterminado: False

--kind --relationship

Filtre el resultado por el tipo de relación.

--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 relationship show

Mostrar detalles de una relación de gemelo digital.

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

Ejemplos

Mostrar detalles de una relación de gemelo digital.

az dt twin relationship show -n {instance_or_hostname} --twin-id {twin_id} --relationship-id {relationship_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.

--relationship-id -r

Id. de relación.

--source --twin-id -t

Identificador del gemelo de origen de una relación.

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 relationship update

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

Las operaciones se limitan a agregar, reemplazar y quitar.

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

Ejemplos

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

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

Actualice una relación de gemelo digital mediante la especificación de revisiones JSON y use etag.

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

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

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

Actualice una relación de gemelo digital mediante la especificación de revisión JSON definida en un archivo.

az dt twin relationship update -n {instance_or_hostname} --twin-id {twin_id} --relationship-id {relationship_id} --relationship contains --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. Las actualizaciones de 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.

--relationship-id -r

Id. de relación.

--source --twin-id -t

Identificador del gemelo de origen de una relación.

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.