Conjunto de comandos de la CLI de Azure Digital Twins

  • Artículo

Además de administrar la instancia de Azure Digital Twins en Azure Portal, Azure Digital Twins tiene un conjunto de comandos para la CLI de Azure que puede usar para hacer la mayoría de las acciones principales con el servicio. En este artículo se trata el conjunto de comandos de la CLI de Azure para Azure Digital Twins, incluidos sus usos, cómo obtenerlo y los requisitos para usarlo.

A continuación se enumeran algunas de las acciones que puede realizar con el conjunto de comandos:

  • Administración de una instancia de Azure Digital Twins
  • Administración de modelos
  • Administración de gemelos digitales
  • Administración de relaciones gemelas
  • Configuración de puntos de conexión
  • Administración de rutas
  • Configuración de la seguridad mediante el control de acceso basado en rol de Azure (RBAC de Azure)

El conjunto de comandos se denomina az dt y forma parte de la extensión de Azure IoT para la CLI de Azure. Puede ver la lista completa de comandos y su uso como parte de la documentación de referencia del conjunto de comandos az iot: referencia del comando az dt.

Usos (implementación y validación)

Además de administrar la instancia, generalmente, la CLI es también una herramienta útil para la implementación y la validación.

  • Los comandos de plano de control se pueden usar para hacer que la implementación de una nueva instancia sea repetible o automatizada.
  • Los comandos de plano de datos se pueden usar para comprobar rápidamente los valores de la instancia y que las operaciones se completaron según lo previsto.

Obtención del conjunto de comandos

Los comandos de Azure Digital Twins forman parte de la extensión de Azure IoT para la CLI de Azure (azure-iot), por lo que debe seguir estos pasos para asegurarse de que tiene la extensión azure-iot más reciente con los comandos az dt.

Requisitos de versión de la CLI

Si usa la CLI de Azure con PowerShell, la versión de la CLI de Azure debe ser la 2.3.1 o superior como un requisito del paquete de extensión.

Puede comprobar la versión de la CLI de Azure con este comando de la CLI:

az --version

Para obtener instrucciones sobre cómo instalar o actualizar la CLI de Azure a una versión más reciente, consulte Instalación de la CLI de Azure.

Obtener la extensión

La CLI de Azure le solicitará automáticamente que instale la extensión la primera vez que use algún comando que la necesite.

Si no, puede usar el siguiente comando para instalar la extensión usted mismo en cualquier momento (o actualizarla si tiene una versión anterior). El comando se puede ejecutar en Azure Cloud Shell o en una CLI de Azure local.

az extension add --upgrade --name azure-iot

Uso de caracteres especiales en distintos shells

Algunos comandos az dt usan caracteres especiales que puede que haya que escapar para garantizar un análisis adecuado en determinados entornos de shell. Use las sugerencias de esta sección para obtener ayuda sobre cuándo hacerlo en el shell que prefiera.

Bash

Use estas sugerencias de caracteres especiales para entornos de Bash.

Consultas

En muchas consultas de gemelos, el carácter $ se usa para hacer referencia a la propiedad $dtId de un gemelo. Al usar el comando az dt twin query para realizar consultas en el entorno de Bash de Cloud Shell, escape el carácter $ con una barra diagonal inversa (\).

A continuación, se muestra un ejemplo de consulta de un gemelo con un comando de la CLI en el entorno de Bash de Cloud Shell:

az dt twin query --dt-name <instance-hostname-or-name> --query-command "SELECT * FROM DigitalTwins T Where T.\$dtId = 'room0'"

PowerShell

Use estas sugerencias de caracteres especiales para entornos de PowerShell.

JSON insertado

Algunos comandos, como az dt twin create, permiten introducir información de gemelos en forma de JSON insertado. Al introducir un JSON insertado en el entorno de PowerShell, escape los caracteres de comillas dobles (") del JSON con una barra diagonal inversa (\).

A continuación, se muestra un ejemplo de creación de un gemelo con un comando de la CLI en PowerShell:

az dt twin create --dt-name <instance-hostname-or-name> --dtmi "dtmi:contosocom:DigitalTwins:Thermostat;1" --twin-id thermostat67 --properties '{\"Temperature\": 0.0}'

Sugerencia

Muchos de los comandos que admiten JSON insertados también admiten la entrada como una ruta de acceso de archivo, lo que puede ayudar a evitar requisitos de texto específicos del shell.

Consultas

En muchas consultas de gemelos, el carácter $ se usa para hacer referencia a la propiedad $dtId de un gemelo. Al usar el comando az dt twin query para realizar consultas en un entorno de PowerShell, escape el carácter $ con un carácter de acento grave.

A continuación, se muestra un ejemplo de consulta de un gemelo con un comando de la CLI en PowerShell:

az dt twin query --dt-name <instance-hostname-or-name> --query-command "SELECT * FROM DigitalTwins T Where T.`$dtId = 'room0'"

Línea de comandos de Windows

Use estas sugerencias de caracteres especiales para la consola local CMD de Windows.

JSON insertado

Algunos comandos, como az dt twin create, permiten introducir información de gemelos en forma de JSON insertado. Al introducir un JSON insertado en una ventana local de CMD de Windows, incluya el valor del parámetro entre comillas dobles (") en lugar de comillas simples (') y escape los caracteres de comillas dobles del JSON con una barra diagonal inversa (\).

A continuación, se muestra un ejemplo de creación de un gemelo con un comando de la CLI en la consola local CMD de Windows:

az dt twin create --dt-name <instance-hostname-or-name> --dtmi "dtmi:contosocom:DigitalTwins:Thermostat;1" --twin-id thermostat67 --properties "{\"Temperature\": 0.0}"

Sugerencia

Muchos de los comandos que admiten JSON insertados también admiten la entrada como una ruta de acceso de archivo, lo que puede ayudar a evitar requisitos de texto específicos del shell.

Pasos siguientes

Explore la CLI y su conjunto completo de comandos a través de los documentos de referencia: