pipelines.yml

### YamlMime:AzureCLIGroup
uid: az_pipelines
name: az pipelines
extensionInformation: |-
  > [!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](https://learn.microsoft.com/cli/azure/azure-cli-extensions-overview) about extensions.
summary: |-
  Manage Azure Pipelines.
description: |-
  This command group is a part of the azure-devops extension.
status: GA
sourceType: Extension
directCommands:
- uid: az_pipelines_create
  name: az pipelines create
  summary: |-
    Create a new Azure Pipeline (YAML based).
  status: GA
  sourceType: Extension
  syntax: >-
    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]
  examples:
  - summary: |-
      Create an Azure Pipeline from local checkout repository context
    syntax: >-
      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'
  - summary: |-
      Create an Azure Pipeline for a repository hosted on Github using clone url
    syntax: >-
      az pipelines create --name 'ContosoBuild' --description 'Pipeline for contoso project'

      --repository https://github.com/SampleOrg/SampleRepo --branch master
  - summary: |-
      Create an Azure Pipeline for a repository hosted on Github organization SampleOrg, repository name SampleRepo
    syntax: >-
      az pipelines create --name 'ContosoBuild' --description 'Pipeline for contoso project'

      --repository SampleOrg/SampleRepoName --branch master --repository-type github
  - summary: |-
      Create an Azure Pipeline for a repository hosted in a Azure Repo in the same project
    syntax: >-
      az pipelines create --name 'ContosoBuild' --description 'Pipeline for contoso project'

      --repository SampleRepoName --branch master --repository-type tfsgit
  - summary: |-
      Create an Azure Pipeline for a repository with the pipeline yaml already checked in into the repository
    syntax: >-
      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]
  requiredParameters:
  - isRequired: true
    name: --name
    summary: |-
      Name of the new pipeline.
  optionalParameters:
  - name: --branch
    summary: |-
      Branch name for which the pipeline will be configured. If omitted, it will be auto-detected from local repository.
  - name: --description
    summary: |-
      Description for the new pipeline.
  - name: --detect
    acceptedValues: false, true
    summary: |-
      Automatically detect organization.
  - name: --folder-path
    summary: |-
      Path of the folder where the pipeline needs to be created. Default is root folder. e.g. "user1/test_pipelines".
  - name: --org --organization
    summary: |-
      Azure DevOps organization URL. You can configure the default organization using az devops configure -d organization=ORG_URL. Required if not configured as default or picked up via git config. Example: `https://dev.azure.com/MyOrganizationName/`.
  - name: --project -p
    summary: |-
      Name or ID of the project. You can configure the default project using az devops configure -d project=NAME_OR_ID. Required if not configured as default or picked up via git config.
  - name: --queue-id
    summary: |-
      Id of the queue in the available agent pools. Will be auto detected if not specified.
  - name: --repository
    summary: |-
      Repository for which the pipeline needs to be configured. Can be clone url of the git repository or name of the repository for a Azure Repos or Owner/RepoName in case of GitHub repository. If omitted it will be auto-detected from the remote url of local git repository. If name is mentioned instead of url, --repository-type argument is also required.
  - name: --repository-type
    acceptedValues: github, tfsgit
    summary: |-
      Type of repository. If omitted, it will be auto-detected from remote url of local repository. 'tfsgit' for Azure Repos, 'github' for GitHub repository.
  - name: --service-connection
    summary: |-
      Id of the Service connection created for the repository for GitHub repository. Use command az devops service-endpoint -h for creating/listing service_connections. Not required for Azure Repos.
  - name: --skip-first-run --skip-run
    acceptedValues: false, true
    summary: |-
      Specify this flag to prevent the first run being triggered by the command. Command will return a pipeline if run is skipped else it will output a pipeline run.
  - name: --yaml-path --yml-path
    summary: |-
      Path of the pipelines yaml file in the repo (if yaml is already present in the repo).
  globalParameters:
  - name: --debug
    defaultValue: "False"
    summary: |-
      Increase logging verbosity to show all debug logs.
  - name: --help -h
    summary: |-
      Show this help message and exit.
  - name: --only-show-errors
    defaultValue: "False"
    summary: |-
      Only show errors, suppressing warnings.
  - name: --output -o
    defaultValue: json
    acceptedValues: json, jsonc, none, table, tsv, yaml, yamlc
    summary: |-
      Output format.
  - name: --query
    summary: |-
      JMESPath query string. See http://jmespath.org/ for more information and examples.
  - name: --subscription
    summary: |-
      Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.
  - name: --verbose
    defaultValue: "False"
    summary: |-
      Increase logging verbosity. Use --debug for full debug logs.
