az pipelines
Note
このリファレンスは、Azure CLI (バージョン 2.30.0 以降) の azure-devops 拡張機能の一部です。 拡張機能は、az pipelines コマンドを初めて実行するときに自動的にインストールされます。 拡張機能の詳細をご覧ください。
Azure Pipelines を管理します。
このコマンド グループは、azure-devops 拡張機能の一部です。
コマンド
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 masterGithub 組織 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]必須のパラメーター
新しいパイプラインの名前。
省略可能のパラメーター
パイプラインを構成するブランチ名。 省略すると、ローカル リポジトリから自動検出されます。
新しいパイプラインの説明。
組織を自動的に検出します。
パイプラインを作成する必要があるフォルダーのパス。 既定値はルート フォルダーです。 例: "user1/test_pipelines"。
Azure DevOps 組織の URL。 az devops configure -d organization=ORG_URL を使って既定の組織を構成できます。 既定として構成されていない場合、または git config を使って取得されていない場合は必須です (例: https://dev.azure.com/MyOrganizationName/)。
プロジェクトの名前または ID。 az devops configure -d project=NAME_OR_ID を使用して、既定のプロジェクトを構成できます。 既定として構成されていない場合、または git 構成を使用して取得された場合は必須です。
使用可能なエージェント プール内のキューの ID。 指定されていない場合は自動検出されます。
パイプラインを構成する必要があるリポジトリ。 GitHub リポジトリの場合は、Git リポジトリの複製 URL または Azure Repos または Owner/RepoName のリポジトリの名前を指定できます。 省略すると、ローカル Git リポジトリのリモート URL から自動検出されます。 url ではなく名前がメンションされている場合は、--repository-type 引数も必要です。
リポジトリの種類。 省略すると、ローカル リポジトリのリモート URL から自動検出されます。 Azure Repos の場合は 'tfsgit'、GitHub リポジトリの場合は 'github' です。
GitHub リポジトリのリポジトリ用に作成されたサービス接続の ID。 service_connectionsの作成/一覧表示には、コマンド az devops service-endpoint -h を使用します。 Azure Repos には必要ありません。
コマンドによって最初の実行がトリガーされないようにするには、このフラグを指定します。 実行がスキップされた場合、コマンドはパイプラインを返します。そうしないと、パイプラインの実行が出力されます。
リポジトリ内のパイプライン yaml ファイルのパス (リポジトリに yaml が既に存在する場合)。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az pipelines delete
パイプラインを削除します。
az pipelines delete --id
[--detect {false, true}]
[--org]
[--project]
[--yes]必須のパラメーター
パイプラインの ID。
省略可能のパラメーター
組織を自動的に検出します。
Azure DevOps 組織の URL。 az devops configure -d organization=ORG_URL を使って既定の組織を構成できます。 既定として構成されていない場合、または git config を使って取得されていない場合は必須です (例: https://dev.azure.com/MyOrganizationName/)。
プロジェクトの名前または ID。 az devops configure -d project=NAME_OR_ID を使用して、既定のプロジェクトを構成できます。 既定として構成されていない場合、または git 構成を使用して取得された場合は必須です。
確認のダイアログを表示しません。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --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]省略可能のパラメーター
組織を自動的に検出します。
指定した場合は、このフォルダーの下にある定義にフィルター処理します。
この名前またはこの名前で始まるパイプラインに結果を制限します。 例: "FabCI" または "Fab*"。
Azure DevOps 組織の URL。 az devops configure -d organization=ORG_URL を使って既定の組織を構成できます。 既定として構成されていない場合、または git config を使って取得されていない場合は必須です (例: https://dev.azure.com/MyOrganizationName/)。
プロジェクトの名前または ID。 az devops configure -d project=NAME_OR_ID を使用して、既定のプロジェクトを構成できます。 既定として構成されていない場合、または git 構成を使用して取得された場合は必須です。
結果の順序。
このリポジトリに関連付けられているパイプラインに結果を制限します。
このリポジトリの種類に関連付けられているパイプラインに結果を制限します。 この引数と共に 'repository' 引数を渡すことが必須です。
一覧表示するパイプラインの最大数。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az pipelines run
パイプラインをキュー (実行) します。
az pipelines run [--branch]
[--commit-id]
[--detect {false, true}]
[--folder-path]
[--id]
[--name]
[--open]
[--org]
[--parameters]
[--project]
[--variables]省略可能のパラメーター
パイプラインの実行がキューに格納されるブランチの名前。 例: refs/heads/master、master、refs/pull/1/merge、refs/tags/tag。
パイプラインの実行がキューに格納されるコミット ID。
組織を自動的に検出します。
パイプラインのフォルダー パス。 既定では、ルート レベルのフォルダーです。
キューに入るパイプラインの ID です。 --name が指定されていない場合は必須です。
キューに登録するパイプラインの名前です。 --id が指定されている場合は無視されます。
Web ブラウザーでパイプラインの結果ページを開きます。
Azure DevOps 組織の URL。 az devops configure -d organization=ORG_URL を使って既定の組織を構成できます。 既定として構成されていない場合、または git config を使って取得されていない場合は必須です (例: https://dev.azure.com/MyOrganizationName/)。
設定するパラメーターのスペース区切りの "name=value" ペア。
プロジェクトの名前または ID。 az devops configure -d project=NAME_OR_ID を使用して、既定のプロジェクトを構成できます。 既定として構成されていない場合、または git 構成を使用して取得された場合は必須です。
設定する変数のスペース区切りの "name=value" ペア。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az pipelines show
パイプラインの詳細を取得します。
az pipelines show [--detect {false, true}]
[--folder-path]
[--id]
[--name]
[--open]
[--org]
[--project]省略可能のパラメーター
組織を自動的に検出します。
パイプラインのフォルダー パス。 既定では、ルート レベルのフォルダーです。
パイプラインの ID。
パイプラインの名前。 --id が指定されている場合は無視されます。
Web ブラウザーでパイプラインの概要ページを開きます。
Azure DevOps 組織の URL。 az devops configure -d organization=ORG_URL を使って既定の組織を構成できます。 既定として構成されていない場合、または git config を使って取得されていない場合は必須です (例: https://dev.azure.com/MyOrganizationName/)。
プロジェクトの名前または ID。 az devops configure -d project=NAME_OR_ID を使用して、既定のプロジェクトを構成できます。 既定として構成されていない場合、または git 構成を使用して取得された場合は必須です。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --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。
省略可能のパラメーター
パイプラインを構成するブランチ名。
パイプラインの新しい説明。
組織を自動的に検出します。
パイプラインの移動先となるフォルダーの新しい完全パス。例: "user1/production_pipelines"。
パイプラインの新しい更新された名前。
Azure DevOps 組織の URL。 az devops configure -d organization=ORG_URL を使って既定の組織を構成できます。 既定として構成されていない場合、または git config を使って取得されていない場合は必須です (例: https://dev.azure.com/MyOrganizationName/)。
プロジェクトの名前または ID。 az devops configure -d project=NAME_OR_ID を使用して、既定のプロジェクトを構成できます。 既定として構成されていない場合、または git 構成を使用して取得された場合は必須です。
パイプラインを実行する必要があるエージェント プールのキュー ID。
リポジトリ内のパイプライン yaml ファイルのパス。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
Azure CLI