az pipelines

Note

このリファレンスは、Azure CLI (バージョン 2.30.0 以降) の azure-devops 拡張機能の一部です。 拡張機能は、az pipelines コマンドを初めて実行するときに自動的にインストールされます。 拡張機能の詳細をご覧ください。

Azure Pipelines を管理します。

このコマンド グループは、azure-devops 拡張機能の一部です。

コマンド

名前 説明 Status
az pipelines agent

エージェントを管理します。

拡張 GA
az pipelines agent list

プール内のエージェントの一覧を取得します。

拡張 GA
az pipelines agent show

エージェントの詳細を表示します。

拡張 GA
az pipelines build

ビルドを管理します。

拡張 GA
az pipelines build cancel

ビルドが実行されている場合はキャンセルします。

拡張 GA
az pipelines build definition

ビルド定義を管理します。

拡張 GA
az pipelines build definition list

ビルド定義を一覧表示します。

拡張 GA
az pipelines build definition show

ビルド定義の詳細を取得します。

拡張 GA
az pipelines build list

ビルド結果を一覧表示します。

拡張 GA
az pipelines build queue

ビルドを要求 (キュー) します。

拡張 GA
az pipelines build show

ビルドの詳細を取得します。

拡張 GA
az pipelines build tag

ビルド タグを管理します。

拡張 GA
az pipelines build tag add

ビルドのタグを追加します。

拡張 GA
az pipelines build tag delete

ビルド タグを削除します。

拡張 GA
az pipelines build tag list

ビルドのタグを取得します。

拡張 GA
az pipelines create

新しい Azure Pipeline (YAML ベース) を作成します。

拡張 GA
az pipelines delete

パイプラインを削除します。

拡張 GA
az pipelines folder

パイプラインを整理するためのフォルダーを管理します。

拡張 GA
az pipelines folder create

フォルダーを作成します。

拡張 GA
az pipelines folder delete

フォルダーを削除します。

拡張 GA
az pipelines folder list

すべてのフォルダーを一覧表示します。

拡張 GA
az pipelines folder update

フォルダー名または説明を更新します。

拡張 GA
az pipelines list

パイプラインを一覧表示します。

拡張 GA
az pipelines pool

エージェント プールを管理します。

拡張 GA
az pipelines pool list

エージェント プールを一覧表示します。

拡張 GA
az pipelines pool show

エージェント プールの詳細を表示します。

拡張 GA
az pipelines queue

エージェント キューを管理します。

拡張 GA
az pipelines queue list

エージェント キューを一覧表示します。

拡張 GA
az pipelines queue show

エージェント キューの詳細を表示します。

拡張 GA
az pipelines release

リリースを管理します。

拡張 GA
az pipelines release create

リリースを要求 (作成) します。

拡張 GA
az pipelines release definition

リリース定義を管理します。

拡張 GA
az pipelines release definition list

リリース定義を一覧表示します。

拡張 GA
az pipelines release definition show

リリース定義の詳細を取得します。

拡張 GA
az pipelines release list

リリース結果を一覧表示します。

拡張 GA
az pipelines release show

リリースの詳細を取得します。

拡張 GA
az pipelines run

パイプラインをキュー (実行) します。

拡張 GA
az pipelines runs

パイプライン実行を管理します。

拡張 GA
az pipelines runs artifact

パイプライン実行の成果物を管理します。

拡張 GA
az pipelines runs artifact download

パイプライン成果物をダウンロードします。

拡張 GA
az pipelines runs artifact list

実行に関連付けられている成果物を一覧表示します。

拡張 GA
az pipelines runs artifact upload

パイプライン成果物をアップロードします。

拡張 GA
az pipelines runs list

プロジェクト内のパイプラインの実行を一覧表示します。

拡張 GA
az pipelines runs show

パイプラインの実行の詳細を表示します。

拡張 GA
az pipelines runs tag

パイプライン実行のタグを管理します。

拡張 GA
az pipelines runs tag add

パイプライン実行のタグを追加します。

拡張 GA
az pipelines runs tag delete

パイプライン実行タグを削除します。

拡張 GA
az pipelines runs tag list

パイプライン実行のタグを取得します。

拡張 GA
az pipelines show

パイプラインの詳細を取得します。

拡張 GA
az pipelines update

パイプラインを更新します。

拡張 GA
az pipelines variable

パイプライン変数を管理します。

拡張 GA
az pipelines variable-group

変数グループを管理します。

拡張 GA
az pipelines variable-group create

変数グループを作成します。

拡張 GA
az pipelines variable-group delete

変数グループを削除します。

拡張 GA
az pipelines variable-group list

変数グループを一覧表示します。

拡張 GA
az pipelines variable-group show

変数グループの詳細を表示します。

拡張 GA
az pipelines variable-group update

