az pipelines

Observação

Essa referência faz parte da extensão azure-devops para a CLI do Azure (versão 2.30.0 ou superior). A extensão será instalada automaticamente na primeira vez que você executar um comando az pipelines . Saiba mais sobre extensões.

Gerenciar o Azure Pipelines.

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

Comandos

Nome	Description	Tipo	Status
az pipelines agent	Gerenciar agentes.	Extensão	GA
az pipelines agent list	Obtenha uma lista de agentes em um pool.	Extensão	GA
az pipelines agent show	Mostrar detalhes do agente.	Extensão	GA
az pipelines build	Gerenciar builds.	Extensão	GA
az pipelines build cancel	Cancela se a compilação estiver em execução.	Extensão	GA
az pipelines build definition	Criar definições de build.	Extensão	GA
az pipelines build definition list	Listar definições de compilação.	Extensão	GA
az pipelines build definition show	Obtenha os detalhes de uma definição de compilação.	Extensão	GA
az pipelines build list	Listar resultados de compilação.	Extensão	GA
az pipelines build queue	Solicitar (fila) uma compilação.	Extensão	GA
az pipelines build show	Obtenha os detalhes de uma compilação.	Extensão	GA
az pipelines build tag	Gerenciar marcas de build.	Extensão	GA
az pipelines build tag add	Adicione tag(s) para uma compilação.	Extensão	GA
az pipelines build tag delete	Exclua uma tag de compilação.	Extensão	GA
az pipelines build tag list	Obtenha tags para uma compilação.	Extensão	GA
az pipelines create	Crie um novo Pipeline do Azure (baseado em YAML).	Extensão	GA
az pipelines delete	Excluir um pipeline.	Extensão	GA
az pipelines folder	Gerenciar pastas para organizar pipelines.	Extensão	GA
az pipelines folder create	Crie uma pasta.	Extensão	GA
az pipelines folder delete	Excluir uma pasta.	Extensão	GA
az pipelines folder list	Liste todas as pastas.	Extensão	GA
az pipelines folder update	Atualize um nome ou descrição de pasta.	Extensão	GA
az pipelines list	Listar pipelines.	Extensão	GA
az pipelines pool	Gerenciar pools de agentes.	Extensão	GA
az pipelines pool list	Listar pools de agentes.	Extensão	GA
az pipelines pool show	Mostrar detalhes do pool de agentes.	Extensão	GA
az pipelines queue	Gerenciar filas de agentes.	Extensão	GA
az pipelines queue list	Listar filas de agentes.	Extensão	GA
az pipelines queue show	Mostrar detalhes da fila do agente.	Extensão	GA
az pipelines release	Gerenciar versões.	Extensão	GA
az pipelines release create	Solicitar (criar) uma liberação.	Extensão	GA
az pipelines release definition	Gerenciar definições da versão.	Extensão	GA
az pipelines release definition list	Listar definições de versão.	Extensão	GA
az pipelines release definition show	Obtenha os detalhes de uma definição de versão.	Extensão	GA
az pipelines release list	Listar resultados de lançamentos.	Extensão	GA
az pipelines release show	Obtenha os detalhes de uma versão.	Extensão	GA
az pipelines run	Enfileirar (executar) um pipeline.	Extensão	GA
az pipelines runs	Gerenciar execuções de pipeline.	Extensão	GA
az pipelines runs artifact	Gerenciar artefatos de execução de pipeline.	Extensão	GA
az pipelines runs artifact download	Baixe um artefato de pipeline.	Extensão	GA
az pipelines runs artifact list	Listar artefatos associados a uma execução.	Extensão	GA
az pipelines runs artifact upload	Carregue um artefato de pipeline.	Extensão	GA
az pipelines runs list	Listar o pipeline executado em um projeto.	Extensão	GA
az pipelines runs show	Mostrar detalhes de uma execução de pipeline.	Extensão	GA
az pipelines runs tag	Gerenciar marcas de execução de pipeline.	Extensão	GA
az pipelines runs tag add	Adicione tag(s) para uma execução de pipeline.	Extensão	GA
az pipelines runs tag delete	Exclua uma marca de execução de pipeline.	Extensão	GA
az pipelines runs tag list	Obter tags para uma execução de pipeline.	Extensão	GA
az pipelines show	Obtenha os detalhes de um pipeline.	Extensão	GA
az pipelines update	Atualizar um pipeline.	Extensão	GA
az pipelines variable	Gerenciar variáveis de pipeline.	Extensão	GA
az pipelines variable-group	Gerenciar grupos de variáveis.	Extensão	GA
az pipelines variable-group create	Crie um grupo de variáveis.	Extensão	GA
az pipelines variable-group delete	Excluir um grupo de variáveis.	Extensão	GA
az pipelines variable-group list	Listar grupos de variáveis.	Extensão	GA
az pipelines variable-group show	Mostrar detalhes do grupo de variáveis.	Extensão	GA
az pipelines variable-group update	Atualizar um grupo de variáveis.	Extensão	GA
az pipelines variable-group variable	Gerenciar variáveis em um grupo de variáveis.	Extensão	GA
az pipelines variable-group variable create	Adicione uma variável a um grupo de variáveis.	Extensão	GA
az pipelines variable-group variable delete	Excluir uma variável do grupo de variáveis.	Extensão	GA
az pipelines variable-group variable list	Listar as variáveis em um grupo de variáveis.	Extensão	GA
az pipelines variable-group variable update	Atualizar uma variável em um grupo de variáveis.	Extensão	GA
az pipelines variable create	Adicione uma variável a um pipeline.	Extensão	GA
az pipelines variable delete	Exclua uma variável do pipeline.	Extensão	GA
az pipelines variable list	Listar as variáveis em um pipeline.	Extensão	GA
az pipelines variable update	Atualizar uma variável em um pipeline.	Extensão	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]
                    [--project]
                    [--queue-id]
                    [--repository]
                    [--repository-type {github, tfsgit}]
                    [--service-connection]
                    [--skip-first-run {false, true}]
                    [--yaml-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 Pipeline do Azure 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 Pipeline do Azure para um repositório hospedado na organização do 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 Pipeline do Azure 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 Pipeline do Azure para um repositório com o yaml do pipeline já feito 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

--branch

Nome da ramificação para a qual o pipeline será configurado. Se omitido, ele será detectado automaticamente a partir do repositório local.

--description

Descrição do novo pipeline.

--detect

Detectar a organização automaticamente.

valores aceitos: false, true

--folder-path

Caminho da pasta onde o pipeline precisa ser criado. O padrão é a pasta raiz. por exemplo, "usuário1/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 a URL de clone do repositório git ou o nome do repositório para um Azure Repos ou Owner/RepoName no caso do repositório GitHub. Se omitido, ele será detectado automaticamente a partir da url remota do repositório git local. Se name 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 a partir da url remota do repositório local. 'tfsgit' para Azure Repos, 'github' para repositório GitHub.

valores aceitos: github, tfsgit

--service-connection

ID da conexão de serviço criada para o repositório do 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 acionada pelo comando. O comando retornará um pipeline se a execução for ignorada, caso contrário, ele produzirá uma execução de pipeline.

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 o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc

valor padrão: json

--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 o detalhamento do log. Use --debug para logs de depuração completos.

az pipelines delete

Excluir um pipeline.

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

Parâmetros Exigidos

--id

ID do pipeline.

Parâmetros Opcionais

--detect

Detectar a organização automaticamente.

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.

valor padrão: False

Parâmetros Globais

--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc

valor padrão: json

--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 o detalhamento do log. Use --debug para logs de depuração completos.

az pipelines list

Listar pipelines.

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

Parâmetros Opcionais

--detect

Detectar a organização automaticamente.

valores aceitos: false, true

--folder-path

Se especificado, filtra para definições nesta 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.

valores aceitos: ModifiedAsc, ModifiedDesc, NameAsc, NameDesc, None

--repository

Limite os resultados aos pipelines associados a este repositório.

--repository-type

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

valores aceitos: bitbucket, git, github, githubenterprise, svn, tfsgit, tfsversioncontrol

--top

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

Parâmetros Globais

--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc

valor padrão: json

--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 o detalhamento do log. Use --debug para logs de depuração completos.

az pipelines run

Enfileirar (executar) um pipeline.

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

Parâmetros Opcionais

--branch

Nome da ramificação na qual o pipeline é executado deve ser enfileirado. Exemplo: refs/heads/master ou master ou refs/pull/1/merge ou refs/tags/tag.

--commit-id

Commit-id no qual o pipeline executado deve ser enfileirado.

--detect

Detectar a organização automaticamente.

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 a ser enfileirado. Ignorado se --id for fornecido.

--open

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

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 de git config. Exemplo: https://dev.azure.com/MyOrganizationName/.

--parameters

Pares "name=value" separados por espaço para os parâmetros que você gostaria de 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ê gostaria de definir.

Parâmetros Globais

--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc

valor padrão: json

--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 o detalhamento do log. Use --debug para logs de depuração completos.

az pipelines show

Obtenha os detalhes de um pipeline.

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

Parâmetros Opcionais

--detect

Detectar a organização automaticamente.

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 for fornecido.

--open

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

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 o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc

valor padrão: json

--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 o detalhamento do log. Use --debug para logs de depuração completos.

az pipelines update

Atualizar um pipeline.

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

Parâmetros Exigidos

--id

Id do pipeline a ser atualizado.

Parâmetros Opcionais

--branch

Nome da ramificação para a qual o pipeline será configurado.

--description

Nova descrição para o pipeline.

--detect

Detectar a organização automaticamente.

valores aceitos: false, true

--new-folder-path

Novo caminho completo da pasta para a qual mover o pipeline. por exemplo, "usuário1/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 onde o pipeline precisa ser executado.

--yaml-path --yml-path

Caminho do arquivo yaml de pipelines no repositório.

Parâmetros Globais

--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc

valor padrão: json

--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 o detalhamento do log. Use --debug para logs de depuração completos.