Partilhar via

Gerenciar pipelines com a CLI do Azure DevOps

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

Este artigo descreve como você pode gerenciar pipelines existentes em seu projeto do Azure DevOps usando os seguintes comandos az pipelines :

Nota

A extensão da CLI do Azure DevOps está disponível apenas para os Serviços de DevOps do Azure e não suporta nenhuma versão do Azure DevOps Server.

Azure DevOps CLI extension (Extensão da CLI do Azure DevOps)

O az-pipelines grupo de comandos faz parte da extensão DevOps para a CLI do Azure, que requer a CLI do Azure versão 2.30.0 ou superior. A extensão do Azure DevOps é instalada automaticamente na primeira vez que você executa um azure pipelines comando. Para obter mais informações sobre como começar, consulte Introdução à CLI do Azure DevOps.

Você também pode usar parâmetros globais da CLI do Azure, como debug, help, only-show-errors, query, outpute verbose, em seus comandos da CLI do Azure DevOps. O table valor para o parâmetro global apresenta a --output saída em um formato amigável. Para obter mais informações, consulte Formatos de saída para comandos da CLI do Azure.

Você pode definir a organização padrão do Azure DevOps para comandos da CLI do Azure DevOps usando o az devops configure --defaults organization=<YourOrganizationURL>, ou usar o parâmetro --detect true para detectar automaticamente a organização. Você pode configurar o projeto padrão do Azure DevOps usando az devops configure -d project=<Project Name or ID>.

Se não detectar a organização ou configurar uma organização ou projeto padrão, ou obter a organização e o projeto através de git config, deverá especificar os parâmetros org e project em cada comando.

Listar pipelines existentes

Os comandos de pipeline run, show, update e delete exigem o name ou id do pipeline que se pretende gerir. Se você usar id, o name parâmetro será ignorado. Para obter uma lista de pipelines de projeto, incluindo as suas IDs, utilize o comando az pipelines list. Você pode filtrar ou formatar a lista de resultados usando parâmetros.

Por exemplo, o comando a seguir lista os pipelines de projeto que têm nomes começando com python*, em formato de tabela.

az pipelines list --name python* --output table

Saída:

ID    Path    Name                        Status    Default Queue
----  ------  --------------------------  --------  ---------------
17    \       python-sample-vscode-flask  disabled  Azure Pipelines
24    \       python-sample-get-started   enabled   Azure Pipelines

Para obter a referência de comando completa, consulte az pipelines list.

Mostrar detalhes de uma linha de processamento

Para exibir os detalhes de um pipeline existente, use o comando az pipelines show . Por exemplo, o comando a seguir mostra os detalhes do pipeline com o ID de 12, e abre a página de resumo do pipeline no seu navegador web.

az pipelines show --id 12 --open

Para obter a referência de comando completa, consulte az pipelines show.

Executar um pipeline

Para enfileirar e executar um pipeline existente, use o comando az pipelines run . Você pode definir parameters e variables usar na execução.

Por exemplo, o comando a seguir executa o pipeline com name of myGithubname.pipelines-java na pipeline ramificação, define o valor da variável var1 como 100 para a execução e produz resultados no table formato.

az pipelines run --name myGithubname.pipelines-java --branch pipeline --variables var1=100 --output table

Saída:

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 obter a referência de comando completa, consulte az pipelines run.

Atualizar um pipeline

Para atualizar um pipeline existente, use o comando az pipelines update. Por exemplo, o comando a seguir atualiza o pipeline com o id de 12 para um novo nome e descrição, e gera o resultado no formato de tabela.

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

Saída:

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

Para obter a referência de comando completa, consulte az pipelines update.

Eliminar um pipeline

Para excluir um pipeline, execute o comando az-pipelines-delete . Por exemplo, o comando a seguir exclui o pipeline com ID de 12, e não solicita confirmação. Se você não incluir o --yes parâmetro, o comando solicitará a confirmação por padrão.

az pipelines delete --id 12 --yes

Para obter a referência de comando completa, consulte az pipelines delete.

Criar e configurar pipelines programaticamente

Para usar a CLI do Azure DevOps para criar um pipeline YAML, consulte az pipelines create. Para executar comandos da CLI do Azure em pipelines YAML, consulte Azure DevOps CLI in Azure Pipelines YAML.

Você pode criar pipelines YAML para criar, configurar, testar e implantar aplicativos no idioma de sua escolha. Para obter mais informações, consulte os seguintes artigos:

API REST dos Serviços de DevOps do Azure

Você pode criar aplicativos ou serviços personalizados que se integram ao Azure DevOps usando as APIs REST para fazer chamadas HTTP diretas. Para obter mais informações, consulte a Referência da API REST dos Serviços de DevOps do Azure. Você também pode usar as bibliotecas de cliente para essas APIs.

Pular um estágio em uma execução de pipeline

Você pode usar o comando az rest com a API REST Run Pipeline para pular um estágio em uma execução de pipeline, usando o stagesToSkip parâmetro.

Por exemplo:

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 obter mais informações, consulte Usar a API REST do Azure com a CLI do Azure.

Conteúdos relacionados