Uso de ações do Microsoft Azure DevOps em fluxos de ação

Suite, todas as versões

Team, Growth, Professional, Enterprise ou Enterprise Plus

Support

Team, Professional ou Enterprise

Resumo: ◀▼

Você pode conectar o criador de ações ao Microsoft Azure DevOps para automatizar fluxos de trabalho que criam, atualizam e gerenciam itens de trabalho, pull requests, projetos e pipelines. Use ações externas, como criar itens de trabalho, adicionar comentários, acionar execuções de pipeline e recuperar status, para melhorar a colaboração e otimizar o gerenciamento de tarefas entre plataformas. Use uma conta de serviço dedicada para autenticação segura e permissões adequadas.

Ao conectar o criador de ações a sistemas externos, como o Microsoft Azure DevOps, os administradores podem integrar o Zendesk a sistemas externos com fluxos de trabalho automatizados, melhorando a colaboração e mantendo uma experiência contínua em várias plataformas.

Observação: as etapas associadas aos sistemas externos em fluxos de ação são chamadas coletivamente de ações externas.

Este artigo contém os seguintes tópicos:

Conexão do Microsoft Azure DevOps ao criador de ações
Uso de ações do Microsoft Azure DevOps em fluxos de ação

Conexão do Microsoft Azure DevOps ao criador de ações

Antes de incluir ações externas nos seus fluxos de ação, é preciso conectar o criador de ações ao sistema externo.

Ao se conectar a sistemas externos para uso em fluxos de ação, as seguintes práticas recomendadas devem ser observadas:

Todas as ações externas realizadas por um fluxo de ação são atribuídas ao usuário que conectou o sistema externo. Portanto, é uma prática recomendada usar uma conta de serviço dedicada em vez de credenciais pessoais ao se conectar a cada sistema externo.
Todas as integrações solicitam acesso aos escopos necessários. No entanto, é importante que você avalie e valide os escopos antes de autorizar a conexão com o sistema externo.
Ao gerenciar credenciais para ferramentas baseadas em chave de API, como a OpenAI, recomendamos armazenar as chaves em um cofre seguro ou em um gerenciador de credenciais.

Como conectar o criador de ações ao Microsoft Azure DevOps

Na Central de administração, clique em Aplicativos e integrações na barra lateral e selecione Ações > Fluxos de ação.
Crie ou edite um fluxo de ação.
Abra a barra lateral da etapa.
Em Ações externas, clique em Microsoft Azure DevOps.
Clique em Conectar.
Siga as instruções do Microsoft Azure DevOps para autenticar e concluir a conexão.
A conexão do Microsoft Azure DevOps usa OAuth 2.0 para autenticação segura. Você será redirecionado para a Microsoft para autorizar o acesso à sua organização do Azure DevOps. O conector gerencia automaticamente a atualização do token quando necessário.

Certifique-se de que o usuário que está fazendo a autenticação tenha permissões adequadas na organização do Azure DevOps para as operações que você planeja executar por meio dos fluxos de ação.

Observação: Todas as ações externas realizadas por um fluxo de ação são atribuídas ao usuário que conectou o sistema externo. Portanto, é uma prática recomendada usar uma conta de serviço dedicada em vez de credenciais pessoais ao se conectar a cada sistema externo.

Depois de se conectar ao sistema, você verá um indicador de conexão e detalhes sobre a instância à qual está conectado, bem como as ações disponíveis para o Microsoft Azure DevOps.

Uso de ações do Microsoft Azure DevOps em fluxos de ação

As seguintes ações do Microsoft Azure DevOps estão disponíveis:

Criar item de trabalho
Atualizar item de trabalho
Pesquisar item de trabalho
Adicionar comentário ao item de trabalho
Listar itens de trabalho
Criar pull request
Atualizar pull request
Pesquisar pull request
Listar pull requests
Pesquisar projeto
Listar projetos
Listar pipelines
Acionar execução do pipeline
Obter status do pipeline
Listar execuções do pipeline

Criação de um item de trabalho

Use a ação Criar item de trabalho para criar um novo item de trabalho em um projeto do Azure DevOps.

As entradas e saídas dessa ação são:

Variáveis

Entradas

	Variáveis
