Administración de canalizaciones con la CLI de Azure DevOps
Azure DevOps Services | Azure DevOps Server 2022 | Azure DevOps Server 2020
En este artículo se describe cómo puede administrar las canalizaciones existentes en el proyecto de Azure DevOps mediante los siguientes comandos az pipelines :
- az pipelines list to list pipelines in a project
- az pipelines show para mostrar los detalles de una canalización
- az pipelines run para ejecutar una canalización
- az pipelines update para actualizar una canalización
- az pipelines delete para eliminar una canalización
Nota:
La extensión de la CLI de Azure DevOps solo está disponible para Azure DevOps Services y no admite ninguna versión de Azure DevOps Server.
Extensión de la CLI de Azure DevOps
El az-pipelines grupo de comandos forma parte de la extensión de DevOps a la CLI de Azure, que requiere la versión 2.30.0 o posterior de la CLI de Azure. La extensión de Azure DevOps se instala automáticamente la primera vez que ejecuta un azure pipelines comando. Para más información sobre cómo empezar, consulte Introducción a la CLI de Azure DevOps.
También puede usar parámetros globales de la CLI de Azure, como debug, help, queryonly-show-errors, , outputy verbose, en los comandos de la CLI de Azure DevOps. El table valor del --output parámetro global presenta la salida en un formato descriptivo. Para más información, consulte Formatos de salida de los comandos de la CLI de Azure.
Puede establecer la organización predeterminada de Azure DevOps para los comandos de la CLI de Azure DevOps mediante az devops configure --defaults organization=<YourOrganizationURL>o usar el --detect true parámetro para detectar automáticamente la organización. Puede configurar el proyecto de Azure DevOps predeterminado mediante az devops configure -d project=<Project Name or ID>.
Si no detecta la organización o configura un proyecto o organización predeterminado, o elige la organización y el proyecto a través git configde , debe especificar los org parámetros y project en cada comando.
Enumeración de canalizaciones existentes
Los runcomandos de canalización , show, updatey delete requieren o name id de la canalización que desea administrar. Si usa id, se omite el name parámetro . Para obtener una lista de canalizaciones de proyecto, incluidos sus identificadores, use el comando az pipelines list . Puede filtrar o dar formato a la lista de resultados mediante parámetros.
Por ejemplo, el siguiente comando muestra las canalizaciones de proyecto que tienen nombres que comienzan por python*, en formato de tabla.
az pipelines list --name python* --output table
Salida:
ID Path Name Status Default Queue
---- ------ -------------------------- -------- ---------------
17 \ python-sample-vscode-flask disabled Azure Pipelines
24 \ python-sample-get-started enabled Azure Pipelines
Para obtener la referencia de comandos completa, consulte az pipelines list.
Mostrar detalles de una canalización
Para ver los detalles de una canalización existente, use el comando az pipelines show . Por ejemplo, el siguiente comando muestra los detalles de la canalización con el ID de 12y abre la página de resumen de canalización en el explorador web.
az pipelines show --id 12 --open
Para obtener la referencia completa del comando, consulte az pipelines show.
Ejecutar una canalización
Para poner en cola y ejecutar una canalización existente, use el comando az pipelines run . Puede establecer parameters y variables usar en la ejecución.
Por ejemplo, el siguiente comando ejecuta la canalización con name de en la pipeline rama , establece el valor de variable 100 var1 en para la ejecución y genera resultados en table formato.myGithubname.pipelines-java
az pipelines run --name myGithubname.pipelines-java --branch pipeline --variables var1=100 --output table
Salida:
Run ID Number Status Result Pipeline ID Pipeline Name Source Branch Queued Time Reason
-------- ---------- ---------- -------- ------------- --------------------------- --------------- -------------------------- --------
123 20200123.2 notStarted 12 myGithubname.pipelines-java pipeline 2020-01-23 11:55:56.633450 manual
Para obtener la referencia de comandos completa, consulte az pipelines run.
Actualización de una canalización
Para actualizar una canalización existente, use el comando az pipelines update . Por ejemplo, el siguiente comando actualiza la canalización con el id de 12 con un nuevo nombre y una descripción, y genera el resultado en formato de tabla.
az pipelines update --id 12 --description "rename pipeline" --new-name updatedname.pipelines-java --output table
Salida:
ID Name Status Default Queue
---- -------------------------- -------- ------------------
12 updatedname.pipelines-java enabled Hosted Ubuntu 1604
Para obtener la referencia de comandos completa, consulte az pipelines update.
Eliminación de una canalización
Para eliminar una canalización, ejecute el comando az-pipelines-delete . Por ejemplo, el siguiente comando elimina la canalización con el identificador de 12y no solicita confirmación. Si no incluye el --yes parámetro , el sistema solicita confirmación de forma predeterminada.
az pipelines delete --id 12 --yes
Para obtener la referencia de comandos completa, consulte az pipelines delete.
Creación y configuración de canalizaciones mediante programación
Para usar la CLI de Azure DevOps para crear una canalización YAML, consulte az pipelines create. Para ejecutar comandos de la CLI de Azure en canalizaciones YAML, consulte CLI de Azure DevOps en YAML de Azure Pipelines.
Puede crear canalizaciones de YAML para compilar, configurar, probar e implementar aplicaciones en el lenguaje que prefiera. Vea los siguientes artículos para más información:
- Compilación, prueba e implementación de aplicaciones de .NET Core
- Compilar y probar proyectos de Go
- Compilación de aplicaciones Java
- Compilación y publicación de un paquete de Node.js
- Compilación y publicación de una aplicación de Python
- Creación de una imagen de contenedor para implementar aplicaciones
- Personalización de la canalización
Azure DevOps Services REST API
Puede crear aplicaciones o servicios personalizados que se integren con Azure DevOps mediante las API REST para realizar llamadas HTTP directas. Para más información, consulte la referencia de la API REST de Azure DevOps Services. También puede usar las bibliotecas cliente para estas API.
Omitir una fase en una ejecución de canalización
Puede usar el comando az rest con la API REST Ejecutar canalización para omitir una fase de una ejecución de canalización mediante el stagesToSkip parámetro .
Por ejemplo:
az rest --method post `
--uri https://dev.azure.com/{organization}/{project}/_apis/pipelines/{pipelineId}/runs?api-version=7.1-preview.1 `
--body "{'stagesToSkip': [''], 'resources': {'repositories': {'self': {'refName': 'refs/heads/{branch}'}}}}" `
--resource 499b84ac-1321-427f-aa17-267ca6975798
Para más información, consulte Uso de la API REST de Azure con la CLI de Azure.