Azure CLI を使用してパイプラインを管理する

  • [アーティクル]

Azure DevOps Services | Azure DevOps Server 2022 | Azure DevOps Server 2020

次の az pipelines コマンドを使用して、組織内のパイプラインを管理できます。

これらのコマンドには、管理するパイプラインの名前か ID が必要です。 パイプラインの ID は、az pipelines list コマンドを使用して取得できます。

開始するには、「Azure DevOps CLI の概要」を参照してください。

パイプラインの実行

az pipelines run コマンドを使用して、既存のパイプラインをキューに登録 (実行) できます。

az pipelines run [--branch]
                 [--commit-id]
                 [--folder-path]
                 [--id]
                 [--name]
                 [--open]
                 [--org]
                 [--project]
                 [--variables]

パラメーター

  • branch: パイプラインの実行がキューに登録されるブランチの名前。たとえば、refs/heads/main。
  • commit-id: パイプラインの実行をキューに登録するコミット ID。
  • folder-path: パイプラインのフォルダー パス。 既定では、ルート レベルのフォルダーです。
  • id: name が指定されていない場合は必須。 キューに入るパイプラインの ID です。
  • name: ID が指定されていない場合は必須ですが、ID が指定されている場合は無視されます。 キューに登録するパイプラインの名前です。
  • open: Web ブラウザーでパイプラインの結果ページを開きます。
  • org: Azure DevOps 組織の URL。 az devops configure -d organization=ORG_URL を使用して、既定の組織を構成できます。 既定として設定されていない場合、または git config を使用して取得された場合は必須です。 例: --org https://dev.azure.com/MyOrganizationName/.
  • project: プロジェクトの名前または ID。 az devops configure -d project=NAME_OR_ID を使用して、既定のプロジェクトを構成できます。 既定として設定されていない場合、または git config を使用して取得された場合は必須です。
  • variables: 設定する変数の、スペースで区切られた "name=value" のペア。

例

次のコマンドは、ブランチ pipeline の myGithubname.pipelines-java という名前のパイプラインを実行し、結果を表形式で表示します。

az pipelines run --name myGithubname.pipelines-java --branch pipeline --output table

Run ID    Number      Status      Result    Pipeline ID    Pipeline Name                Source Branch    Queued Time               Reason
--------  ----------  ----------  --------  -------------  ---------------------------  ---------------  --------------------------  --------
123       20200123.2  notStarted            12             myGithubname.pipelines-java  pipeline           2020-01-23 11:55:56.633450  manual

パイプラインを更新する

既存のパイプラインは、az pipelines update コマンドを使用して更新できます。 開始するには、「Azure DevOps CLI の概要」を参照してください。

az pipelines update [--branch]
                    [--description]
                    [--id]
                    [--name]
                    [--new-folder-path]
                    [--new-name]
                    [--org]
                    [--project]
                    [--queue-id]
                    [--yaml-path]

パラメーター

  • branch: パイプラインの実行が構成されるブランチの名前。たとえば、refs/heads/main。
  • description: パイプラインの新しい説明。
  • id: name が指定されていない場合は必須。 更新するパイプラインの ID です。
  • name: ID が指定されていない場合は必須。 更新するパイプラインの名前です。
  • new-folder-path: パイプラインの移動先フォルダーの新しい完全パス。たとえば、user1/production_pipelines。
  • new-name: パイプラインの更新された新しい名前。
  • org: Azure DevOps 組織の URL。 az devops configure -d organization=ORG_URL を使用して、既定の組織を構成できます。 既定として設定されていない場合、または git config を使用して取得された場合は必須です。 例: --org https://dev.azure.com/MyOrganizationName/.
  • project: プロジェクトの名前または ID。 az devops configure -d project=NAME_OR_ID を使用して、既定のプロジェクトを構成できます。 既定として設定されていない場合、または git config を使用して取得された場合は必須です。
  • queue-id: パイプラインを実行する必要があるエージェント プールのキュー ID。
  • yaml-path: リポジトリ内のパイプラインの yaml ファイルのパス。

グローバル パラメーターには、debug、help、only-show-errors、query、output、および verbose が含まれています。

ヒント

--output などのグローバル パラメーターも使用できます。 --output パラメーターは、すべてのコマンドで使用できます。 table 値を指定すると、出力がわかりやすい形式で表示されます。 詳細については、「Azure CLI コマンドの出力形式」をご覧ください。

例

次のコマンドは、ID が 12 のパイプラインを新しい名前と説明で更新し、結果を表形式で表示します。

az pipelines update --id 12 --description "rename pipeline" --new-name updatedname.pipelines-java --output table

ID    Name                        Status    Default Queue
----  --------------------------  --------  ------------------
12    updatedname.pipelines-java  enabled   Hosted Ubuntu 1604

パイプラインを表示する

既存のパイプラインの詳細は、az pipelines show コマンドを使用して表示できます。 開始するには、「Azure DevOps CLI の概要」を参照してください。

az pipelines show [--folder-path]
                  [--id]
                  [--name]
                  [--open]
                  [--org]
                  [--project]
                  [--query-examples]
                  [--subscription]

パラメーター

  • folder-path: パイプラインのフォルダー パス。 既定では、ルート レベルのフォルダーです。
  • id: name が指定されていない場合は必須。 詳細を表示するパイプラインの ID です。
  • name: name が指定されていない場合は必須ですが、ID が指定されている場合は無視されます。 詳細を表示するパイプラインの名前です。
  • open: Web ブラウザーでパイプラインの概要ページを開きます。
  • org: Azure DevOps 組織の URL。 az devops configure -d organization=ORG_URL を使用して、既定の組織を構成できます。 既定として設定されていない場合、または git config を使用して取得された場合は必須です。 例: --org https://dev.azure.com/MyOrganizationName/.
  • project: プロジェクトの名前または ID。 az devops configure -d project=NAME_OR_ID を使用して、既定のプロジェクトを構成できます。 既定として設定されていない場合、または git config を使用して取得された場合は必須です。
  • query examples: JMESPath 文字列をお勧めします。
  • subscription: サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

例

次のコマンドは、ID が 12 のパイプラインの詳細を表示し、結果を表形式で返します。

az pipelines show --id 12 --output table

ID    Name                        Status    Default Queue
----  --------------------------  --------  ------------------
12    updatedname.pipelines-java  enabled   Hosted Ubuntu 1604

次のステップ

パイプラインをカスタマイズできます。または、任意の言語でパイプラインを設定する方法の詳細を確認できます。

よく寄せられる質問

ビルド パイプラインをプログラムで作成するにはどうすればよいですか。

REST API リファレンス: ビルド パイプラインを作成する

注意

Azure Pipelines CLI を使用して、コマンド ラインまたはスクリプトからビルドおよびビルド パイプラインを管理することもできます。

1 つのコマンドを使用して、Azure DevOps Services で複数のパイプラインを実行できますか。

今のところ、Azure CLI と Azure API には、コマンドラインから複数のパイプラインを実行するコマンドは用意されていません。 Azure CLI コマンドを使用して、すべてのパイプラインと定義をリストできます。また、単一のリリースまたはビルド ID をパラメーターとして指定できます。 すべてのコマンドは、独立したパイプラインの独立した実行で動作するように設計されており、1 つの一意の値のみを許可する一意の ID 要求が必要です。 パイプライン トリガーの詳細については、「パイプラインをトリガーするイベントの指定」を参照してください。