Entradas	Obrigatórias: `Organization`, `Project`, `Work item type`, `Title` O campo Tipo de item de trabalho é preenchido dinamicamente com base na configuração do seu projeto e pode incluir os tipos Bug, Tarefa, Histórico do usuário, Épico, Recurso ou tipos personalizados. Opcionais: `Description`, `Assigned to`, `State`, `Priority`, `Tags`, `Area path`, `Iteration path`, `Repro steps`, `Acceptance criteria`, `Story points`, `Original estimate`, `Remaining work`, `Severity`, `Activity`, `Parent ID`, `Reason` Os campos opcionais variam por tipo de item de trabalho (por exemplo, Etapas de reprodução para Bugs, Critérios de aceitação para Históricos do usuário).
Saída	Objeto de item de trabalho, incluindo id, rev, work_item_type, title, description, state, assigned_to, created_date, changed_date, url e todos os detalhes de campo.

Obrigatórias: Organization, Project,

Work item
                                            type

, Title

O campo Tipo de item de trabalho é preenchido dinamicamente com base na configuração do seu projeto e pode incluir os tipos Bug, Tarefa, Histórico do usuário, Épico, Recurso ou tipos personalizados.

Opcionais: Description, Assigned to, State, Priority, Tags, Area path, Iteration path, Repro steps, Acceptance criteria, Story points, Original estimate, Remaining work, Severity, Activity, Parent ID, Reason

Os campos opcionais variam por tipo de item de trabalho (por exemplo, Etapas de reprodução para Bugs, Critérios de aceitação para Históricos do usuário).

Saída Objeto de item de trabalho, incluindo id, rev, work_item_type, title, description, state, assigned_to, created_date, changed_date, url e todos os detalhes de campo.

Atualização de um item de trabalho

Use a ação Atualizar item de trabalho para modificar os campos de um item de trabalho existente.

As entradas e saídas dessa ação são:

Variáveis

Entradas

	Variáveis
Entradas	Obrigatórias: `Organization`, `Work item ID` Opcionais: `Project`, `Title`, `Description`, `Assigned to`, `State`, `Priority`, `Tags`, `Reason`, `Area path`, `Iteration path`, `Remaining work`, `Completed work`, `Story points`, `Severity`, `Activity` Somente os campos fornecidos são alterados. Os valores existentes para os campos que você não especificar permanecem inalterados. A seleção de um projeto ativa as opções de estado, caminho da área e caminho de iteração, específicas para esse projeto.
Saída	Objeto de item de trabalho atualizado, incluindo id, rev, work_item_type, title, changed_date, url e todos os detalhes do campo atualizado.

Obrigatórias: Organization,

Work
                                            item ID

Opcionais: Project, Title, Description, Assigned to, State, Priority, Tags, Reason, Area path, Iteration path, Remaining work, Completed work, Story points, Severity, Activity

Somente os campos fornecidos são alterados. Os valores existentes para os campos que você não especificar permanecem inalterados.

A seleção de um projeto ativa as opções de estado, caminho da área e caminho de iteração, específicas para esse projeto.

Saída Objeto de item de trabalho atualizado, incluindo id, rev, work_item_type, title, changed_date, url e todos os detalhes do campo atualizado.

Pesquisa de um item de trabalho

Use a ação Pesquisar item de trabalho para recuperar informações detalhadas sobre um item de trabalho específico por ID.

As entradas e saídas dessa ação são:

Variáveis

Entradas

	Variáveis
Entradas	Obrigatórias: `Organization`, `Work item ID` Opcionais: `Expand relations`, `Expand comments` Defina Expandir relacionamentos como Sim para incluir os itens de trabalho pais, filhos e relacionados, bem como links e anexos. Defina Expandir comentários como Sim para incluir todos os comentários e o histórico de discussões.
Saída	Objeto de item de trabalho, incluindo todos os campos, com itens de trabalho pais, filhos e relacionados opcionais, anexos e matriz de comentários.

Obrigatórias: Organization,

Work
                                            item ID

Opcionais: Expand relations, Expand comments

Defina Expandir relacionamentos como Sim para incluir os itens de trabalho pais, filhos e relacionados, bem como links e anexos.

Defina Expandir comentários como Sim para incluir todos os comentários e o histórico de discussões.

Saída Objeto de item de trabalho, incluindo todos os campos, com itens de trabalho pais, filhos e relacionados opcionais, anexos e matriz de comentários.

Adição de comentário a um item de trabalho

