Azure Pipelines の YAML スキーマ リファレンス
Azure Pipelines の YAML スキーマ リファレンスは、サポートされているすべての YAML 構文とその使用可能なオプションを示す YAML パイプラインの詳細なリファレンスです。
YAML パイプラインを作成するには、パイプライン 定義から始めます。 YAML パイプラインの構築の詳細については、「パイプラインをカスタマイズする」を参照してください。
YAML スキーマ参照には、タスクは含まれません。 タスクの詳細については、Azure Pipelines タスクのインデックスを参照してください。
定義
を拡張する
テンプレートを使用してパイプラインを拡張します。
ジョブをする
ステージの作業を構成するジョブを指定します。
jobs.deploymentの
配置ジョブは特殊な種類のジョブです。 これは、環境に対して順番に実行する手順のコレクションです。
jobs.deployment.environmentをする
ターゲット環境名と、必要に応じてデプロイ履歴を記録するリソース名。format: environment-name.resource-name。
jobs.deployment.strategyをする
このデプロイの実行戦略です。
jobs.deployment.strategy.canaryをする
カナリアデプロイ戦略 します。
jobs.deployment.strategy.rollingをする
ローリング デプロイ戦略を します。
jobs.deployment.strategy.runOnce
RunOnce 配置戦略 します。
jobs.jobをする
ジョブは、エージェントまたはサーバーで実行されるステップのコレクションです。
jobs.job.containerをする
コンテナー リソース名を します。
jobs.job.strategyをする
このジョブの実行戦略を します。
jobs.job.uses
まだ参照されていない、このジョブで必要なリソース。
jobs.templateをする
テンプレートで定義されているジョブのセット。
パラメーターをする
パイプラインに渡されるランタイム パラメーターを指定します。
parameters.parameterをする
パイプライン テンプレート パラメーターを します。
プールの
パイプラインのジョブに使用するプールを指定します。
pool.demands
要求 (プライベート プールの場合)。
pr
pull request トリガーを します。
リソースをする
リソースは、ビルド、リポジトリ、パイプライン、およびパイプラインで使用されるその他のリソースを指定します。
resources.builds
パイプラインによって参照されるビルド リソースの一覧です。
resources.builds.build
実行から成果物を参照するために使用されるビルド リソースです。
resources.containers
コンテナー イメージの一覧。
resources.containers.containerをする
コンテナー イメージを参照するために使用されるコンテナー リソースです。
resources.containers.container.triggerをする
無効にするには none を指定し、すべてのイメージ タグでトリガーする場合は true を指定するか、次の例で説明するように完全な構文を使用します。
resources.packages
パッケージ リソースの一覧。
resources.packages.package
NuGet または npm GitHub パッケージの参照に使用されるパッケージ リソースです。
resources.pipelines
パイプライン リソースの一覧。
resources.pipelines.pipelineをする
パイプライン リソースを します。
resources.pipelines.pipeline.triggerをする
無効にするには none を指定し、すべての分岐を含める場合は true を指定するか、次の例で説明するように完全な構文を使用します。
resources.pipelines.pipeline.trigger.branchs
実行をトリガーするために含める、または除外するブランチを します。
resources.repositories
リポジトリ リソースの一覧。
resources.repositories.repositoryをする
リポジトリ リソースは、パイプライン内の追加のリポジトリを参照するために使用されます。
resources.webhooks
Webhook の一覧。
resources.webhooks.webhook
Webhook リソースを使用すると、パイプラインを外部サービスと統合してワークフローを自動化できます。
resources.webhooks.webhook.filters
トリガー フィルターの一覧。
resources.webhooks.webhook.filters.filterをする
Webhook リソース トリガー フィルターを します。
スケジュールをする
スケジュールの一覧では、パイプラインのスケジュールされたトリガーを指定します。
schedules.cron
スケジュールされたトリガーは、ブランチを構築するスケジュールを指定します。
ステージ
ステージは、関連するジョブのコレクションです。
stage.stage
ステージは、関連するジョブのコレクションです。
stages.template
1 つのファイルにステージのセットを定義し、他のファイルで複数回使用できます。
手順
ステップは、ジョブを構成する操作の線形シーケンスです。
steps.bash
Bash on Windows、macOS、Linux でスクリプトを実行します。
steps.checkout
パイプラインがソース コードをチェックアウトする方法を構成します。
steps.download
現在の実行に関連付けられている成果物、またはパイプライン リソースとして関連付けられている別の Azure Pipeline から成果物をダウンロードします。
steps.downloadBuild
ビルド成果物をダウンロードします。
steps.getPackage
Azure Artifacts または Azure DevOps Server のパッケージ管理フィードからパッケージをダウンロードします。
steps.powershell
Windows PowerShell (windows) または pwsh (Linux および macOS) を使用してスクリプトを実行します。
steps.publish
他のジョブやパイプラインで使用できるパイプライン成果物としてファイルまたはフォルダーを発行 (アップロード) します。
steps.pwshをする
Windows、macOS、Linux の PowerShell Core でスクリプトを実行します。
steps.reviewApp
ダウンロードでは、デプロイ フェーズ プロバイダーの下にリソースが動的に作成されます。
steps.script
Windows 上の cmd.exe と他のプラットフォームの Bash を使用してスクリプトを実行します。
steps.task
タスクを実行します。
steps.template
1 つのファイルに一連のステップを定義し、別のファイルで複数回使用します。
ターゲットをする
タスクは、実行コンテキスト (エージェント ホストまたはコンテナー) で実行されます。
target.settableVariablesをする
設定できる変数に関する制限事項です。
トリガーの
継続的インテグレーション (プッシュ) トリガーを します。
変数
名前と値のペアを使用して変数を定義します。
variables.groupをする
変数グループから変数を参照します。
variables.name
名前と完全な構文を使用して変数を定義します。
variables.templateをする
テンプレート内の変数を定義します。
定義のサポート
注
サポート定義は、パイプラインで直接使用するためのものではありません。 サポート定義は、他の定義の一部としてのみ使用され、参照のためにここに含まれています。
deployHookをする
アプリケーションをデプロイする手順を実行するために使用します。
includeExcludeFiltersをする
含める項目または除外する項目のリスト。
includeExcludeStringFiltersをする
含める項目または除外する項目を します。
mountReadOnlyをする
読み取り専用をマウントするボリューム 、既定値はすべて false です。
onFailureHookをする
ロールバック アクションまたはクリーンアップの手順を実行するために使用されます。
onSuccessHookをする
ロールバック アクションまたはクリーンアップの手順を実行するために使用されます。
onSuccessOrFailureHookをする
ロールバック アクションまたはクリーンアップの手順を実行するために使用されます。
postRouteTrafficHookをする
トラフィックのルーティング後に手順を実行するために使用されます。 通常、これらのタスクは、定義された間隔で更新されたバージョンの正常性を監視します。
preDeployHookをする
アプリケーションのデプロイを開始する前にリソースを初期化する手順を実行するために使用されます。
routeTrafficHookをする
更新されたバージョンへのトラフィックを処理するステップを実行するために使用されます。
ワークスペースをする
エージェントの [ワークスペース] オプションを します。
YAML スキーマのドキュメント規則
YAML スキーマ リファレンスは、Azure Pipelines YAML パイプラインの詳細なリファレンス ガイドです。 これには、サポートされているすべての YAML 機能と使用可能なオプションのカタログが含まれています。
YAML スキーマ リファレンスで使用される構文規則を次に示します。
-
:の左側には、パイプライン定義で使用されるリテラル キーワードがあります。 -
:の右側にはデータ型があります。 データ型には、文字列 などのプリミティブ型や、この参照の他の場所で定義されているリッチ構造体への参照を指定できます。 - データ型
][表記は、前述の定義型の配列を示します。 たとえば、[ string ]は文字列の配列です。 - データ型
{:データ型}の表記は、あるデータ型から別のデータ型へのマッピングを示します。 たとえば、{ string: string }は文字列と文字列のマッピングです。 - シンボル
|は、キーワードに使用できる複数のデータ型があることを示します。 たとえば、job | templateは、ジョブ定義またはテンプレート参照が許可されていることを意味します。
こちらもご覧ください
このリファレンスでは、Azure Pipelines YAML ファイルのスキーマについて説明します。
YAML の基本については、「Y 分 で YAML を学習するを参照してください。
Azure Pipelines では、すべての YAML 機能がサポートされているわけではありません。
サポートされていない機能には、アンカー、複雑なキー、セットが含まれます。
また、Azure Pipelines は、標準の YAML とは異なり、マッピングの最初のキーとして stage、job、task、またはタスク ショートカット (script など) を確認する必要があります。