Información general sobre la CLI de Azure Sphere

La CLI de Azure Sphere es un conjunto de comandos que se usan para administrar los recursos de Azure Sphere.

Están disponibles los siguientes comandos:

CLI de Azure Sphere y CLI clásica de Azure Sphere

La CLI de Azure Sphere se instala junto con la CLI existente en Windows y Linux, por lo que tiene acceso a cualquiera de las interfaces. La CLI clásica de Azure Sphere sigue funcionando como siempre.

Para usar la CLI de Azure Sphere:

  • En Windows, use PowerShell o un símbolo del sistema de Windows estándar.
  • En Linux, use cualquier shell de comandos. Especifique el comando azsphere si establece la CLI de Azure Sphere como predeterminada durante la instalación del SDK o el comando azsphere_v2 si establece la CLI clásica de Azure Sphere como predeterminada.

Consulte la CLI de Azure Sphere para obtener más información sobre las características y los comandos compatibles con la CLI de Azure Sphere.

Importante

  • En Windows, el método abreviado de símbolo del sistema para desarrolladores de Azure Sphere Classic que se retira solo puede usarse con la CLI clásica de Azure Sphere.

Formato de la línea de comandos

La línea de comandos azsphere tiene el siguiente formato:

azsphere [command] [subcommand] operation [parameters]

En general, comando y subcomando son nombres y la operación es un verbo, de modo que la combinación identifica una acción y el objeto de la acción. La mayoría de los comandos y operaciones tienen un nombre completo y una abreviatura. Por ejemplo, el comando device está abreviado d.

La mayoría de los parámetros tienen un nombre largo y una abreviatura. En la línea de comandos, introduzca el nombre largo con dos guiones y la abreviatura con un solo guión. Por ejemplo, los dos comandos siguientes son equivalentes:

azsphere device wifi add --ssid MyNetwork --psk mynetworkkey
azsphere device wifi add -s MyNetwork -p mynetworkkey

Algunos comandos permiten varios valores para un único parámetro. En la CLI de Azure Sphere puede proporcionar un parámetro único seguido de una lista de valores separados por espacios y, en la CLI clásica de Azure Sphere, la lista de valores se separa con comas. Por ejemplo:

azsphere image-package pack-application --package-directory myDirectory --destination myImagePackage --executables filepath-1 filepath-2

Comillas y caracteres de escape

Cuando trabaje con los comandos de la CLI de Azure Sphere, tenga en cuenta cómo el shell usa comillas y caracteres de escape. Si admite scripts usados en diferentes shells, debe comprender en qué se diferencian.

Por ejemplo:

Comandos dependientes de la nube

Los siguientes comandos de azsphere requieren una conexión en la nube e inicio de sesión en el Servicio de Seguridad de Azure Sphere:

  • ca-certificate
  • grupo de dispositivos
  • get-support-data
  • Imagen
  • Iniciar sesión
  • Cerrar sesión
  • Producto
  • register-user
  • Papel
  • mostrar usuario
  • Inquilino

Además, los siguientes comandos de dispositivo azsphere también requieren una conexión en la nube:

comando azsphere device Comentarios
Capacidad Requiere el Servicio de Seguridad de Azure Sphere para la descarga de funcionalidad del dispositivo
Reclamación
enable-cloud-test
habilitar-desarrollo
Imagen
Lista
Recuperar Requiere conectividad a Internet, pero no inicia sesión en azure sphere security service
Mostrar
show-count
show-deployment-status
show-os-version Requiere conectividad a Internet, pero no inicia sesión en azure sphere security service
actualizar

Comandos que dependen de la capacidad del dispositivo

Los siguientes comandos de dispositivo azsphere requieren que se use una funcionalidad de dispositivo para dispositivos con estado de fabricación , DeviceComplete:

Operación Descripción
Aplicación Administrar aplicaciones en el dispositivo conectado.
Capacidad Administrar configuraciones de capacidad de dispositivo. Necesario para la actualización de la funcionalidad.
Certificado Administrar el almacén de certificados de dispositivo.
Imagen Administrar las imágenes del dispositivo.
estado de fabricación Administrar el estado de fabricación de los dispositivos conectados. Necesario para la actualización del estado de fabricación.
Reiniciar Reinicia el dispositivo conectado.
show-deployment-status Mostrar el estado de implementación del sistema operativo y las aplicaciones en el dispositivo conectado.
show-os-version Mostrar la versión del sistema operativo en el dispositivo conectado.
realizar instalaciones de prueba Implementa y administra aplicaciones en el dispositivo adjunto. Necesario para la implementación de instalación de prueba y la eliminación de instalaciones de prueba.
Wifi Administrar las configuraciones de Wi-Fi para el dispositivo conectado.

Si intenta ejecutar estos comandos sin una funcionalidad, recibe un mensaje de error que le indica que ejecute azsphere device enable-development o use azsphere device capability para descargar y seleccionar un archivo de funcionalidad para el dispositivo.