Use a ação Adicionar comentário ao item de trabalho para publicar um comentário em um item de trabalho.

As entradas e saídas dessa ação são:

	Variáveis
Entradas	Obrigatórias: `Organization`, `Project`, `Work item ID`, `Comment text`
Saída	Objeto de comentário, incluindo comment_id, work_item_id, text, created_by, created_date, modified_date, url e comment_version.

Listagem de itens de trabalho

Use a ação Listar itens de trabalho para pesquisar itens de trabalho usando WIQL (Work Item Query Language) ou filtrar campos.

As entradas e saídas dessa ação são:

Variáveis

Entradas

	Variáveis
Entradas	Obrigatórias: `Organization`, `Project` Opcionais: `Query`, `Title contains`, `Work item type`, `State`, `Assigned to`, `Tags contain`, `Area path`, `Max results`, `Sort field`, `Sort order` Você pode usar o campo Consulta para escrever consultas WIQL personalizadas para filtragem avançada ou deixá-lo em branco para usar os campos de filtro simples a seguir. O valor padrão em Máximo de resultados é 50 e não pode exceder 200. Os valores aceitos no campo de classificação são data da alteração, data da criação, título ou prioridade.
Saída	Matriz de resultados de itens de trabalho com total_count e a sinalização de paginação has_more.

Obrigatórias: Organization, Project

Opcionais: Query, Title contains, Work item type, State, Assigned to, Tags contain, Area path, Max results, Sort field, Sort order

Você pode usar o campo Consulta para escrever consultas WIQL personalizadas para filtragem avançada ou deixá-lo em branco para usar os campos de filtro simples a seguir.

O valor padrão em Máximo de resultados é 50 e não pode exceder 200.

Os valores aceitos no campo de classificação são data da alteração, data da criação, título ou prioridade.

Saída Matriz de resultados de itens de trabalho com total_count e a sinalização de paginação has_more.

Criação de uma pull request

Use a ação Criar pull request para criar uma nova pull request em um repositório Git.

As entradas e saídas dessa ação são:

Variáveis

Entradas

	Variáveis
Entradas	Obrigatórias: `Organization`, `Project`, `Repository`, `Source branch`, `Target branch`, `Title` Opcionais: `Description`, `Reviewers`, `Work item IDs`, `Is draft`, `Auto complete`, `Labels`, `Merge strategy`, `Delete source branch` Os nomes de ramificação devem ter o formato `feature/branch-name` ou `refs/heads/feature/branch-name`. Avaliadores devem ser endereços de e-mail separados por vírgula. IDs do item de trabalho devem ser IDs numéricos separados por vírgula. Defina É rascunho como Sim para criar como uma pull request de rascunho.
Saída	Objeto de pull request, incluindo pull_request_id, title, description, status, created_date, created_by, repository, source_branch, target_branch, reviewers array, work_item_refs array, url e web_url.

Obrigatórias: Organization, Project, Repository, Source branch,

Target
                                            branch

, Title

Opcionais: Description, Reviewers, Work item IDs, Is draft, Auto complete, Labels, Merge strategy, Delete source branch

Os nomes de ramificação devem ter o formato feature/branch-name ou refs/heads/feature/branch-name.

Avaliadores devem ser endereços de e-mail separados por vírgula.

IDs do item de trabalho devem ser IDs numéricos separados por vírgula.

Defina É rascunho como Sim para criar como uma pull request de rascunho.

Saída Objeto de pull request, incluindo pull_request_id, title, description, status, created_date, created_by, repository, source_branch, target_branch, reviewers array, work_item_refs array, url e web_url.

Atualização de uma pull request

Use a ação Atualizar pull request para modificar uma pull request existente.

As entradas e saídas dessa ação são:

Variáveis

Entradas

	Variáveis
Entradas	Obrigatórias: `Organization`, `Project`, `Repository`, `Pull request ID` Opcionais: `Title`, `Description`, `Status`, `Is draft`, `Auto complete enabled`, `Merge strategy` Somente os campos fornecidos são alterados. Os valores aceitos para Status são active, completed ou abandoned. Defina Preenchimento automático ativado como Sim para mesclar automaticamente quando todas as políticas forem aprovadas.
Saída	Objeto de pull request atualizado, incluindo pull_request_id, title, status, merge details, last_merge_commit, closed_date, url e web_url.

Obrigatórias: Organization, Project, Repository, Pull request ID