- uid: az_pipelines_delete
  name: az pipelines delete
  summary: |-
    Delete a pipeline.
  status: GA
  sourceType: Extension
  syntax: >-
    az pipelines delete --id
                        [--detect {false, true}]
                        [--org --organization]
                        [--project]
                        [--yes]
  requiredParameters:
  - isRequired: true
    name: --id
    summary: |-
      ID of the pipeline.
  optionalParameters:
  - name: --detect
    acceptedValues: false, true
    summary: |-
      Automatically detect organization.
  - name: --org --organization
    summary: |-
      Azure DevOps organization URL. You can configure the default organization using az devops configure -d organization=ORG_URL. Required if not configured as default or picked up via git config. Example: `https://dev.azure.com/MyOrganizationName/`.
  - name: --project -p
    summary: |-
      Name or ID of the project. You can configure the default project using az devops configure -d project=NAME_OR_ID. Required if not configured as default or picked up via git config.
  - name: --yes -y
    defaultValue: "False"
    summary: |-
      Do not prompt for confirmation.
  globalParameters:
  - name: --debug
    defaultValue: "False"
    summary: |-
      Increase logging verbosity to show all debug logs.
  - name: --help -h
    summary: |-
      Show this help message and exit.
  - name: --only-show-errors
    defaultValue: "False"
    summary: |-
      Only show errors, suppressing warnings.
  - name: --output -o
    defaultValue: json
    acceptedValues: json, jsonc, none, table, tsv, yaml, yamlc
    summary: |-
      Output format.
  - name: --query
    summary: |-
      JMESPath query string. See http://jmespath.org/ for more information and examples.
  - name: --subscription
    summary: |-
      Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.
  - name: --verbose
    defaultValue: "False"
    summary: |-
      Increase logging verbosity. Use --debug for full debug logs.
- uid: az_pipelines_list
  name: az pipelines list
  summary: |-
    List pipelines.
  status: GA
  sourceType: Extension
  syntax: >-
    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]
  optionalParameters:
  - name: --detect
    acceptedValues: false, true
    summary: |-
      Automatically detect organization.
  - name: --folder-path
    summary: |-
      If specified, filters to definitions under this folder.
  - name: --name
    summary: |-
      Limit results to pipelines with this name or starting with this name. Examples: "FabCI" or "Fab*".
  - name: --org --organization
    summary: |-
      Azure DevOps organization URL. You can configure the default organization using az devops configure -d organization=ORG_URL. Required if not configured as default or picked up via git config. Example: `https://dev.azure.com/MyOrganizationName/`.
  - name: --project -p
    summary: |-
      Name or ID of the project. You can configure the default project using az devops configure -d project=NAME_OR_ID. Required if not configured as default or picked up via git config.
  - name: --query-order
    acceptedValues: ModifiedAsc, ModifiedDesc, NameAsc, NameDesc, None
    summary: |-
      Order of the results.
  - name: --repository
    summary: |-
      Limit results to pipelines associated with this repository.
  - name: --repository-type
    acceptedValues: bitbucket, git, github, githubenterprise, svn, tfsgit, tfsversioncontrol
    summary: |-
      Limit results to pipelines associated with this repository type. It is mandatory to pass 'repository' argument along with this argument.
  - name: --top
    summary: |-
      Maximum number of pipelines to list.
  globalParameters:
  - name: --debug
    defaultValue: "False"
    summary: |-
      Increase logging verbosity to show all debug logs.
  - name: --help -h
    summary: |-
      Show this help message and exit.
  - name: --only-show-errors
    defaultValue: "False"
    summary: |-
      Only show errors, suppressing warnings.
  - name: --output -o
    defaultValue: json
    acceptedValues: json, jsonc, none, table, tsv, yaml, yamlc
    summary: |-
      Output format.
  - name: --query
    summary: |-
      JMESPath query string. See http://jmespath.org/ for more information and examples.
  - name: --subscription
    summary: |-
      Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.
  - name: --verbose
    defaultValue: "False"
    summary: |-
      Increase logging verbosity. Use --debug for full debug logs.
