Administración de la canalización con la CLI de Azure

  • Artículo

Azure DevOps Services | Azure DevOps Server 2022 | Azure DevOps Server 2020

Puede administrar las canalizaciones de su organización mediante estos comandos az pipelines:

Estos comandos requieren el nombre o el identificador de la canalización que desea administrar. Puede obtener el identificador de una canalización mediante el comando az pipelines list.

Para empezar, consulte Introducción a la CLI de Azure DevOps.

Ejecución de una canalización

Puede poner en cola (ejecutar) una canalización existente con el comando az pipelines run.

az pipelines run [--branch]
                 [--commit-id]
                 [--folder-path]
                 [--id]
                 [--name]
                 [--open]
                 [--org]
                 [--project]
                 [--variables]

Parámetros

  • branch: nombre de la rama en la que se va a poner en cola la ejecución de la canalización, por ejemplo, refs/heads/main.
  • commit-id: commit-id en el que se va a poner en cola la ejecución de la canalización.
  • folder-path: ruta de acceso de carpeta de la canalización. El valor predeterminado es la carpeta de nivel raíz.
  • id: es necesario si no se proporciona name. Identificador de la canalización que se va a poner en cola.
  • name: obligatorio si no se proporciona el identificador, pero se omite si se proporciona el identificador. Nombre de la canalización que se va a poner en cola.
  • open: abra la página de resultados de la canalización en el explorador web.
  • org: la URL de la organización de Azure DevOps. Puede configurar la organización predeterminada mediante az devops configure -d organization=ORG_URL. Es obligatorio si no está configurado como predeterminado o seleccionado mediante git config. Ejemplo: --org https://dev.azure.com/MyOrganizationName/.
  • project: el nombre o identificador del proyecto. El proyecto predeterminado se puede configurar mediante az devops configure -d project=NAME_OR_ID. Es obligatorio si no está configurado como predeterminado o seleccionado mediante git config.
  • variables: pares separados por espacios "name=value" para las variables que desea establecer.

Ejemplo

El siguiente comando ejecuta la canalización denominada myGithubname.pipelines-java en la canalización de rama y muestra el resultado en formato de tabla.

az pipelines run --name myGithubname.pipelines-java --branch pipeline --output table

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

Actualización de una canalización

Puede actualizar una canalización existente con el comando az pipelines update. Para empezar, consulte Introducción a la CLI de Azure DevOps.

az pipelines update [--branch]
                    [--description]
                    [--id]
                    [--name]
                    [--new-folder-path]
                    [--new-name]
                    [--org]
                    [--project]
                    [--queue-id]
                    [--yaml-path]

Parámetros

  • branch: nombre de la rama en la que se va a configurar la ejecución de la canalización, por ejemplo, refs/heads/main.
  • description: nueva descripción de la canalización.
  • id: es necesario si no se proporciona name. Identificador de la canalización que se va a actualizar.
  • name: se requiere si no se proporciona el identificador. Nombre de la canalización que se va a actualizar.
  • new-folder-path: nueva ruta de acceso completa de la carpeta a la que se mueve la canalización, por ejemplo, user1/production_pipelines.
  • new-name: nuevo nombre actualizado de la canalización.
  • org: la URL de la organización de Azure DevOps. Puede configurar la organización predeterminada mediante az devops configure -d organization=ORG_URL. Es obligatorio si no está configurado como predeterminado o seleccionado mediante git config. Ejemplo: --org https://dev.azure.com/MyOrganizationName/.
  • project: el nombre o identificador del proyecto. El proyecto predeterminado se puede configurar mediante az devops configure -d project=NAME_OR_ID. Es obligatorio si no está configurado como predeterminado o seleccionado mediante git config.
  • queue-id: identificador de cola del grupo de agentes donde debe ejecutarse la canalización.
  • yaml-path: ruta de acceso del archivo yaml de la canalización en el repositorio.

Los parámetros globales incluyen debug, help, only-show-errors, query, output y verbose.

Sugerencia

También hay parámetros globales que puede usar, como --output. El parámetro --output está disponible para todos los comandos. El valor table presenta la salida en un formato descriptivo. Para más información, consulte Formatos de salida de los comandos de la CLI de Azure.

Ejemplo

El siguiente comando actualiza la canalización con el identificador de 12 con un nombre y una descripción nuevos y muestra el resultado en formato de tabla.

az pipelines update --id 12 --description "rename pipeline" --new-name updatedname.pipelines-java --output table

ID    Name                        Status    Default Queue
----  --------------------------  --------  ------------------
12    updatedname.pipelines-java  enabled   Hosted Ubuntu 1604

Mostrar canalización

Puede ver los detalles de una canalización existente con el comando az pipelines show. Para empezar, consulte Introducción a la CLI de Azure DevOps.

az pipelines show [--folder-path]
                  [--id]
                  [--name]
                  [--open]
                  [--org]
                  [--project]
                  [--query-examples]
                  [--subscription]

Parámetros

  • folder-path: ruta de acceso de carpeta de la canalización. El valor predeterminado es la carpeta de nivel raíz.
  • id: es necesario si no se proporciona name. Identificador de la canalización para mostrar los detalles.
  • name: obligatorio si no se proporciona el nombre, pero se omite si se proporciona el identificador. Nombre de la canalización para mostrar los detalles.
  • open: abra la página de resumen de la canalización en el explorador web.
  • org: la URL de la organización de Azure DevOps. Puede configurar la organización predeterminada mediante az devops configure -d organization=ORG_URL. Es obligatorio si no está configurado como predeterminado o seleccionado mediante git config. Ejemplo: --org https://dev.azure.com/MyOrganizationName/.
  • project: el nombre o identificador del proyecto. El proyecto predeterminado se puede configurar mediante az devops configure -d project=NAME_OR_ID. Es obligatorio si no está configurado como predeterminado o seleccionado mediante git config.
  • query examples: se recomienda una cadena JMESPath.
  • subscription: nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

Ejemplo

El comando siguiente muestra los detalles de la canalización con el identificador de 12 y devuelve el resultado en formato de tabla.

az pipelines show --id 12 --output table

ID    Name                        Status    Default Queue
----  --------------------------  --------  ------------------
12    updatedname.pipelines-java  enabled   Hosted Ubuntu 1604

Pasos siguientes

Puede personalizar la canalización o obtener más información sobre la configuración de canalizaciones en el lenguaje que prefiera:

Preguntas más frecuentes

Cómo crear mediante programación una canalización de compilación?

Referencia de la API REST: creación de una canalización de compilación

Nota

También puede administrar compilaciones y canalizaciones de compilación desde la línea de comandos o scripts mediante la CLI de Azure Pipelines.

¿Puedo ejecutar varias canalizaciones en Azure DevOps Services mediante un solo comando?

Actualmente, la CLI de Azure y las API de Azure no ofrecen comandos que ejecutan varias canalizaciones desde la línea de comandos. Puede usar comandos de la CLI de Azure para enumerar todas las canalizaciones y definiciones y proporcionar un único identificador de versión o compilación como parámetro. Todos los comandos están diseñados para funcionar para ejecuciones independientes de canalizaciones independientes y requieren solicitudes de identificador únicas que solo permiten un valor único. Para más información sobre los desencadenadores de canalización, consulte Especificación de eventos que desencadenan canalizaciones.