Managing Azure Pipelines Resources (with examples)

1: Create a new Azure Pipeline

az pipelines create --org organization_url --project project_name --name pipeline_name --description description --repository repository_name --branch branch_name

Motivation

Creating a new Azure Pipeline allows you to automate your software delivery process. By provisioning a new pipeline, you can define the steps and configurations required to build, test, and deploy your applications.

Explanation

• --org: The URL of the Azure DevOps organization.
• --project: The name of the Azure DevOps project.
• --name: The name of the pipeline.
• --description: The description of the pipeline.
• --repository: The name or ID of the repository where your source code is hosted.
• --branch: The branch to build when the pipeline runs.

Example Output

{
  "id": 123,
  "name": "pipeline_name",
  "description": "description",
  "repositoryId": "repository_name",
  "branch": "branch_name",
  ...
}

2: Delete a specific pipeline

az pipelines delete --org organization_url --project project_name --id pipeline_id

Motivation

Deleting a specific pipeline allows you to remove pipelines that are no longer needed, freeing up resources and reducing clutter in your Azure DevOps environment.

Explanation

• --org: The URL of the Azure DevOps organization.
• --project: The name of the Azure DevOps project.
• --id: The ID of the pipeline to delete.

Example Output

Successfully deleted pipeline with ID: pipeline_id

3: List pipelines

az pipelines list --org organization_url --project project_name

Motivation

Listing pipelines provides an overview of all the pipelines in a specific Azure DevOps project. This information is helpful for managing and organizing your pipelines effectively.

Explanation

• --org: The URL of the Azure DevOps organization.
• --project: The name of the Azure DevOps project.

Example Output

[
  {
    "id": 123,
    "name": "pipeline_name1",
    "description": "description1",
    ...
  },
  {
    "id": 456,
    "name": "pipeline_name2",
    "description": "description2",
    ...
  },
  ...
]

4: Enqueue a specific pipeline to run

az pipelines run --org organization_url --project project_name --name pipeline_name

Motivation

Enqueuing a pipeline to run allows you to manually trigger the execution of a specific pipeline. This is useful when you want to run a pipeline outside of its regular schedule or in response to specific events.

Explanation

• --org: The URL of the Azure DevOps organization.
• --project: The name of the Azure DevOps project.
• --name: The name of the pipeline to enqueue.

Example Output

{
  "message": "Pipeline run queued successfully",
  ...
}

5: Get the details of a specific pipeline

az pipelines show --org organization_url --project project_name --name pipeline_name

Motivation

Getting the details of a pipeline helps you understand its configuration, triggers, and other properties. This is useful for troubleshooting issues or reviewing the settings of an existing pipeline.

Explanation

• --org: The URL of the Azure DevOps organization.
• --project: The name of the Azure DevOps project.
• --name: The name of the pipeline to get details of.

Example Output

{
  "id": 123,
  "name": "pipeline_name",
  "description": "description",
  "repositoryId": "repository_name",
  "branch": "branch_name",
  ...
}

6: Update a specific pipeline

az pipelines update --org organization_url --project project_name --name pipeline_name --new-name pipeline_new_name --new-folder-path user1/production_pipelines

Motivation

Updating a pipeline allows you to modify its name, folder location, or other properties. This is helpful when you want to reorganize your pipelines or make changes to their configurations.

Explanation

• --org: The URL of the Azure DevOps organization.
• --project: The name of the Azure DevOps project.
• --name: The name of the pipeline to update.
• --new-name: The new name to assign to the pipeline.
• --new-folder-path: The new folder path to move the pipeline to.

Example Output

{
  "id": 123,
  "name": "pipeline_new_name",
  "description": "description",
  "repositoryId": "repository_name",
  "branch": "branch_name",
  ...
}

7: Get a list of agents in a pool

az pipelines agent list --org organization_url --pool-id agent_pool

Motivation

Getting a list of agents in a pool provides information about the available resources for running pipeline jobs. This is useful for monitoring agent capacity or troubleshooting pipeline execution issues.

Explanation

• --org: The URL of the Azure DevOps organization.
• --pool-id: The ID of the agent pool.

Example Output

[
  {
    "id": 123,
    "name": "agent_name1",
    "status": "online",
    ...
  },
  {
    "id": 456,
    "name": "agent_name2",
    "status": "offline",
    ...
  },
  ...
]