Gerir o pipeline com a CLI do Azure

  • Artigo

Serviços do Azure DevOps | Azure DevOps Server 2022 | Azure DevOps Server 2020

Pode gerir os pipelines na sua organização com estes az pipelines comandos:

Estes comandos requerem o nome ou o ID do pipeline que pretende gerir. Pode obter o ID de um pipeline com o comando az pipelines list .

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

Executar um pipeline

Pode colocar em fila (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

  • ramo: o nome do ramo no qual a execução do pipeline deve ser colocado em fila, por exemplo, refs/heads/main.
  • commit-id: Commit-id no qual a execução do pipeline deve ser colocada em fila.
  • caminho da pasta: caminho da pasta do pipeline. A predefinição é a pasta de nível de raiz.
  • id: necessário se o nome não for fornecido. ID do pipeline para fila.
  • nome: necessário se o ID não for fornecido, mas ignorado se for fornecido o ID . Nome do pipeline para fila.
  • abrir: abra a página de resultados do pipeline no browser.
  • org: URL da organização do Azure DevOps. Pode configurar a organização predefinida com az devops configure -d organization=ORG_URL. Necessário se não estiver configurado como predefinido ou recolhido com git config. Exemplo: --org https://dev.azure.com/MyOrganizationName/.
  • project: Nome ou ID do projeto. Pode configurar o projeto predefinido com az devops configure -d project=NAME_OR_ID. Necessário se não estiver configurado como predefinido ou recolhido com git config.
  • variáveis: pares "name=value" separados por espaço para as variáveis que pretende definir.

Exemplo

O comando seguinte executa o pipeline com o nome myGithubname.pipelines-java no pipeline de ramo 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

Pode atualizar um pipeline existente com o comando az pipelines update . Para começar, veja 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

  • ramo: o nome do ramo no qual a execução do pipeline deve ser configurada, por exemplo, refs/heads/main.
  • descrição: nova descrição para o pipeline.
  • id: necessário se o nome não for fornecido. ID do pipeline a atualizar.
  • name: Necessário se o ID não for fornecido. Nome do pipeline a atualizar.
  • new-folder-path: novo caminho completo da pasta para a qual o pipeline é movido, por exemplo, utilizador1/production_pipelines.
  • new-name: novo nome atualizado do pipeline.
  • org: URL da organização do Azure DevOps. Pode configurar a organização predefinida com az devops configure -d organization=ORG_URL. Necessário se não estiver configurado como predefinido ou recolhido com git config. Exemplo: --org https://dev.azure.com/MyOrganizationName/.
  • project: Nome ou ID do projeto. Pode configurar o projeto predefinido com az devops configure -d project=NAME_OR_ID. Necessário se não estiver configurado como predefinido ou recolhido com git config.
  • queue-id: ID da fila do conjunto de agentes onde o pipeline tem de ser executado.
  • yaml-path: caminho do ficheiro yaml do pipeline no repositório.

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

Dica

Também existem parâmetros globais que pode utilizar, como --output. O --output parâmetro está disponível para todos os comandos. O valor da tabela apresenta o resultado num formato amigável. Para obter mais informações, veja Formatos de saída para comandos da CLI do Azure.

Exemplo

O comando seguinte atualiza o pipeline com o 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

Pode ver os detalhes de um pipeline existente com o comando az pipelines show . Para começar, veja Introdução à CLI do Azure DevOps.

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

Parâmetros

  • caminho da pasta: caminho da pasta do pipeline. A predefinição é a pasta de nível de raiz.
  • id: necessário se o nome não for fornecido. ID do pipeline para mostrar detalhes.
  • nome: obrigatório se o nome não for fornecido, mas ignorado se for fornecido o ID . Nome do pipeline para mostrar os detalhes.
  • abrir: abra a página de resumo do pipeline no browser.
  • org: URL da organização do Azure DevOps. Pode configurar a organização predefinida com az devops configure -d organization=ORG_URL. Necessário se não estiver configurado como predefinido ou recolhido com git config. Exemplo: --org https://dev.azure.com/MyOrganizationName/.
  • project: Nome ou ID do projeto. Pode configurar o projeto predefinido com az devops configure -d project=NAME_OR_ID. Necessário se não estiver configurado como predefinido ou recolhido com git config.
  • exemplos de consulta: recomende uma cadeia JMESPath para si.
  • subscrição: nome ou ID da subscrição. Pode configurar a subscrição predefinida com az account set -s NAME_OR_ID.

Exemplo

O comando seguinte mostra os detalhes do pipeline com o ID de 12 e devolve 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

Passos seguintes

Pode personalizar o pipeline ou saber mais sobre a configuração de pipelines no idioma à sua escolha:

FAQ

Como devo proceder para criar programaticamente um pipeline de compilação?

Referência da API REST: Criar um pipeline de compilação

Nota

Também pode gerir compilações e criar pipelines a partir da linha de comandos ou scripts com a CLI dos Pipelines do Azure.

Posso executar vários pipelines nos Serviços de DevOps do Azure com um único comando?

Atualmente, a CLI do Azure e as APIs do Azure não oferecem comandos que executam vários pipelines a partir da linha de comandos. Pode utilizar comandos da CLI do Azure para listar todos os pipelines e definições e fornecer um único ID de versão ou compilação como um parâmetro. Todos os comandos foram concebidos para funcionar para execuções independentes de pipelines independentes e necessitam de pedidos de ID exclusivos que permitam apenas um valor exclusivo. Para saber mais sobre os acionadores de pipeline, veja Especificar eventos que acionam pipelines.