Gerenciar seu pipeline com a CLI do Azure

  • Artigo

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

Você pode gerenciar os pipelines em sua organização usando estes comandos az pipelines:

Esses comandos exigem o nome ou a ID do pipeline que você deseja gerenciar. Você pode obter a ID de um pipeline usando o comando az pipelines list.

Para começar, confira Introdução à CLI do Azure DevOps.

Executar um pipeline

Você pode enfileirar (executar) um pipeline existente com o comando az pipelines run.

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

Parâmetros

  • branch: nome do branch no qual a execução do pipeline deve ser enfileirada, por exemplo, refs/heads/main.
  • commit-id: Commit-id no qual a execução do pipeline deve ser enfileirada.
  • folder-path: caminho da pasta do pipeline. O padrão é a pasta de nível raiz.
  • id: obrigatório se name não for fornecido. ID do pipeline para fila.
  • name: obrigatório se a ID não for fornecida, mas ignorada se a ID for fornecida. Nome do pipeline a ser enfileirado.
  • open: abra a página de resultados do pipeline no navegador da Web.
  • org: a URL da organização do Azure DevOps. Você pode configurar a organização padrão usando az devops configure -d organization=ORG_URL. Obrigatório se não estiver configurado como padrão ou selecionado usando git config. Exemplo: --org https://dev.azure.com/MyOrganizationName/.
  • project: nome ou ID do projeto. Você pode configurar o projeto padrão usando az devops configure -d project=NAME_OR_ID. Obrigatório se não estiver configurado como padrão ou selecionado por meio de git config.
  • variable: pares "name=value" separados por espaço para as variáveis que você gostaria de definir.

Exemplo

O comando a seguir executa o pipeline chamado myGithubname.pipelines-java no branch pipeline e mostra o resultado no formato de tabela.

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

Atualizar um pipeline

Você pode atualizar um pipeline existente com o comando az pipelines update. Para começar, confira Introdução à CLI do Azure DevOps.

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

Parâmetros

  • branch: nome do branch no qual a execução do pipeline deve ser configurada, por exemplo, refs/heads/main.
  • description: nova descrição para o pipeline.
  • id: obrigatório se name não for fornecido. ID do pipeline a ser atualizado.
  • name: obrigatório se a ID não for fornecida. Nome do pipeline a ser atualizado.
  • new-folder-path: novo caminho completo da pasta para a qual o pipeline é movido, por exemplo, user1/production_pipelines.
  • new-name: novo nome atualizado do pipeline.
  • org: a URL da organização do Azure DevOps. Você pode configurar a organização padrão usando az devops configure -d organization=ORG_URL. Obrigatório se não estiver configurado como padrão ou selecionado usando git config. Exemplo: --org https://dev.azure.com/MyOrganizationName/.
  • project: nome ou ID do projeto. Você pode configurar o projeto padrão usando az devops configure -d project=NAME_OR_ID. Obrigatório se não estiver configurado como padrão ou selecionado por meio de git config.
  • queue-id: ID da fila do pool de agentes em que o pipeline precisa ser executado.
  • yaml-path: caminho do arquivo yaml do pipeline no repositório.

Os parâmetros globais incluem debug, help, only-show-errors, query, output e verbose.

Dica

Também há parâmetros globais que você pode usar, como --output. O parâmetro --output está disponível para todos os comandos. O valor table apresenta a saída em um formato amigável. Para obter mais informações, confira Formatos de saída para comandos da CLI do Azure.

Exemplo

O comando a seguir atualiza o pipeline com a ID de 12 com um novo nome e descrição e mostra o resultado no formato de tabela.

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 pipeline

Você pode exibir os detalhes de um pipeline existente com o comando az pipelines show. Para começar, confira Introdução à CLI do Azure DevOps.

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

Parâmetros

  • folder-path: caminho da pasta do pipeline. O padrão é a pasta de nível raiz.
  • id: obrigatório se name não for fornecido. ID do pipeline para mostrar detalhes.
  • name: obrigatório se o nome não for fornecido, mas ignorado se a ID for fornecida. Nome do pipeline para mostrar detalhes.
  • open: abra a página de resumo do pipeline no navegador da Web.
  • org: a URL da organização do Azure DevOps. Você pode configurar a organização padrão usando az devops configure -d organization=ORG_URL. Obrigatório se não estiver configurado como padrão ou selecionado usando git config. Exemplo: --org https://dev.azure.com/MyOrganizationName/.
  • project: nome ou ID do projeto. Você pode configurar o projeto padrão usando az devops configure -d project=NAME_OR_ID. Obrigatório se não estiver configurado como padrão ou selecionado por meio de git config.
  • query examples: recomenda uma cadeia de caracteres JMESPath para você.
  • subscription: nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

Exemplo

O comando a seguir mostra os detalhes do pipeline com a ID de 12 e retorna o resultado no formato de tabela.

az pipelines show --id 12 --output table

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

Próximas etapas

Você pode personalizar seu pipeline ou saber mais sobre como configurar pipelines no idioma de sua escolha:

Perguntas frequentes

Como fazer para criar programaticamente um pipeline de build?

Referência da API REST: criar um pipeline de build

Observação

Você também pode gerenciar builds e pipelines de build na linha de comando ou scripts usando a CLI do Azure Pipelines.

Posso executar vários pipelines em Azure DevOps Services usando um único comando?

Atualmente, a CLI do Azure e as APIs do Azure não oferecem comandos que executam vários pipelines da linha de comando. Você pode usar comandos da CLI do Azure para listar todos os pipelines e definições e fornecer uma única versão ou ID de build como um parâmetro. Todos os comandos foram projetados para funcionar para execuções independentes de pipelines independentes e exigem solicitações de ID exclusivas que permitem apenas um valor exclusivo. Para saber mais sobre gatilhos de pipeline, confira Especificar eventos que disparam pipelines.