Gerir pipelines com a CLI do Azure
Serviços de DevOps do Azure | Azure DevOps Server 2022 | Azure DevOps Server 2020
Você pode gerenciar os pipelines em sua organização usando estes az pipelines
comandos:
- az pipelines run: Execute um pipeline existente
- az pipelines update: atualizar um pipeline existente
- az pipelines show: Mostrar os detalhes de um pipeline existente
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, consulte 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 da ramificação na qual o pipeline deve ser executado na fila, por exemplo, refs/heads/main.
- commit-id: ID de confirmação na qual a execução do pipeline deve ser enfileirada.
- folder-path: caminho da pasta do pipeline. O padrão é pasta de nível raiz.
- id: Obrigatório se o nome 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 para fila.
- open: Abra a página de resultados do pipeline no navegador da Web.
- org: URL da organização do Azure DevOps. Você pode configurar a organização padrão usando
az devops configure -d organization=ORG_URL
o . Obrigatório se não estiver configurado como padrão ou coletado usandogit config
o . Exemplo:--org https://dev.azure.com/MyOrganizationName/
. - projeto: 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 coletado usandogit config
o . - variáveis: pares "nome=valor" 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 pipeline de ramificação e mostra o resultado em 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, consulte 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 da ramificação na qual o pipeline deve ser configurado, por exemplo, refs/heads/main.
- description: Nova descrição para o pipeline.
- id: Obrigatório se o nome não for fornecido. ID do pipeline a ser atualizado.
- nome: Obrigatório se o ID não for fornecido. 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: URL da organização do Azure DevOps. Você pode configurar a organização padrão usando
az devops configure -d organization=ORG_URL
o . Obrigatório se não estiver configurado como padrão ou coletado usandogit config
o . Exemplo:--org https://dev.azure.com/MyOrganizationName/
. - projeto: 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 coletado usandogit config
o . - queue-id: ID da fila do pool de agentes onde o pipeline precisa ser executado.
- yaml-path: Caminho do arquivo yaml do pipeline no repo.
Os parâmetros globais incluem debug
, help
, only-show-errors
, query
, output
e verbose
.
Gorjeta
Há também parâmetros globais que você pode usar, como --output
.
O --output
parâmetro está disponível para todos os comandos. O valor da tabela apresenta a saída em um formato amigável. Para obter mais informações, consulte 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 em 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, consulte 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 é pasta de nível raiz.
- id: Obrigatório se o nome não for fornecido. ID do pipeline para mostrar detalhes.
- name: Obrigatório se o nome não for fornecido, mas ignorado se o ID for fornecido. Nome do pipeline para mostrar detalhes.
- open: abra a página de resumo do pipeline no navegador da Web.
- org: URL da organização do Azure DevOps. Você pode configurar a organização padrão usando
az devops configure -d organization=ORG_URL
o . Obrigatório se não estiver configurado como padrão ou coletado usandogit config
o . Exemplo:--org https://dev.azure.com/MyOrganizationName/
. - projeto: 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 coletado usandogit config
o . - exemplos de consulta: Recomende uma cadeia de caracteres JMESPath para você.
- assinatura: Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando
az account set -s NAME_OR_ID
o .
Exemplo
O comando a seguir mostra os detalhes do pipeline com a ID de 12 e retorna o resultado em formato de tabela.
az pipelines show --id 12 --output table
ID Name Status Default Queue
---- -------------------------- -------- ------------------
12 updatedname.pipelines-java enabled Hosted Ubuntu 1604
Próximos passos
Você pode personalizar seu pipeline ou saber mais sobre como configurar pipelines no idioma de sua escolha:
FAQ
Como faço para criar programaticamente um pipeline de compilação?
Referência da API REST: Criar um pipeline de compilação
Nota
Você também pode gerenciar compilações e criar pipelines a partir da linha de comando ou scripts usando a CLI do Azure Pipelines.
Posso executar vários pipelines nos Serviços de DevOps do Azure usando 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 comando. Você pode usar os comandos da CLI do Azure para listar todos os pipelines e definições e fornecer uma única versão ou ID de compilação como parâmetro. Todos os comandos são 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, consulte Especificar eventos que acionam pipelines.
Como posso pular um estágio em uma execução de pipeline?
Você pode usar o az rest
comando para usar a run pipeline
API REST do Azure DevOps para ignorar 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 Referência da API REST dos Serviços de DevOps do Azure.