- uid: az_pipelines_run
  name: az pipelines run
  summary: |-
    Queue (run) a pipeline.
  status: GA
  sourceType: Extension
  syntax: >-
    az pipelines run [--branch]
                     [--commit-id]
                     [--detect {false, true}]
                     [--folder-path]
                     [--id]
                     [--name]
                     [--open]
                     [--org --organization]
                     [--parameters]
                     [--project]
                     [--variables]
  optionalParameters:
  - name: --branch
    summary: |-
      Name of the branch on which the pipeline run is to be queued. Example: refs/heads/master or master or refs/pull/1/merge or refs/tags/tag.
  - name: --commit-id
    summary: |-
      Commit-id on which the pipeline run is to be queued.
  - name: --detect
    acceptedValues: false, true
    summary: |-
      Automatically detect organization.
  - name: --folder-path
    summary: |-
      Folder path of pipeline. Default is root level folder.
  - name: --id
    summary: |-
      ID of the pipeline to queue. Required if --name is not supplied.
  - name: --name
    summary: |-
      Name of the pipeline to queue. Ignored if --id is supplied.
  - name: --open
    defaultValue: "False"
    summary: |-
      Open the pipeline results page in your web browser.
  - name: --org --organization
    summary: |-
      Azure DevOps organization URL. You can configure the default organization using az devops configure -d organization=ORG_URL. Required if not configured as default or picked up via git config. Example: `https://dev.azure.com/MyOrganizationName/`.
  - name: --parameters
    summary: |-
      Space separated "name=value" pairs for the parameters you would like to set.
  - name: --project -p
    summary: |-
      Name or ID of the project. You can configure the default project using az devops configure -d project=NAME_OR_ID. Required if not configured as default or picked up via git config.
  - name: --variables
    summary: |-
      Space separated "name=value" pairs for the variables you would like to set.
  globalParameters:
  - name: --debug
    defaultValue: "False"
    summary: |-
      Increase logging verbosity to show all debug logs.
  - name: --help -h
    summary: |-
      Show this help message and exit.
  - name: --only-show-errors
    defaultValue: "False"
    summary: |-
      Only show errors, suppressing warnings.
  - name: --output -o
    defaultValue: json
    acceptedValues: json, jsonc, none, table, tsv, yaml, yamlc
    summary: |-
      Output format.
  - name: --query
    summary: |-
      JMESPath query string. See http://jmespath.org/ for more information and examples.
  - name: --subscription
    summary: |-
      Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.
  - name: --verbose
    defaultValue: "False"
    summary: |-
      Increase logging verbosity. Use --debug for full debug logs.
- uid: az_pipelines_show
  name: az pipelines show
  summary: |-
    Get the details of a pipeline.
  status: GA
  sourceType: Extension
  syntax: >-
    az pipelines show [--detect {false, true}]
                      [--folder-path]
                      [--id]
                      [--name]
                      [--open]
                      [--org --organization]
                      [--project]
  optionalParameters:
  - name: --detect
    acceptedValues: false, true
    summary: |-
      Automatically detect organization.
  - name: --folder-path
    summary: |-
      Folder path of pipeline. Default is root level folder.
  - name: --id
    summary: |-
      ID of the pipeline.
  - name: --name
    summary: |-
      Name of the pipeline. Ignored if --id is supplied.
  - name: --open
    defaultValue: "False"
    summary: |-
      Open the pipeline summary page in your web browser.
  - name: --org --organization
    summary: |-
      Azure DevOps organization URL. You can configure the default organization using az devops configure -d organization=ORG_URL. Required if not configured as default or picked up via git config. Example: `https://dev.azure.com/MyOrganizationName/`.
  - name: --project -p
    summary: |-
      Name or ID of the project. You can configure the default project using az devops configure -d project=NAME_OR_ID. Required if not configured as default or picked up via git config.
  globalParameters:
  - name: --debug
    defaultValue: "False"
    summary: |-
      Increase logging verbosity to show all debug logs.
  - name: --help -h
    summary: |-
      Show this help message and exit.
  - name: --only-show-errors
    defaultValue: "False"
    summary: |-
      Only show errors, suppressing warnings.
  - name: --output -o
    defaultValue: json
    acceptedValues: json, jsonc, none, table, tsv, yaml, yamlc
    summary: |-
      Output format.
  - name: --query
    summary: |-
      JMESPath query string. See http://jmespath.org/ for more information and examples.
  - name: --subscription
    summary: |-
      Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.
  - name: --verbose
    defaultValue: "False"
    summary: |-
      Increase logging verbosity. Use --debug for full debug logs.
