Compartilhar via


az pipelines

Note

This reference is part of the azure-devops extension for the Azure CLI (version 2.30.0 or higher). The extension will automatically install the first time you run an az pipelines command. Learn more about extensions.

Gerenciar o Azure Pipelines.

Esse grupo de comandos faz parte da extensão azure-devops.

Comandos

Nome Description Tipo Status
az pipelines agent

Manage agents.

Extension GA
az pipelines agent list

Obtenha uma lista de agentes em um pool.

Extension GA
az pipelines agent show

Mostrar detalhes do agente.

Extension GA
az pipelines build

Manage builds.

Extension GA
az pipelines build cancel

Cancela se o build estiver em execução.

Extension GA
az pipelines build definition

Gerenciar definições de build.

Extension GA
az pipelines build definition list

Listar definições de build.

Extension GA
az pipelines build definition show

Obtenha os detalhes de uma definição de build.

Extension GA
az pipelines build list

Liste os resultados da compilação.

Extension GA
az pipelines build queue

Solicite (fila) um build.

Extension GA
az pipelines build show

Obtenha os detalhes de um build.

Extension GA
az pipelines build tag

Gerenciar marcas de build.

Extension GA
az pipelines build tag add

Adicione marcas para um build.

Extension GA
az pipelines build tag delete

Exclua uma marca de build.

Extension GA
az pipelines build tag list

Obter marcas para um build.

Extension GA
az pipelines create

Crie um novo Pipeline do Azure (baseado em YAML).

Extension GA
az pipelines delete

Excluir um pipeline.

Extension GA
az pipelines folder

Gerenciar pastas para organizar pipelines.

Extension GA
az pipelines folder create

Crie uma pasta.

Extension GA
az pipelines folder delete

Exclua uma pasta.

Extension GA
az pipelines folder list

Listar todas as pastas.

Extension GA
az pipelines folder update

Atualize um nome de pasta ou descrição.

Extension GA
az pipelines list

List pipelines.

Extension GA
az pipelines pool

Gerenciar pools de agentes.

Extension GA
az pipelines pool list

Listar pools de agentes.

Extension GA
az pipelines pool show

Mostrar detalhes do pool de agentes.

Extension GA
az pipelines queue

Gerenciar filas de agente.

Extension GA
az pipelines queue list

Listar filas do agente.

Extension GA
az pipelines queue show

Mostrar detalhes da fila do agente.

Extension GA
az pipelines release

Manage releases.

Extension GA
az pipelines release create

Solicite (crie) uma versão.

Extension GA
az pipelines release definition

Gerenciar definições de versão.

Extension GA
az pipelines release definition list

Listar definições de versão.

Extension GA
az pipelines release definition show

Obtenha os detalhes de uma definição de versão.

Extension GA
az pipelines release list

Listar os resultados da versão.

Extension GA
az pipelines release show

Obtenha os detalhes de uma versão.

Extension GA
az pipelines run

Enfileirar (executar) um pipeline.

Extension GA
az pipelines runs

Gerenciar execuções de pipeline.

Extension GA
az pipelines runs artifact

Gerenciar artefatos de execução de pipeline.

Extension GA
az pipelines runs artifact download

Baixe um artefato de pipeline.

Extension GA
az pipelines runs artifact list

Listar artefatos associados a uma execução.

Extension GA
az pipelines runs artifact upload

Carregue um artefato de pipeline.

Extension GA
az pipelines runs list

Liste as execuções de pipeline em um projeto.

Extension GA
az pipelines runs show

Mostrar detalhes de uma execução de pipeline.

Extension GA
az pipelines runs tag

Gerenciar marcas de execução de pipeline.

Extension GA
az pipelines runs tag add

Adicione marcas para uma execução de pipeline.

Extension GA
az pipelines runs tag delete

Excluir uma marca de execução de pipeline.

Extension GA
az pipelines runs tag list

Obter marcas para uma execução de pipeline.

Extension GA
az pipelines show

Obtenha os detalhes de um pipeline.

Extension GA
az pipelines update

Atualize um pipeline.

Extension GA
az pipelines variable

Gerenciar variáveis de pipeline.

Extension GA
az pipelines variable-group

Gerenciar grupos de variáveis.

Extension GA
az pipelines variable-group create

Crie um grupo de variáveis.

Extension GA
az pipelines variable-group delete

Exclua um grupo de variáveis.

Extension GA
az pipelines variable-group list

Listar grupos de variáveis.

Extension GA
az pipelines variable-group show

Mostrar detalhes do grupo de variáveis.

Extension GA
az pipelines variable-group update

Atualize um grupo de variáveis.

Extension GA
az pipelines variable-group variable

Gerenciar variáveis em um grupo de variáveis.

Extension GA
az pipelines variable-group variable create

Adicione uma variável a um grupo de variáveis.

Extension GA
az pipelines variable-group variable delete

Exclua uma variável do grupo de variáveis.