変数グループを更新します。

拡張 GA
az pipelines variable-group variable

変数グループ内の変数を管理します。

拡張 GA
az pipelines variable-group variable create

変数グループに変数を追加します。

拡張 GA
az pipelines variable-group variable delete

変数グループから変数を削除します。

拡張 GA
az pipelines variable-group variable list

変数グループ内の変数を一覧表示します。

拡張 GA
az pipelines variable-group variable update

変数グループ内の変数を更新します。

拡張 GA
az pipelines variable create

パイプラインに変数を追加します。

拡張 GA
az pipelines variable delete

パイプラインから変数を削除します。

拡張 GA
az pipelines variable list

パイプライン内の変数を一覧表示します。

拡張 GA
az pipelines variable update

パイプライン内の変数を更新します。

拡張 GA

az pipelines create

新しい Azure Pipeline (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]

ローカル チェックアウト リポジトリ コンテキストから Azure Pipeline を作成する

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'

クローン URL を使用して Github でホストされているリポジトリの Azure Pipeline を作成する

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

Github 組織 SampleOrg でホストされているリポジトリの Azure Pipeline を作成する(リポジトリ名 SampleRepo)

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

同じプロジェクト内の Azure Repo でホストされているリポジトリの Azure Pipeline を作成する

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

既にリポジトリにパイプライン yaml がチェックされているリポジトリ用の Azure Pipeline を作成する

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]

必須のパラメーター

--name

新しいパイプラインの名前。

省略可能のパラメーター

--branch

パイプラインを構成するブランチ名。 省略すると、ローカル リポジトリから自動検出されます。

--description

新しいパイプラインの説明。

--detect

組織を自動的に検出します。

承認された値: false, true
--folder-path

パイプラインを作成する必要があるフォルダーのパス。 既定値はルート フォルダーです。 例: "user1/test_pipelines"。

--org --organization

