クラシック リリース パイプラインで変数を使用する

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

クラシック リリース パイプラインで変数を使用すると、パイプライン全体でデータを交換および転送するのに便利です。 各変数は文字列として格納され、その値はパイプラインの実行間で変更される可能性があります。

クラシック リリース パイプラインの各ステージでアプリケーションをデプロイするタスクを設定すると、変数が次の場合に役立ちます。

• カスタマイズの簡略化: 一般的なデプロイ パイプラインを一度定義すれば、さまざまなステージに簡単に適応できます。 たとえば、変数を使用して Web デプロイの接続文字列を表し、必要に応じて各ステージの値を調整します。 これらの変数は カスタム変数と呼ばれます。

• コンテキスト情報の活用: ステージ、成果物、またはデプロイを実行しているエージェントなど、リリース コンテキストに関する詳細にアクセスします。 たとえば、スクリプトによっては、ダウンロード用のビルド場所や、一時ファイルを作成するためのエージェントの作業ディレクトリが必要になる場合があります。 これらの変数は 、既定の変数と呼ばれます。

既定の変数

既定の変数は実行コンテキストに関する重要な情報を、実行中のタスクとスクリプトに提供します。 これらの変数を使用すると、 実行されているシステム、 リリース、 ステージ、または エージェント に関する詳細にアクセスできます。

System.Debug を除き、既定の変数は読み取り専用であり、システムは自動的に値を設定します。

最も重要な変数のいくつかを次の表に示します。 完全な一覧を確認するには、「すべての変数の現在の値を表示する」を参照してください。

システム変数

リリース変数

リリースステージ変数

エージェント変数

成果物変数を解放する

リリースで参照する成果物ごとに、次の成果物変数を使用します。 すべての変数がすべての成果物の種類に適用されるわけではないことに注意してください。 次の表に、既定の成果物変数を示し、成果物の種類に基づく値の例を示します。 例が空の場合は、変数がその成果物の種類に適用できないことを示します。

{alias} プレースホルダーを 成果物ソースエイリアス のために指定した値に置き換えるか、リリース パイプラインのために生成された既定値に置き換えてください。

主要な成果物変数

クラシック リリース パイプラインでは、複数の成果物を使用する場合は、1 つの成果物をプライマリ 成果物として指定できます。 その後、Azure Pipelines によって、指定されたプライマリ 成果物に対して次の変数が設定されます。

既定の変数の使用

既定の変数を使用する方法は 2 つあり、リリース パイプライン内のタスクのパラメーターとして使用するか、スクリプト内で使用することができます。

既定の変数をタスクへの入力として直接使用します。 たとえば、ASPNET4.CI をエイリアスとして持つ成果物の PowerShell タスクに引数としてRelease.Artifacts.{Artifact alias}.DefinitionNameを渡すには、$(Release.Artifacts.ASPNET4.CI.DefinitionName)を使用します。

スクリプトで既定の変数を使用するには、既定の変数名の . を _に置き換えます。 たとえば、Release.Artifacts.{Artifact alias}.DefinitionName をエイリアスとして持つ成果物の の値を PowerShell スクリプトで印刷するには、$env:RELEASE_ARTIFACTS_ASPNET4_CI_DEFINITIONNAME を使用します。 元のエイリアス (ASPNET4.CI) は 、ASPNET4_CIに置き換えられます。

カスタム変数

カスタム変数は、さまざまなスコープで定義できます。

• 変数グループ: 変数グループを使用して、プロジェクト内のすべての定義で値を共有します。 この方法は、プロジェクト内の定義、ステージ、タスク全体で同じ値を使用し、それらを 1 つの場所から管理する場合に便利です。 変数グループを [パイプライン]>[ライブラリ] で定義および管理します。

• リリース パイプライン変数: リリース パイプライン変数を使用して、リリース パイプライン内のすべてのステージで値を共有します。 このアプローチは、ステージとタスク間で一貫性のある値が必要なシナリオに最適で、1 つの場所から更新できます。 これらの変数は、リリース パイプラインの [変数] タブで定義および管理します。 変数を追加するときは、[パイプライン変数] ページで [範囲] ドロップダウン リストを [リリース] に設定します。

• ステージ変数: ステージ変数を使用して、リリース パイプラインの特定のステージ内で値を共有します。 この方法は、ステージごとに異なるが、ステージ内のすべてのタスクで一貫性のある値に役立ちます。 これらの変数は、リリース パイプラインの [変数] タブで定義および管理します。 変数を追加するときは、[パイプライン変数] ページで [範囲] ドロップダウン リストを適切な環境に設定します。

プロジェクト、リリース パイプライン、ステージ レベルでカスタム変数を使用すると、次のことができます。

• 値の重複を避けて、すべての出現箇所を 1 回の変更で簡単に更新できるようになります。