Extension GA
az pipelines variable-group variable list

Liste as variáveis em um grupo de variáveis.

Extension GA
az pipelines variable-group variable update

Atualize uma variável em um grupo de variáveis.

Extension GA
az pipelines variable create

Adicione uma variável a um pipeline.

Extension GA
az pipelines variable delete

Exclua uma variável do pipeline.

Extension GA
az pipelines variable list

Liste as variáveis em um pipeline.

Extension GA
az pipelines variable update

Atualize uma variável em um pipeline.

Extension GA

az pipelines create

Crie um novo Pipeline do Azure (baseado em YAML).

az pipelines create --name
                    [--branch]
                    [--description]
                    [--detect {false, true}]
                    [--folder-path]
                    [--org --organization]
                    [--project]
                    [--queue-id]
                    [--repository]
                    [--repository-type {github, tfsgit}]
                    [--service-connection]
                    [--skip-first-run --skip-run {false, true}]
                    [--yaml-path --yml-path]

Exemplos

Criar um Pipeline do Azure a partir do contexto do repositório de check-out local

Repository name/url (--repository), type (--repository-type) and branch name (--branch) will be detected from the local git repository
az pipelines create --name 'ContosoBuild' --description 'Pipeline for contoso project'

Criar um Azure Pipeline para um repositório hospedado no Github usando a URL de clone

az pipelines create --name 'ContosoBuild' --description 'Pipeline for contoso project'
--repository https://github.com/SampleOrg/SampleRepo --branch master

Criar um Azure Pipeline para um repositório hospedado na organização Github SampleOrg, nome do repositório SampleRepo

az pipelines create --name 'ContosoBuild' --description 'Pipeline for contoso project'
--repository SampleOrg/SampleRepoName --branch master --repository-type github

Criar um Azure Pipeline para um repositório hospedado em um Repositório do Azure no mesmo projeto

az pipelines create --name 'ContosoBuild' --description 'Pipeline for contoso project'
--repository SampleRepoName --branch master --repository-type tfsgit

Criar um Azure Pipeline para um repositório com o yaml de pipeline já check-in no repositório

Service connection required for non Azure Repos can be optionally provided in the command to run it non interatively
az pipelines create --name 'ContosoBuild' --description 'Pipeline for contoso project'
--repository https://github.com/SampleOrg/SampleRepo --branch master --yml-path azure-pipelines.yml [--service-connection SERVICE_CONNECTION]

Parâmetros Exigidos

--name

Nome do novo pipeline.

Parâmetros Opcionais

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--branch

Nome do branch para o qual o pipeline será configurado. Se omitido, ele será detectado automaticamente do repositório local.

--description

Descrição do novo pipeline.

--detect

Detecte automaticamente a organização.

Propriedade Valor
Valores aceitos: false, true
--folder-path

Caminho da pasta em que o pipeline precisa ser criado. O padrão é a pasta raiz. e.g. "user1/test_pipelines".

--org --organization

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 por meio da configuração git. Exemplo: https://dev.azure.com/MyOrganizationName/.

--project -p

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 da configuração Git.

--queue-id

ID da fila nos pools de agentes disponíveis. Será detectado automaticamente se não for especificado.

--repository

Repositório para o qual o pipeline precisa ser configurado. Pode ser clonar a URL do repositório git ou o nome do repositório para um Repositório do Azure ou Proprietário/RepoName no caso do repositório GitHub. Se omitido, ele será detectado automaticamente na URL remota do repositório git local. Se o nome for mencionado em vez de url, o argumento --repository-type também será necessário.

--repository-type

Tipo de repositório. Se omitido, ele será detectado automaticamente da URL remota do repositório local. 'tfsgit' para Repos do Azure, 'github' para repositório GitHub.

Propriedade Valor
Valores aceitos: github, tfsgit
--service-connection

ID da conexão de serviço criada para o repositório para o repositório GitHub. Use o comando az devops service-endpoint -h para criar/listar service_connections. Não é necessário para o Azure Repos.

--skip-first-run --skip-run

Especifique esse sinalizador para impedir que a primeira execução seja disparada pelo comando. O comando retornará um pipeline se a execução for ignorada, caso contrário, gerará uma execução de pipeline.

Propriedade Valor
Valores aceitos: false, true
--yaml-path --yml-path

Caminho do arquivo yaml de pipelines no repositório (se o yaml já estiver presente no repositório).

Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Output format.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False

az pipelines delete

Excluir um pipeline.

az pipelines delete --id
                    [--detect {false, true}]
                    [--org --organization]
                    [--project]
                    [--yes]

Parâmetros Exigidos

--id

ID do pipeline.

Parâmetros Opcionais

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--detect

Detecte automaticamente a organização.

Propriedade Valor
Valores aceitos: false, true
--org --organization

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 por meio da configuração git. Exemplo: https://dev.azure.com/MyOrganizationName/.

--project -p

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 da configuração Git.

--yes -y