Azure DevOps 組織の URL。 az devops configure -d organization=ORG_URL を使って既定の組織を構成できます。 既定として構成されていない場合、または git config を使って取得されていない場合は必須です (例: https://dev.azure.com/MyOrganizationName/)。

--project -p

プロジェクトの名前または ID。 az devops configure -d project=NAME_OR_ID を使用して、既定のプロジェクトを構成できます。 既定として構成されていない場合、または git 構成を使用して取得された場合は必須です。

--queue-id

使用可能なエージェント プール内のキューの ID。 指定されていない場合は自動検出されます。

--repository

パイプラインを構成する必要があるリポジトリ。 GitHub リポジトリの場合は、Git リポジトリの複製 URL または Azure Repos または Owner/RepoName のリポジトリの名前を指定できます。 省略すると、ローカル Git リポジトリのリモート URL から自動検出されます。 url ではなく名前がメンションされている場合は、--repository-type 引数も必要です。

--repository-type

リポジトリの種類。 省略すると、ローカル リポジトリのリモート URL から自動検出されます。 Azure Repos の場合は 'tfsgit'、GitHub リポジトリの場合は 'github' です。

承認された値: github, tfsgit
--service-connection

GitHub リポジトリのリポジトリ用に作成されたサービス接続の ID。 service_connectionsの作成/一覧表示には、コマンド az devops service-endpoint -h を使用します。 Azure Repos には必要ありません。

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

コマンドによって最初の実行がトリガーされないようにするには、このフラグを指定します。 実行がスキップされた場合、コマンドはパイプラインを返します。そうしないと、パイプラインの実行が出力されます。

承認された値: false, true
--yaml-path --yml-path

リポジトリ内のパイプライン yaml ファイルのパス (リポジトリに yaml が既に存在する場合)。

グローバル パラメーター
--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc
既定値: json
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az pipelines delete

パイプラインを削除します。

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

必須のパラメーター

--id

パイプラインの ID。

省略可能のパラメーター

--detect

組織を自動的に検出します。

承認された値: false, true
--org --organization

Azure DevOps 組織の URL。 az devops configure -d organization=ORG_URL を使って既定の組織を構成できます。 既定として構成されていない場合、または git config を使って取得されていない場合は必須です (例: https://dev.azure.com/MyOrganizationName/)。

--project -p

プロジェクトの名前または ID。 az devops configure -d project=NAME_OR_ID を使用して、既定のプロジェクトを構成できます。 既定として構成されていない場合、または git 構成を使用して取得された場合は必須です。

--yes -y

確認のダイアログを表示しません。

既定値: False
グローバル パラメーター
--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc
既定値: json
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az pipelines list

パイプラインを一覧表示します。

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]

省略可能のパラメーター

--detect

組織を自動的に検出します。

承認された値: false, true
--folder-path

指定した場合は、このフォルダーの下にある定義にフィルター処理します。

--name

この名前またはこの名前で始まるパイプラインに結果を制限します。 例: "FabCI" または "Fab*"。

--org --organization

Azure DevOps 組織の URL。 az devops configure -d organization=ORG_URL を使って既定の組織を構成できます。 既定として構成されていない場合、または git config を使って取得されていない場合は必須です (例: https://dev.azure.com/MyOrganizationName/)。

--project -p

プロジェクトの名前または ID。 az devops configure -d project=NAME_OR_ID を使用して、既定のプロジェクトを構成できます。 既定として構成されていない場合、または git 構成を使用して取得された場合は必須です。

--query-order

結果の順序。

承認された値: ModifiedAsc, ModifiedDesc, NameAsc, NameDesc, None
--repository

このリポジトリに関連付けられているパイプラインに結果を制限します。

--repository-type

このリポジトリの種類に関連付けられているパイプラインに結果を制限します。 この引数と共に 'repository' 引数を渡すことが必須です。

承認された値: bitbucket, git, github, githubenterprise, svn, tfsgit, tfsversioncontrol
--top

一覧表示するパイプラインの最大数。

グローバル パラメーター
--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc
既定値: json
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az pipelines run

パイプラインをキュー (実行) します。

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

省略可能のパラメーター

--branch

パイプラインの実行がキューに格納されるブランチの名前。 例: refs/heads/master、master、refs/pull/1/merge、refs/tags/tag。

--commit-id

パイプラインの実行がキューに格納されるコミット ID。

--detect

組織を自動的に検出します。

承認された値: false, true
--folder-path

パイプラインのフォルダー パス。 既定では、ルート レベルのフォルダーです。

--id

キューに入るパイプラインの ID です。 --name が指定されていない場合は必須です。

--name

キューに登録するパイプラインの名前です。 --id が指定されている場合は無視されます。

--open

Web ブラウザーでパイプラインの結果ページを開きます。

既定値: False
--org --organization

Azure DevOps 組織の URL。 az devops configure -d organization=ORG_URL を使って既定の組織を構成できます。 既定として構成されていない場合、または git config を使って取得されていない場合は必須です (例: https://dev.azure.com/MyOrganizationName/)。

--parameters

設定するパラメーターのスペース区切りの "name=value" ペア。

--project -p

プロジェクトの名前または ID。 az devops configure -d project=NAME_OR_ID を使用して、既定のプロジェクトを構成できます。 既定として構成されていない場合、または git 構成を使用して取得された場合は必須です。

--variables

設定する変数のスペース区切りの "name=value" ペア。

グローバル パラメーター
--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc
既定値: json
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az pipelines show

パイプラインの詳細を取得します。

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

省略可能のパラメーター

--detect

組織を自動的に検出します。

承認された値: false, true
--folder-path

パイプラインのフォルダー パス。 既定では、ルート レベルのフォルダーです。

--id

パイプラインの ID。

--name

パイプラインの名前。 --id が指定されている場合は無視されます。

--open

Web ブラウザーでパイプラインの概要ページを開きます。

既定値: False
--org --organization

Azure DevOps 組織の URL。 az devops configure -d organization=ORG_URL を使って既定の組織を構成できます。 既定として構成されていない場合、または git config を使って取得されていない場合は必須です (例: https://dev.azure.com/MyOrganizationName/)。

--project -p

プロジェクトの名前または ID。 az devops configure -d project=NAME_OR_ID を使用して、既定のプロジェクトを構成できます。 既定として構成されていない場合、または git 構成を使用して取得された場合は必須です。

グローバル パラメーター
--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc
既定値: json
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az pipelines update

パイプラインを更新します。

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

必須のパラメーター

--id

更新するパイプラインの ID。

省略可能のパラメーター

--branch

パイプラインを構成するブランチ名。

--description

パイプラインの新しい説明。

--detect

組織を自動的に検出します。

承認された値: false, true
--new-folder-path

パイプラインの移動先となるフォルダーの新しい完全パス。例: "user1/production_pipelines"。

--new-name

パイプラインの新しい更新された名前。

--org --organization

Azure DevOps 組織の URL。 az devops configure -d organization=ORG_URL を使って既定の組織を構成できます。 既定として構成されていない場合、または git config を使って取得されていない場合は必須です (例: https://dev.azure.com/MyOrganizationName/)。

--project -p

プロジェクトの名前または ID。 az devops configure -d project=NAME_OR_ID を使用して、既定のプロジェクトを構成できます。 既定として構成されていない場合、または git 構成を使用して取得された場合は必須です。

--queue-id

パイプラインを実行する必要があるエージェント プールのキュー ID。

--yaml-path --yml-path

リポジトリ内のパイプライン yaml ファイルのパス。

グローバル パラメーター
--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc
既定値: json
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。