• ユーザーが表示したり変更したりできないようにして、機密値をセキュリティで保護します。 変数をセキュリティで保護された (シークレット) としてマークするには、変数の横にある アイコンを選択します。

  重要

  非表示の変数 (シークレット) の値はサーバーに安全に格納され、ユーザーは保存後にそれらを表示できません。 デプロイ中、Azure Pipelines は、タスクがそれらの値を参照し、セキュリティで保護された HTTPS チャネル経由でエージェントに渡すときに、これらの値を復号化します。

カスタム変数の使用

タスクでカスタム変数を使用するには、変数名をかっこで囲み、その前に $ 文字を付けます。 たとえば、 adminUserName という名前の変数がある場合は、現在の値を $(adminUserName)としてタスクに挿入します。

スクリプトで変数を定義および変更する

スクリプトから変数を定義または変更するには、task.setvariable ログ コマンドを使います。 更新された変数の値は、実行されているジョブに範囲が設定されます。そして、ジョブ間やステージ間では保持されません。 変数名は大文字に変換され、"." と " " が "_" に置き換えられます。

たとえば、Agent.WorkFolder が AGENT_WORKFOLDERになります。

• Windows では、この変数に %AGENT_WORKFOLDER% または $env:AGENT_WORKFOLDER としてアクセスします。
• Linux と macOS では、$AGENT_WORKFOLDER を使用します。

@echo ##vso[task.setvariable variable=sauce]crushed tomatoes
@echo ##vso[task.setvariable variable=secret.Sauce;issecret=true]crushed tomatoes with garlic

"$(sauce)" "$(secret.Sauce)"

@echo off
set sauceArgument=%~1
set secretSauceArgument=%~2
@echo No problem reading %sauceArgument% or %SAUCE%
@echo But I cannot read %SECRET_SAUCE%
@echo But I can read %secretSauceArgument% (but the log is redacted so I do not spoil the secret)

Write-Host "##vso[task.setvariable variable=sauce]crushed tomatoes"
Write-Host "##vso[task.setvariable variable=secret.Sauce;issecret=true]crushed tomatoes with
            garlic"

-sauceArgument "$(sauce)" -secretSauceArgument "$(secret.Sauce)"

Param(
   [string]$sauceArgument,
   [string]$secretSauceArgument
)
Write-Host No problem reading $env:SAUCE or $sauceArgument
Write-Host But I cannot read $env:SECRET_SAUCE
Write-Host But I can read $secretSauceArgument "(but the log is redacted so I do not spoil the secret)"

- pwsh: |
      Write-Host No problem reading $(sauce)
      Write-Host But I cannot read $env:SECRET_SAUCE
      Write-Host But I can read $(secret.Sauce) "(but the log is redacted so I do not spoil the secret)"

#!/bin/bash
echo "##vso[task.setvariable variable=sauce]crushed tomatoes"
echo "##vso[task.setvariable variable=secret.Sauce;issecret=true]crushed tomatoes with garlic"

"$(sauce)" "$(secret.Sauce)"

#!/bin/bash
echo "No problem reading $SAUCE"
echo "But I cannot read $SECRET_SAUCE"

変数の読み取りからのコンソール出力:

No problem reading crushed tomatoes or crushed tomatoes
But I cannot read 
But I can read ******** (but the log is redacted so I do not spoil the secret)

すべての変数の現在の値を表示する

1. [パイプライン]>[リリース] を選択します。

2. リリースの概要ビューを開き、関心のあるステージを選択します。 手順の一覧で、[ジョブの初期化] を選びます。

   

3. この手順では、ログを開きます。 下にスクロールして、エージェントがこのジョブに使用する値を確認します。

   

デバッグ モードでリリースを実行する

デバッグ モードでリリースを実行すると、リリースの実行中に追加情報を表示することで、問題の診断と解決に役立ちます。 デバッグ モードは、リリース全体に対して有効にすることも、特定のリリース ステージのタスクに対して有効にすることもできます。

• リリース全体のデバッグ モードを有効にするには、リリース パイプラインの [System.Debug] タブにtrue値を持つ という名前の変数を追加します。

• 特定のステージのデバッグ モードを有効にするには、ステージのショートカット メニューから [ステージの構成] ダイアログを開き、[System.Debug] タブに値trueという名前の変数を追加します。

• または、値 を持つ System.Debug という名前の変数を含むtrueを作成し、この変数グループをリリース パイプラインにリンクします。

AI を使用してリリース変数を設計、検証、トラブルシューティングする

次の例では、変数のスコープと優先順位を理解し、保守可能な変数戦略を設計し、現在の使用状況を検証し、必要に応じ変数解決の問題をトラブルシューティングするのに役立つCopilot Chatを求めます。 これらのプロンプトをコピーしてCopilot Chatに貼り付け、プレースホルダーをステージ、タスク、変数名に置き換えます。

Copilot では AI を利用しているため、想定外のことや間違いが起こる可能性があります。 詳細については、「Copilot一般的な使用に関する FAQを参照してください。

関連するコンテンツ

• クラシック リリース パイプラインの成果物ソース

• プル要求成果物のデプロイ

• 変数グループの変数を使用する