Não solicite confirmação.

Propriedade Valor
Valor padrão: False
Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Output format.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False

az pipelines list

List pipelines.

az pipelines list [--detect {false, true}]
                  [--folder-path]
                  [--name]
                  [--org --organization]
                  [--project]
                  [--query-order {ModifiedAsc, ModifiedDesc, NameAsc, NameDesc, None}]
                  [--repository]
                  [--repository-type {bitbucket, git, github, githubenterprise, svn, tfsgit, tfsversioncontrol}]
                  [--top]

Parâmetros Opcionais

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--detect

Detecte automaticamente a organização.

Propriedade Valor
Valores aceitos: false, true
--folder-path

Se especificado, filtra as definições nessa pasta.

--name

Limite os resultados a pipelines com esse nome ou começando com esse nome. Exemplos: "FabCI" ou "Fab*".

--org --organization

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 por meio da configuração git. Exemplo: https://dev.azure.com/MyOrganizationName/.

--project -p

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 da configuração Git.

--query-order

Ordem dos resultados.

Propriedade Valor
Valores aceitos: ModifiedAsc, ModifiedDesc, NameAsc, NameDesc, None
--repository

Limite os resultados a pipelines associados a esse repositório.

--repository-type

Limite os resultados a pipelines associados a esse tipo de repositório. É obrigatório passar o argumento "repositório" junto com esse argumento.

Propriedade Valor
Valores aceitos: bitbucket, git, github, githubenterprise, svn, tfsgit, tfsversioncontrol
--top

Número máximo de pipelines a serem listados.

Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Output format.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False

az pipelines run

Enfileirar (executar) um pipeline.

az pipelines run [--branch]
                 [--commit-id]
                 [--detect {false, true}]
                 [--folder-path]
                 [--id]
                 [--name]
                 [--open]
                 [--org --organization]
                 [--parameters]
                 [--project]
                 [--variables]

Parâmetros Opcionais

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--branch

Nome do branch no qual a execução do pipeline deve ser enfileirada. Exemplo: refs/heads/master ou master ou refs/pull/1/merge ou refs/tags/tag.

--commit-id

ID de confirmação na qual a execução do pipeline deve ser enfileirada.

--detect

Detecte automaticamente a organização.

Propriedade Valor
Valores aceitos: false, true
--folder-path

Caminho da pasta do pipeline. O padrão é a pasta de nível raiz.

--id

ID do pipeline para fila. Obrigatório se --name não for fornecido.

--name

Nome do pipeline para fila. Ignorado se --id é fornecido.

--open

Abra a página de resultados do pipeline no navegador da Web.

Propriedade Valor
Valor padrão: False
--org --organization

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 por meio da configuração git. Exemplo: https://dev.azure.com/MyOrganizationName/.

--parameters

Pares "name=value" separados por espaço para os parâmetros que você deseja definir.

--project -p

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 da configuração Git.

--variables

Pares "name=value" separados por espaço para as variáveis que você deseja definir.

Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Output format.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False

az pipelines show

Obtenha os detalhes de um pipeline.

az pipelines show [--detect {false, true}]
                  [--folder-path]
                  [--id]
                  [--name]
                  [--open]
                  [--org --organization]
                  [--project]

Parâmetros Opcionais

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--detect

Detecte automaticamente a organização.

Propriedade Valor
Valores aceitos: false, true
--folder-path

Caminho da pasta do pipeline. O padrão é a pasta de nível raiz.

--id

ID do pipeline.

--name

Nome do pipeline. Ignorado se --id é fornecido.

--open

Abra a página de resumo do pipeline no navegador da Web.

Propriedade Valor
Valor padrão: False
--org --organization

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 por meio da configuração git. Exemplo: https://dev.azure.com/MyOrganizationName/.

--project -p

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 da configuração Git.

Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Output format.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False

az pipelines update

Atualize um pipeline.

az pipelines update --id
                    [--branch]
                    [--description]
                    [--detect {false, true}]
                    [--new-folder-path]
                    [--new-name]
                    [--org --organization]
                    [--project]
                    [--queue-id]
                    [--yaml-path --yml-path]

Parâmetros Exigidos

--id

ID do pipeline a ser atualizado.

Parâmetros Opcionais

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--branch

Nome do branch para o qual o pipeline será configurado.

--description

Nova descrição do pipeline.

--detect

Detecte automaticamente a organização.

Propriedade Valor
Valores aceitos: false, true
--new-folder-path

Novo caminho completo da pasta para a qual mover o pipeline. por exemplo, "user1/production_pipelines".

--new-name

Novo nome atualizado do pipeline.

--org --organization

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 por meio da configuração git. Exemplo: https://dev.azure.com/MyOrganizationName/.

--project -p

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 da configuração Git.

--queue-id

ID da fila do pool de agentes em que o pipeline precisa ser executado.

--yaml-path --yml-path

Caminho do arquivo yaml de pipelines no repositório.

Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Output format.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False