Opcionais: Title, Description, Status, Is draft, Auto complete enabled, Merge strategy

Somente os campos fornecidos são alterados.

Os valores aceitos para Status são active, completed ou abandoned.

Defina Preenchimento automático ativado como Sim para mesclar automaticamente quando todas as políticas forem aprovadas.

Saída Objeto de pull request atualizado, incluindo pull_request_id, title, status, merge details, last_merge_commit, closed_date, url e web_url.

Pesquisa de uma pull request

Use a ação Pesquisar pull request para recuperar informações detalhadas sobre uma pull request específica.

As entradas e saídas dessa ação são:

Variáveis

Entradas

	Variáveis
Entradas	Obrigatórias: `Organization`, `Project`, `Repository`, `Pull request ID` Opcionais: `Include commits`, `Include work items` Defina Incluir commits como Sim para recuperar todos os commits incluídos na pull request. Defina Incluir itens de trabalho como Sim para recuperar os itens de trabalho vinculados.
Saída	Objeto de pull request detalhado, incluindo todos os campos, matriz de avaliadores, matriz de rótulos, commits opcionais e work_item_refs arrays, completion_options, url e web_url.

Obrigatórias: Organization, Project, Repository, Pull request ID

Opcionais: Include commits, Include work items

Defina Incluir commits como Sim para recuperar todos os commits incluídos na pull request.

Defina Incluir itens de trabalho como Sim para recuperar os itens de trabalho vinculados.

Saída Objeto de pull request detalhado, incluindo todos os campos, matriz de avaliadores, matriz de rótulos, commits opcionais e work_item_refs arrays, completion_options, url e web_url.

Listagem de pull requests

Use a ação Listar pull requests para recuperar todas as pull requests de um repositório Git.

As entradas e saídas dessa ação são:

Variáveis

Entradas

	Variáveis
Entradas	Obrigatórias: `Organization`, `Project`, `Repository` Opcionais: `Status`, `Creator ID`, `Reviewer ID`, `Source branch`, `Target branch`, `Max results`, `Skip` O valor de Status pode ser all (padrão), active, completed ou abandoned. Máximo de resultados aceita de 1 a 100 (padrão: 50). Use Ignorar para paginação para ignorar os primeiros N resultados.
Saída	Matriz de pull requests com objetos de pull request, além de detalhes de paginação com total_count e a sinalização has_more.

Obrigatórias: Organization, Project, Repository

Opcionais: Status, Creator ID, Reviewer ID, Source branch, Target branch, Max results, Skip

O valor de Status pode ser all (padrão), active, completed ou abandoned.

Máximo de resultados aceita de 1 a 100 (padrão: 50).

Use Ignorar para paginação para ignorar os primeiros N resultados.

Saída Matriz de pull requests com objetos de pull request, além de detalhes de paginação com total_count e a sinalização has_more.

Pesquisa de projeto

Use a ação Pesquisar projeto para recuperar detalhes sobre um projeto específico do Azure DevOps.

As entradas e saídas dessa ação são:

Variáveis

Entradas

	Variáveis
Entradas	Obrigatórias: `Organization`, `Project` Opcionais: `Include capabilities`, `Include history` Defina Incluir recursos como Sim para recuperar o controle de versão e processar detalhes do modelo. Defina Incluir histórico como Sim para recuperar o histórico de alterações do projeto.
Saída	Objeto de projeto, incluindo id, nome, descrição, estado, visibilidade, default_team, url, com recursos opcionais e histórico.

Obrigatórias: Organization, Project

Opcionais: Include capabilities, Include history

Defina Incluir recursos como Sim para recuperar o controle de versão e processar detalhes do modelo.

Defina Incluir histórico como Sim para recuperar o histórico de alterações do projeto.

Saída Objeto de projeto, incluindo id, nome, descrição, estado, visibilidade, default_team, url, com recursos opcionais e histórico.

Listagem de projetos

Use a ação Listar projetos para recuperar todos os projetos em uma organização.

As entradas e saídas dessa ação são:

Variáveis

Entradas

	Variáveis
Entradas	Obrigatória: `Organization` Opcionais: `State filter`, `Continuation token`, `Max results` Os valores aceitos para Filtro de estado são All, WellFormed (projetos ativos, padrão), Deleting ou New. Máximo de resultados aceita de 1 a 100 (padrão: 100).
Saída	Matriz de projetos com objetos de projeto, incluindo id, nome, descrição, estado, visibilidade e url, além de total_count e continuation_token.

