Administración de recursos de Batch con la CLI de Azure
Puede administrar las cuentas y los recursos de Azure Batch mediante la interfaz de la línea de comandos de Azure (CLI de Azure). Hay comandos para crear y actualizar recursos de Batch, como grupos, trabajos y tareas. También puede crear scripts para muchas de las mismas tareas que se hacen a través de las API de Batch, los cmdlets de PowerShell y Azure Portal.
Puede ejecutar la CLI de Azure en Azure Cloud Shell o instalarla localmente. Las versiones están disponibles para Windows, Mac y sistemas operativos Linux (SO).
En este artículo se explica cómo usar las cuentas y los recursos de la CLI de Azure.
Configuración de la CLI de Azure
Elija cómo desea configurar la CLI de Azure:
- Ejecutar la CLI de Azure en Cloud Shell.
- Instalar la CLI de Azure de forma local.
- Instalar la CLI de Azure en Windows
- Instalar la CLI de Azure en macOS
- Instalar la CLI de Azure en Linux para varias distribuciones de Linux.
Si no está utilizando la CLI de Azure, consulte Introducción a la CLI de Azure antes de continuar.
Si previamente ha instalado el CLI de Azure localmente, asegúrese de actualizar la instalación a la versión más reciente.
Autenticación con la CLI de Azure
Para usar el CLI de Azure batch, primero inicie sesión en su cuenta de Azurey, a continuación, inicie sesión en su cuenta de Batch.
Inicie sesión en la cuenta de Azure
Para usar la CLI de Azure, primero inicie sesión en su cuenta de Azure. Este paso le da acceso a los comandos de Azure Resource Manager, lo que incluye el servicio de administración de Batch. A continuación, puede ejecutar comandos para administrar cuentas, claves, paquetes de aplicación y cuotas de Batch.
Puede autenticar la cuenta de Azure en la CLI de Azure) de dos maneras. Para ejecutar comandos por sí mismo, inicie sesión en la CLI de Azure de forma interactiva. La CLI de Azure almacena en caché sus credenciales y puede usar esas mismas credenciales para iniciar sesión en su cuenta de Batch después. Para ejecutar comandos desde un script o una aplicación, inicie sesión con una entidad de servicio cuando ejecute comandos de la CLI de Azure.
Para iniciar sesión en la CLI de Azure interactivamente, ejecute az login:
az login
Inicio de sesión en la cuenta de Batch
El siguiente paso es iniciar sesión en la cuenta de Batch de la CLI de Azure mediante el comando az batch account login. Este paso proporciona acceso a los comandos del servicio Batch. A continuación, puede administrar recursos de Batch como grupos, trabajos y tareas.
Puede autenticar la cuenta de Batch en la CLI de Azure de dos maneras. El método predeterminado consiste en autenticarse mediante Microsoft Entra ID. Se recomienda usar este método en la mayoría de los escenarios. Otra opción es usar la autenticación de clave compartida.
Si va a crear scripts de la CLI de Azure para automatizar comandos de Batch, puede usar cualquiera de los métodos de autenticación. En algunos escenarios, puede resultar más sencillo usar la autenticación de clave compartida que crear una entidad de servicio.
Autenticación con Microsoft Entra ID
El método predeterminado para autenticarse con su cuenta de Batch es a través Microsoft Entra ID. Al iniciar sesión en la CLI de Azure de forma interactiva o con una entidad de servicio, puede usar esas mismas credenciales almacenadas en caché para iniciar sesión en su cuenta de Batch con Microsoft Entra ID. Este método de autenticación también ofrece control de acceso basado en rol de Azure (RBAC de Azure). Con RBAC de Azure, el acceso de los usuarios depende de su rol asignado, no de las claves de cuenta. Solo necesita administrar los roles de Azure, no las claves de cuenta. Microsoft Entra ID, a continuación, controla el acceso y la autenticación.
Para iniciar sesión en su cuenta de Batch con Microsoft Entra ID, ejecute az batch login. Asegúrese de incluir los parámetros requeridos para el nombre de la cuenta de Batch (-n) y el nombre del grupo de recursos (-g).
az batch account login -g <your-resource-group> -n <your-batch-account>
Autenticación con clave compartida
También puede usar la autenticación de clave compartida para iniciar sesión en su cuenta de Batch. Este método usa las claves de acceso de su cuenta para autenticar comandos de la CLI de Azure para el servicio Batch.
Para iniciar sesión en su cuenta de Batch con la autenticación de clave compartida, ejecute az batch login con el parámetro --shared-key-auth. Asegúrese de incluir los parámetros requeridos para el nombre de la cuenta de Batch (-n) y el nombre del grupo de recursos (-g).
az batch account login -g <your-resource-group> -n <your-batch-account> --shared-key-auth
Más información sobre los comandos de Batch
En la documentación de referencia de la CLI de Azure se enumeran todos los comandos de la CLI de Azure para Batch.
Para enumerar todos los comandos de Batch en la CLI de Azure, ejecute az batch -h.
Hay varios scripts de la CLI de ejemplo para tareas comunes de Batch. En estos ejemplos se muestra cómo usar muchos comandos disponibles para Batch en la CLI de Azure. Puede aprender a crear y administrar cuentas, grupos, trabajos y tareas de Batch.
Uso de los comandos de la extensión de la CLI de Batch
Puede usar la extensión de la CLI de Batch para ejecutar trabajos de Batch sin escribir código. La extensión proporciona comandos para usar plantillas JSON para crear grupos, trabajos y tareas con la CLI de Azure. La extensión también proporciona comandos para conectarse a una cuenta Azure Storage vinculada a su cuenta de Batch. A continuación, puede cargar los archivos de entrada del trabajo y descargar los archivos de entrada del trabajo.
Creación de recursos con JSON
Puede crear la mayoría de los recursos de Batch solo con parámetros de línea de comandos. Algunas características requieren que especifique un archivo de configuración JSON en su lugar. El archivo JSON contiene los detalles de configuración del nuevo recurso. Por ejemplo, tiene que usar un archivo JSON para especificar los archivos de recursos de una tarea de inicio.
Por ejemplo, para usar un archivo JSON para configurar un nuevo recurso de grupo de Batch:
az batch pool <your-batch-pool-configuration>.json
Cuando especifique un archivo JSON para un nuevo recurso, no use otros parámetros en el comando. El servicio solo usa el archivo JSON para configurar el recurso.
En la documentación de referencia de API de REST de Batch se enumera cualquier sintaxis JSON requerida para crear un recurso.
Para ver la sintaxis JSON necesaria para crear un recurso, consulte la documentación de referencia de API REST de Batch. Vaya a la sección Ejemplos de la página de referencia de la operación de recursos. A continuación, busque la subsección titulada Agregar <tipo de recurso>. Por ejemplo, Agregar una tarea básica. Use el código JSON de ejemplo como plantillas para los archivos de configuración.
Para un script de ejemplo que especifica un archivo JSON, consulte Ejecutar un trabajo y tareas con Batch.
Consulta eficaz de recursos de Batch
Puede consultar la cuenta de Batch y enumerar todos los recursos mediante el comando list. Por ejemplo, para enumerar los grupos de su cuenta y las tareas de un trabajo:
az batch pool list
az batch task list --job-id <your-job-id>
Para limitar la cantidad de datos que devuelve la consulta de Batch, especifique una cláusula OData. Todo el filtrado se produce en el lado servidor, por lo que solo recibirá los datos que solicite. Use estas cláusulas de OData para ahorrar ancho de banda y tiempo con las operaciones list. Para más información, consulte Diseño de consultas de lista eficaces para recursos de Batch.
| Cláusula | Descripción |
|---|---|
--select-clause [select-clause] |
Devuelve un subconjunto de propiedades para cada entidad. |
--filter-clause [filter-clause] |
Devuelve solo las entidades que coincidan con la expresión OData especificada. |
--expand-clause [expand-clause] |
Obtiene la información de la entidad en una única llamada REST subyacente. Actualmente, la cláusula expand solo admite la propiedad stats. |
Para un script de ejemplo que muestra cómo usar estas cláusulas, consulte Ejecutar un trabajo y tareas con Batch.
Solución de problemas
Para obtener ayuda con cualquier comando de Batch, agregue -h al final del comando. No agregue otras opciones. Por ejemplo, para obtener ayuda para crear una cuenta de Batch, ejecute az batch account create -h.
Para devolver la salida del comando detallado, agregue -v o -vv al final del comando. Use estos modificadores para mostrar la salida de error completa. La marca -vv devuelve las solicitudes y respuestas REST reales.
Para ver la salida del comando en formato JSON, agregue --json al final del comando. Por ejemplo, para mostrar las propiedades de un grupo denominado pool001, ejecute az batch pool show pool001 --json. A continuación, copie y modifique la salida para crear recursos de Batch mediante un archivo de configuración JSON.
Solución de problemas a nivel general de la CLI de Azure
La CLI de Azure se puede ejecutar en varios entornos de shell, pero con ligeras variaciones de formato. Si tiene resultados inesperados con comandos de la CLI de Azure, consulte Uso correcto de la CLI de Azure.