- uid: az_pipelines_update
  name: az pipelines update
  summary: |-
    Update a pipeline.
  status: GA
  sourceType: Extension
  syntax: >-
    az pipelines update --id
                        [--branch]
                        [--description]
                        [--detect {false, true}]
                        [--new-folder-path]
                        [--new-name]
                        [--org --organization]
                        [--project]
                        [--queue-id]
                        [--yaml-path --yml-path]
  requiredParameters:
  - isRequired: true
    name: --id
    summary: |-
      Id of the pipeline to update.
  optionalParameters:
  - name: --branch
    summary: |-
      Branch name for which the pipeline will be configured.
  - name: --description
    summary: |-
      New description for the pipeline.
  - name: --detect
    acceptedValues: false, true
    summary: |-
      Automatically detect organization.
  - name: --new-folder-path
    summary: |-
      New full path of the folder to move the pipeline to. e.g. "user1/production_pipelines".
  - name: --new-name
    summary: |-
      New updated name of the pipeline.
  - name: --org --organization
    summary: |-
      Azure DevOps organization URL. You can configure the default organization using az devops configure -d organization=ORG_URL. Required if not configured as default or picked up via git config. Example: `https://dev.azure.com/MyOrganizationName/`.
  - name: --project -p
    summary: |-
      Name or ID of the project. You can configure the default project using az devops configure -d project=NAME_OR_ID. Required if not configured as default or picked up via git config.
  - name: --queue-id
    summary: |-
      Queue id of the agent pool where the pipeline needs to run.
  - name: --yaml-path --yml-path
    summary: |-
      Path of the pipelines yaml file in the repo.
  globalParameters:
  - name: --debug
    defaultValue: "False"
    summary: |-
      Increase logging verbosity to show all debug logs.
  - name: --help -h
    summary: |-
      Show this help message and exit.
  - name: --only-show-errors
    defaultValue: "False"
    summary: |-
      Only show errors, suppressing warnings.
  - name: --output -o
    defaultValue: json
    acceptedValues: json, jsonc, none, table, tsv, yaml, yamlc
    summary: |-
      Output format.
  - name: --query
    summary: |-
      JMESPath query string. See http://jmespath.org/ for more information and examples.
  - name: --subscription
    summary: |-
      Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.
  - name: --verbose
    defaultValue: "False"
    summary: |-
      Increase logging verbosity. Use --debug for full debug logs.
commands:
- az_pipelines_agent
- az_pipelines_agent_list
- az_pipelines_agent_show
- az_pipelines_build
- az_pipelines_build_cancel
- az_pipelines_build_definition
- az_pipelines_build_definition_list
- az_pipelines_build_definition_show
- az_pipelines_build_list
- az_pipelines_build_queue
- az_pipelines_build_show
- az_pipelines_build_tag
- az_pipelines_build_tag_add
- az_pipelines_build_tag_delete
- az_pipelines_build_tag_list
- az_pipelines_create
- az_pipelines_delete
- az_pipelines_folder
- az_pipelines_folder_create
- az_pipelines_folder_delete
- az_pipelines_folder_list
- az_pipelines_folder_update
- az_pipelines_list
- az_pipelines_pool
- az_pipelines_pool_list
- az_pipelines_pool_show
- az_pipelines_queue
- az_pipelines_queue_list
- az_pipelines_queue_show
- az_pipelines_release
- az_pipelines_release_create
- az_pipelines_release_definition
- az_pipelines_release_definition_list
- az_pipelines_release_definition_show
- az_pipelines_release_list
- az_pipelines_release_show
- az_pipelines_run
- az_pipelines_runs
- az_pipelines_runs_artifact
- az_pipelines_runs_artifact_download
- az_pipelines_runs_artifact_list
- az_pipelines_runs_artifact_upload
- az_pipelines_runs_list
- az_pipelines_runs_show
- az_pipelines_runs_tag
- az_pipelines_runs_tag_add
- az_pipelines_runs_tag_delete
- az_pipelines_runs_tag_list
- az_pipelines_show
- az_pipelines_update
- az_pipelines_variable
- az_pipelines_variable-group
- az_pipelines_variable-group_create
- az_pipelines_variable-group_delete
- az_pipelines_variable-group_list
- az_pipelines_variable-group_show
- az_pipelines_variable-group_update
- az_pipelines_variable-group_variable
- az_pipelines_variable-group_variable_create
- az_pipelines_variable-group_variable_delete
- az_pipelines_variable-group_variable_list
- az_pipelines_variable-group_variable_update
- az_pipelines_variable_create
- az_pipelines_variable_delete
- az_pipelines_variable_list
- az_pipelines_variable_update
metadata:
  description: This command group is a part of the azure-devops extension.