Obrigatória: Organization

Opcionais: State filter, Continuation token, Max results

Os valores aceitos para Filtro de estado são All, WellFormed (projetos ativos, padrão), Deleting ou New.

Máximo de resultados aceita de 1 a 100 (padrão: 100).

Saída Matriz de projetos com objetos de projeto, incluindo id, nome, descrição, estado, visibilidade e url, além de total_count e continuation_token.

Listagem de pipelines

Use a ação Listar pipelines para recuperar a criação e a liberação de pipelines em um projeto.

As entradas e saídas dessa ação são:

Variáveis

Entradas

	Variáveis
Entradas	Obrigatórias: `Organization`, `Project` Opcionais: `Pipeline name`, `Folder path`, `Continuation token` O nome do pipeline tem suporte para correspondência parcial. O formato de caminho da pasta é `\Production` ou `\CI\Builds`.
Saída	Matriz de pipelines com objetos de pipeline, incluindo id, nome, pasta, revisão, url e web_url, além de total_count e continuation_token.

Obrigatórias: Organization, Project

Opcionais: Pipeline name, Folder path, Continuation token

O nome do pipeline tem suporte para correspondência parcial. O formato de caminho da pasta é \Production ou \CI\Builds.

Saída Matriz de pipelines com objetos de pipeline, incluindo id, nome, pasta, revisão, url e web_url, além de total_count e continuation_token.

Acionamento de uma execução de pipeline

Use a ação Acionar execução do pipeline para acionar manualmente uma execução do pipeline.

As entradas e saídas dessa ação são:

Variáveis

Entradas

	Variáveis
Entradas	Obrigatórias: `Organization`, `Project`, `Pipeline ID` Opcionais: `Branch`, `Variables`, `Resources repositories`, `Stages to skip` O formato da ramificação é `main` ou `refs/heads/feature/branch-name`. As variáveis devem ser um objeto JSON (por exemplo, `{"Environment": "Production"}`).
Saída	Objeto de execução, incluindo run_id, run_number, detalhes do pipeline, estado, resultado, created_date, finished_date, url e web_url.

Obrigatórias: Organization, Project,

Pipeline
                                            ID

Opcionais: Branch, Variables, Resources repositories, Stages to skip

O formato da ramificação é main ou refs/heads/feature/branch-name.

As variáveis devem ser um objeto JSON (por exemplo, {"Environment": "Production"}).

Saída Objeto de execução, incluindo run_id, run_number, detalhes do pipeline, estado, resultado, created_date, finished_date, url e web_url.

Obtenção de status de execução do pipeline

Use a ação Obter status de execução do pipeline para recuperar o status e os detalhes de uma execução do pipeline.

As entradas e saídas dessa ação são:

	Variáveis
Entradas	Obrigatórias: `Organization`, `Project`, `Pipeline ID`, `Run ID`
Saída	Objeto de execução detalhada, incluindo run_id, run_number, nome, estado, resultado, detalhes do pipeline, created_date e finished_date. Estado indica o status atual (in progress, completed, canceling, cancelled). Resultado indica o resultado (succeeded, failed, canceled e etc.).

Listagem de execuções do pipeline

Use a ação Listar execuções do pipeline para recuperar execuções recentes de um pipeline específico.

As entradas e saídas dessa ação são:

Variáveis

Entradas

	Variáveis
Entradas	Obrigatórias: `Organization`, `Project`, `Pipeline ID` Opcionais: `Result filter`, `State filter`, `Max results`, `Continuation token` Os valores aceitos para Filtro de resultado são all, succeeded, failed e etc. Máximo de resultados aceita de 1 a 100 (padrão: 50).
Saída	Matriz de execuções com objetos de execução, incluindo run_id, run_number, estado, resultado e urls, além de total_count e continuation_token.

Obrigatórias: Organization, Project,

Pipeline
                                            ID

Opcionais: Result filter, State filter, Max results, Continuation token

Os valores aceitos para Filtro de resultado são all, succeeded, failed e etc. Máximo de resultados aceita de 1 a 100 (padrão: 50).

Saída Matriz de execuções com objetos de execução, incluindo run_id, run_number, estado, resultado e urls, além de total_count e continuation_token.