変数の定義

最も一般的なケースでは、変数を設定し、YAML ファイル内でそれらを使用します。 これにより、バージョン コントロール システムで変数への変更を追跡できます。 パイプライン設定 UI で変数を定義し ([クラシック] タブを参照)、YAML で参照することもできます。

2 つの変数 configuration と platform を設定し、後のステップで使用する方法を次に示します。 YAML ステートメントで変数を使用するには、 $()でラップします。 変数を使用して YAML ステートメントで repository を定義することはできません。

# Set variables once
variables:
  configuration: debug
  platform: x64

steps:

# Use them once
- task: MSBuild@1
  inputs:
    solution: solution1.sln
    configuration: $(configuration) # Use the variable
    platform: $(platform)

# Use them again
- task: MSBuild@1
  inputs:
    solution: solution2.sln
    configuration: $(configuration) # Use the variable
    platform: $(platform)

変数スコープ

YAML ファイルでは、さまざまなスコープで変数を設定できます。

• ルート レベルで、パイプライン内のすべてのジョブで使用できるようにします。
• ステージ レベルでは、特定のステージでのみ使用できるようにします。
• ジョブ レベルでは、特定のジョブでのみ使用できるようにします。

YAML の先頭で変数を定義すると、その変数はパイプライン内のすべてのジョブとステージで使用でき、グローバル変数になります。 YAML で定義されたグローバル変数は、パイプライン設定 UI には表示されません。

ジョブ レベルの変数は、ルート レベルとステージ レベルの変数をオーバーライドします。 ステージ レベルの変数は、ルート レベルで変数をオーバーライドします。

variables:
  global_variable: value    # this is available to all jobs

jobs:
- job: job1
  pool:
    vmImage: 'ubuntu-latest'
  variables:
    job_variable1: value1    # this is only available in job1
  steps:
  - bash: echo $(global_variable)
  - bash: echo $(job_variable1)
  - bash: echo $JOB_VARIABLE1 # variables are available in the script environment too

- job: job2
  pool:
    vmImage: 'ubuntu-latest'
  variables:
    job_variable2: value2    # this is only available in job2
  steps:
  - bash: echo $(global_variable)
  - bash: echo $(job_variable2)
  - bash: echo $GLOBAL_VARIABLE

両方のジョブからの出力は次のようになります。

# job1
value 
value1
value1

# job2
value
value2
value

変数を指定する

前の例では、variables キーワードの後にキーと値のペアの一覧が続きます。 キーは変数名であり、値は変数の値です。

変数または 変数グループの テンプレート を使用する場合に便利な別の構文があります。

テンプレートを使用すると、複数の変数を 1 つの YAML で定義し、別のテンプレートに含めることができます。

変数グループは、複数のパイプラインで使用できる変数セットです。 これにより、さまざまなステージに共通する変数の管理と整理が 1 か所でできます。

この構文は、パイプラインのルート レベルの変数テンプレートと変数グループに使用します。

この代替構文では、 variables キーワードは変数指定子のリストを受け取ります。 変数指定子は、通常の変数の場合は name、変数グループの場合は group、変数テンプレートを含める場合は template です。 次の例は、3 つすべての使用方法を示したものです。

variables:
# a regular variable
- name: myvariable
  value: myvalue
# a variable group
- group: myvariablegroup
# a reference to a variable template
- template: myvariabletemplate.yml

テンプレートを使用した変数の再利用の詳細を参照してください。

環境を介して変数にアクセスする

変数は、環境変数を使用してスクリプトでも使用できるようになることに注意してください。 これらの環境変数を使用するための構文は、スクリプト言語によって異なります。

名前は大文字で、 . は _に置き換えられます。 これはプロセス環境に自動的に挿入されます。 次に例をいくつか示します。

• バッチ スクリプト: %VARIABLE_NAME%
• PowerShell スクリプト: $env:VARIABLE_NAME
• Bash スクリプト: $VARIABLE_NAME

Azure DevOps CLI を使用して、プロジェクト内のパイプライン実行の変数を作成および更新できます。 変数が不要になった場合は、変数を削除することもできます。

変数を作成する | 変数を更新する | 変数を削除する

前提条件

• 「Azure DevOps CLI の概要」の説明に従って、Azure DevOps CLI 拡張機能をインストールしました。
• az login を使用して、Azure DevOps にサインインします。
• この記事の例では、 az devops configure --defaults organization=YourOrganizationURLを使用して既定の組織を設定します。

変数を作成する

az pipelines variable create コマンドを使用して、パイプラインに変数を作成できます。 開始するには、「Azure DevOps CLI の概要」を参照してください。

az pipelines variable create --name
                             [--allow-override {false, true}]
                             [--org]
                             [--pipeline-id]
                             [--pipeline-name]
                             [--project]
                             [--secret {false, true}]
                             [--value]

パラメーター

• name:必須。 変数名。
• allow-override: 省略可能。 値をキュー時に設定できるかどうかを示します。 指定できる値は false と true です。
• org: Azure DevOps 組織の URL。 az devops configure -d organization=ORG_URL を使用して、既定の組織を構成できます。 既定として設定されていない場合、または git config を使用して取得された場合は必須です。 例: --org https://dev.azure.com/MyOrganizationName/.
• pipeline-id: pipeline-name が指定されていない場合は必須です。 パイプラインの ID。
• pipeline-name: pipeline-id が指定されていない場合は必須ですが、 pipeline-id が指定されている場合は無視されます。 パイプラインの名前。
• project: プロジェクトの名前または ID。 az devops configure -d project=NAME_OR_ID を使用して、既定のプロジェクトを構成できます。 既定として設定されていない場合、または git config を使用して取得された場合は必須です。
• secret: 省略可能。 変数の値がシークレットかどうかを示します。 指定できる値は false と true です。
• value: シークレット以外の変数に必要です。 変数の値。 シークレット変数の場合、 value パラメーターが指定されていない場合は、 AZURE_DEVOPS_EXT_PIPELINE_VAR_ というプレフィックスが付いた環境変数から選択されるか、または、ユーザーが標準入力を使用して入力するように求められます。 たとえば、 MySecret という名前の変数は、環境変数 AZURE_DEVOPS_EXT_PIPELINE_VAR_MySecret を使用して入力できます。

例

次のコマンドは、 MyFirstProject に、ID 12のパイプライン内に値 platform を持つ、 Configuration という名前の変数を作成します。 結果がテーブル形式で表示されます。

az pipelines variable create --name Configuration --pipeline-id 12 --value platform --project MyFirstProject --output table

Name        Allow Override    Is Secret    Value
----------  ----------------  -----------  --------
Configuration  False             False        platform

変数を更新する

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

az pipelines variable update --name
                             [--allow-override {false, true}]
                             [--new-name]
                             [--org]
                             [--pipeline-id]
                             [--pipeline-name]
                             [--project]
                             [--prompt-value {false, true}]
                             [--secret {false, true}]
                             [--value]

パラメーター

• name:必須。 変数の元の名前。
• allow-override: 省略可能。 値をキュー時に設定できるかどうかを示します。 指定できる値は false と true です。
• new-name: 省略可能。 変数の名前の変更を指定します。
• org: Azure DevOps 組織の URL。 az devops configure -d organization=ORG_URL を使用して、既定の組織を構成できます。 既定として設定されていない場合、または git config を使用して取得された場合は必須です。 例: --org https://dev.azure.com/MyOrganizationName/.
• pipeline-id: pipeline-name が指定されていない場合は必須です。 パイプラインの ID。
• pipeline-name: pipeline-id が指定されていない場合は必須ですが、 pipeline-id が指定されている場合は無視されます。 パイプラインの名前。
• project: プロジェクトの名前または ID。 az devops configure -d project=NAME_OR_ID を使用して、既定のプロジェクトを構成できます。 既定として設定されていない場合、または git config を使用して取得された場合は必須です。
• prompt-value: 環境変数または標準入力によるプロンプトを使用してシークレット変数の値を更新するには、true に設定します。 指定できる値は false と true です。
• secret: 変数の値がシークレットかどうかを示します。 指定できる値は false と true です。
• value: 変数の値を更新します。 シークレット変数の場合は、prompt-value パラメーターを使用して、標準入力を使用して入力するように求めます。 非対話型コンソールの場合は、 AZURE_DEVOPS_EXT_PIPELINE_VAR_ というプレフィックスが付いた環境変数から選択できます。 たとえば、MySecret という名前の変数は、環境変数 AZURE_DEVOPS_EXT_PIPELINE_VAR_MySecret を使用して入力できます。

例

次のコマンドは、ID 12 のパイプライン内の Configuration 変数を新しい値 config.debug で更新します。 変数が シークレット ではないことが指定され、結果がテーブル形式で表示されます。

az pipelines variable update --name Configuration --pipeline-id 12 --secret false --value config.debug --output table

Name           Allow Override    Is Secret    Value
-------------  ----------------  -----------  ------------
Configuration  False             False        config.debug

変数の削除

az pipelines variable delete コマンドを使用して、パイプラインに変数を削除できます。 開始するには、「Azure DevOps CLI の概要」を参照してください。

az pipelines variable delete --name
                             [--org]
                             [--pipeline-id]
                             [--pipeline-name]
                             [--project]
                             [--yes]

パラメーター

• name:必須。 削除する変数の名前。
• org: Azure DevOps 組織の URL。 az devops configure -d organization=ORG_URL を使用して、既定の組織を構成できます。 既定として設定されていない場合、または git config を使用して取得された場合は必須です。 例: --org https://dev.azure.com/MyOrganizationName/.
• pipeline-id: pipeline-name が指定されていない場合は必須です。 パイプラインの ID。
• pipeline-name: pipeline-id が指定されていない場合は必須ですが、 pipeline-id が指定されている場合は無視されます。 パイプラインの名前。
• project: プロジェクトの名前または ID。 az devops configure -d project=NAME_OR_ID を使用して、既定のプロジェクトを構成できます。 既定として設定されていない場合、または git config を使用して取得された場合は必須です。
• yes: 省略可能。 確認のプロンプトは表示されません。

例

次のコマンドは、ID 12 のパイプラインから Configuration 変数を削除します。確認のプロンプトは表示されません。

az pipelines variable delete --name Configuration --pipeline-id 12 --yes

Deleted variable 'Configuration' successfully.

Azure DevOps CLI コマンドは、Azure DevOps Server ではサポートされていません。

YAML ファイルにシークレット変数を設定しないでください。 オペレーティング システムでは、実行するプロセスのコマンドをログに記録することがよくありますが、入力として渡したシークレットがログに含まれないようにします。 スクリプトの環境を使用するか、 variables ブロック内の変数をマップして、シークレットをパイプラインに渡します。

パイプラインのパイプライン設定 UI でシークレット変数を設定する必要があります。 これらの変数のスコープは、設定されているパイプラインに限定されます。 また、 変数グループにシークレット変数を設定することもできます。

Web インターフェイスでシークレットを設定するには、次の手順に従います。

1. [パイプライン] ページにアクセスし、適切なパイプラインを選択して、 [編集]を選択します。
2. このパイプラインの [変数] を探します。
3. 変数を追加または更新します。
4. 変数を暗号化して保存するには、 この値を秘密にする オプションを選択します。
5. パイプラインを保存します。

シークレット変数は、2048 ビット RSA キーを使用して保存時に暗号化されます。 エージェントで使用するタスクとスクリプトに対してシークレットを利用できます。 パイプラインを変更するアクセス権を持つユーザーには注意してください。

通常の変数とは異なり、スクリプトの環境変数には自動的に復号化されません。 シークレット変数を明示的にマップする必要があります。

次の例は、PowerShell スクリプトと Bash スクリプトで mySecret と呼ばれるシークレット変数をマップして使用する方法を示しています。 2 つのグローバル変数が定義されています。 GLOBAL_MYSECRET にはシークレット変数 mySecret の値が割り当てられ、 GLOBAL_MY_MAPPED_ENV_VAR にはシークレット以外の変数 nonSecretVariable の値が割り当てられます。 通常のパイプライン変数とは異なり、 MYSECRETという環境変数はありません。

PowerShell タスクは、変数を印刷するスクリプトを実行します。

• $(mySecret): これはシークレット変数への直接参照であり、機能します。
• $env:MYSECRET: これは環境変数としてシークレット変数へのアクセスを試みますが、シークレット変数は環境変数に自動的にマップされないため、機能しません。
• $env:GLOBAL_MYSECRET: これはグローバル変数を介してシークレット変数へのアクセスを試みますが、シークレット変数はこのようにマップできないため、これも機能しません。
• $env:GLOBAL_MY_MAPPED_ENV_VAR: これはグローバル変数を介してシークレット以外の変数にアクセスします。機能します。
• $env:MY_MAPPED_ENV_VAR: これはタスク固有の環境変数を介してシークレット変数にアクセスします。シークレット変数を環境変数にマップするための推奨される方法です。

variables:
 GLOBAL_MYSECRET: $(mySecret) # this will not work because the secret variable needs to be mapped as env
 GLOBAL_MY_MAPPED_ENV_VAR: $(nonSecretVariable) # this works because it's not a secret.

steps:

- powershell: |
    Write-Host "Using an input-macro works: $(mySecret)"
    Write-Host "Using the env var directly does not work: $env:MYSECRET"
    Write-Host "Using a global secret var mapped in the pipeline does not work either: $env:GLOBAL_MYSECRET"
    Write-Host "Using a global non-secret var mapped in the pipeline works: $env:GLOBAL_MY_MAPPED_ENV_VAR" 
    Write-Host "Using the mapped env var for this task works and is recommended: $env:MY_MAPPED_ENV_VAR"
  env:
    MY_MAPPED_ENV_VAR: $(mySecret) # the recommended way to map to an env variable

- bash: |
    echo "Using an input-macro works: $(mySecret)"
    echo "Using the env var directly does not work: $MYSECRET"
    echo "Using a global secret var mapped in the pipeline does not work either: $GLOBAL_MYSECRET"
    echo "Using a global non-secret var mapped in the pipeline works: $GLOBAL_MY_MAPPED_ENV_VAR" 
    echo "Using the mapped env var for this task works and is recommended: $MY_MAPPED_ENV_VAR"
  env:
    MY_MAPPED_ENV_VAR: $(mySecret) # the recommended way to map to an env variable

上記のスクリプトの両方のタスクからの出力は次のようになります。

Using an input-macro works: ***
Using the env var directly does not work:
Using a global secret var mapped in the pipeline does not work either:
Using a global non-secret var mapped in the pipeline works: foo
Using the mapped env var for this task works and is recommended: ***

スクリプトの外部でシークレット変数を使用することもできます。 たとえば、 variables 定義を使用して、シークレット変数をタスクにマップできます。 この例では、シークレット変数 $(vmsUser) と $(vmsAdminPass) を Azure ファイル コピー タスクで使用する方法を示します。

variables:
  VMS_USER: $(vmsUser)
  VMS_PASS: $(vmsAdminPass)

pool:
  vmImage: 'ubuntu-latest'

steps:
- task: AzureFileCopy@4
  inputs:
    SourcePath: 'my/path'
    azureSubscription: 'my-subscription'
    Destination: 'AzureVMs'
    storage: 'my-storage'
    resourceGroup: 'my-rg'
    vmsAdminUserName: $(VMS_USER)
    vmsAdminPassword: $(VMS_PASS)

変数グループのシークレット変数を参照する

この例では、YAML ファイルで変数グループを参照する方法と、YAML 内で変数を追加する方法を示します。 変数グループからは 2 つの変数 user と token が使用されています。 token 変数はシークレットであり、YAML で参照できるように環境変数 $env:MY_MAPPED_TOKEN にマップされます。

この YAML は REST 呼び出しを行ってリリースの一覧を取得し、結果を出力します。

variables: 
- group: 'my-var-group' # variable group
- name: 'devopsAccount' # new variable defined in YAML
  value: 'contoso'
- name: 'projectName' # new variable defined in YAML
  value: 'contosoads'

steps:
- task: PowerShell@2
  inputs:
    targetType: 'inline'
    script: |
        # Encode the Personal Access Token (PAT)
        # $env:USER is a normal variable in the variable group
        # $env:MY_MAPPED_TOKEN is a mapped secret variable
        $base64AuthInfo = [Convert]::ToBase64String([Text.Encoding]::ASCII.GetBytes(("{0}:{1}" -f $env:USER,$env:MY_MAPPED_TOKEN)))

        # Get a list of releases
        $uri = "https://vsrm.dev.azure.com/$(devopsAccount)/$(projectName)/_apis/release/releases?api-version=5.1"

        # Invoke the REST call
        $result = Invoke-RestMethod -Uri $uri -Method Get -ContentType "application/json" -Headers @{Authorization=("Basic {0}" -f $base64AuthInfo)}

        # Output releases in JSON
        Write-Host $result.value
  env:
    MY_MAPPED_TOKEN: $(token) # Maps the secret variable $(token) from my-var-group

Azure DevOps CLI を使用してシークレット変数を設定するには、「変数を作成する」または「変数を更新する」を参照してください。

Azure DevOps CLI コマンドは、Azure DevOps Server ではサポートされていません。

別のステージで出力を使用する

別のステージの出力を使用するには、変数を参照する形式を stageDependencies.STAGE.JOB.outputs['TASK.VARIABLE'] にします。 ジョブ レベルでは使用できませんが、ステージ レベルでは条件での変数の使用ができます。

出力変数は、次のダウンストリーム ステージでのみ使用できます。 複数のステージで同じ出力変数を使用する場合は、 dependsOn 条件を使用します。

stages:
- stage: One
  jobs:
  - job: A
    steps:
    - task: MyTask@1  # this step generates the output variable
      name: ProduceVar  # because we're going to depend on it, we need to name the step

- stage: Two
  dependsOn:
  - One
  jobs:
  - job: B
    variables:
      # map the output variable from A into this job
      varFromA: $[ stageDependencies.One.A.outputs['ProduceVar.MyVar'] ]
    steps:
    - script: echo $(varFromA) # this step uses the mapped-in variable

- stage: Three
  dependsOn:
  - One
  - Two
  jobs:
  - job: C
    variables:
      # map the output variable from A into this job
      varFromA: $[ stageDependencies.One.A.outputs['ProduceVar.MyVar'] ]
    steps:
    - script: echo $(varFromA) # this step uses the mapped-in variable

ファイル入力を使用してステージ間で変数を渡すこともできます。 そのためには、ジョブ レベルの第 2 ステージで変数を定義し、その変数を env: 入力として渡す必要があります。

## script-a.sh
echo "##vso[task.setvariable variable=sauce;isOutput=true]crushed tomatoes"

## script-b.sh
echo 'Hello file version'
echo $skipMe
echo $StageSauce

## azure-pipelines.yml
stages:

- stage: one
  jobs:
  - job: A
    steps:
    - task: Bash@3
      inputs:
          filePath: 'script-a.sh'
      name: setvar
    - bash: |
       echo "##vso[task.setvariable variable=skipsubsequent;isOutput=true]true"
      name: skipstep

- stage: two
  jobs:
  - job: B
    variables:
      - name: StageSauce
        value: $[ stageDependencies.one.A.outputs['setvar.sauce'] ]
      - name: skipMe
        value: $[ stageDependencies.one.A.outputs['skipstep.skipsubsequent'] ]
    steps:
    - task: Bash@3
      inputs:
        filePath: 'script-b.sh'
      name: fileversion
      env:
        StageSauce: $(StageSauce) # predefined in variables section
        skipMe: $(skipMe) # predefined in variables section
    - task: Bash@3
      inputs:
        targetType: 'inline'
        script: |
          echo 'Hello inline version'
          echo $(skipMe) 
          echo $(StageSauce) 

前のパイプラインのステージからの出力は次のようになります。

Hello inline version
true
crushed tomatoes

タスクからの出力変数の使用に適用される az pipelines コマンドはありません 。

Azure DevOps CLI コマンドは、Azure DevOps Server ではサポートされていません。

スクリプトからジョブ スコープ変数を設定する

スクリプトから変数を設定するには、ログ記録コマンド task.setvariable を使用します。 これにより、後続のジョブの環境変数が更新されます。 後続のジョブは、 マクロ構文 とタスク内の環境変数を使用して、新しい変数にアクセスできます。

issecret が true に設定されている場合、変数の値はシークレットとして保存され、ログからマスクされます。 シークレット変数の詳細については、「ログ コマンド」を参照してください。

steps:
# Create a variable
- bash: |
    echo "##vso[task.setvariable variable=sauce]crushed tomatoes" # remember to use double quotes

# Use the variable
# "$(sauce)" is replaced by the contents of the `sauce` variable by Azure Pipelines
# before handing the body of the script to the shell.
- bash: |
    echo my pipeline variable is $(sauce)

後続の手順では、パイプライン変数も環境に追加されます。 変数は、定義されているステップでは使用できません。

steps:
# Create a variable
# Note that this does not update the environment of the current script.
- bash: |
    echo "##vso[task.setvariable variable=sauce]crushed tomatoes"

# An environment variable called `SAUCE` has been added to all downstream steps
- bash: |
    echo "my environment variable is $SAUCE"
- pwsh: |
    Write-Host "my environment variable is $env:SAUCE"

前のパイプラインからの出力。

my environment variable is crushed tomatoes
my environment variable is crushed tomatoes

複数ジョブ出力変数を設定する

変数を今後のジョブで使用できるようにするには、 isOutput=trueを使用してその変数を出力変数としてマークする必要があります。 その後、 $[] 構文を使用し、変数を設定するステップ名を含めることで、それを今後のジョブにマップできます。 複数ジョブ出力変数は、同じステージ内のジョブに対してのみ機能します。

異なるステージのジョブに変数を渡すには、 ステージの依存関係 構文を使用します。

複数ジョブ出力変数を作成する場合は、式を変数に割り当てる必要があります。 この YAML では、 $[ dependencies.A.outputs['setvarStep.myOutputVar'] ] が変数 $(myVarFromJobA)に割り当てられます。

jobs:
# Set an output variable from job A
- job: A
  pool:
    vmImage: 'windows-latest'
  steps:
  - powershell: echo "##vso[task.setvariable variable=myOutputVar;isOutput=true]this is the value"
    name: setvarStep
  - script: echo $(setvarStep.myOutputVar)
    name: echovar

# Map the variable into job B
- job: B
  dependsOn: A
  pool:
    vmImage: 'ubuntu-latest'
  variables:
    myVarFromJobA: $[ dependencies.A.outputs['setvarStep.myOutputVar'] ]  # map in the variable
                                                                          # remember, expressions require single quotes
  steps:
  - script: echo $(myVarFromJobA)
    name: echovar

前のパイプラインからの出力。

this is the value
this is the value

あるステージから別のステージに変数を設定する場合は、stageDependencies を使用します。

stages:
- stage: A
  jobs:
  - job: A1
    steps:
     - bash: echo "##vso[task.setvariable variable=myStageOutputVar;isOutput=true]this is a stage output var"
       name: printvar

- stage: B
  dependsOn: A
  variables:
    myVarfromStageA: $[ stageDependencies.A.A1.outputs['printvar.myStageOutputVar'] ]
  jobs:
  - job: B1
    steps:
    - script: echo $(myVarfromStageA)

マトリックス または スライスから変数を設定する場合、ダウンストリーム ジョブからその変数にアクセスするときに変数を参照するには、次を含める必要があります。

• ジョブの名前。
• ステップ。

jobs:

# Set an output variable from a job with a matrix
- job: A
  pool:
    vmImage: 'ubuntu-latest'
  strategy:
    maxParallel: 2
    matrix:
      debugJob:
        configuration: debug
        platform: x64
      releaseJob:
        configuration: release
        platform: x64
  steps:
  - bash: echo "##vso[task.setvariable variable=myOutputVar;isOutput=true]this is the $(configuration) value"
    name: setvarStep
  - bash: echo $(setvarStep.myOutputVar)
    name: echovar

# Map the variable from the debug job
- job: B
  dependsOn: A
  pool:
    vmImage: 'ubuntu-latest'
  variables:
    myVarFromJobADebug: $[ dependencies.A.outputs['debugJob.setvarStep.myOutputVar'] ]
  steps:
  - script: echo $(myVarFromJobADebug)
    name: echovar

jobs:

# Set an output variable from a job with slicing
- job: A
  pool:
    vmImage: 'ubuntu-latest'
    parallel: 2 # Two slices
  steps:
  - bash: echo "##vso[task.setvariable variable=myOutputVar;isOutput=true]this is the slice $(system.jobPositionInPhase) value"
    name: setvarStep
  - script: echo $(setvarStep.myOutputVar)
    name: echovar

# Map the variable from the job for the first slice
- job: B
  dependsOn: A
  pool:
    vmImage: 'ubuntu-latest'
  variables:
    myVarFromJobsA1: $[ dependencies.A.outputs['job1.setvarStep.myOutputVar'] ]
  steps:
  - script: "echo $(myVarFromJobsA1)"
    name: echovar

デプロイ ジョブの出力変数には必ずジョブ名をプレフィックスとして付けてください。 この場合、ジョブ名は A です。

jobs:

# Set an output variable from a deployment
- deployment: A
  pool:
    vmImage: 'ubuntu-latest'
  environment: staging
  strategy:
    runOnce:
      deploy:
        steps:
        - bash: echo "##vso[task.setvariable variable=myOutputVar;isOutput=true]this is the deployment variable value"
          name: setvarStep
        - bash: echo $(setvarStep.myOutputVar)
          name: echovar

# Map the variable from the job for the first slice
- job: B
  dependsOn: A
  pool:
    vmImage: 'ubuntu-latest'
  variables:
    myVarFromDeploymentJob: $[ dependencies.A.outputs['A.setvarStep.myOutputVar'] ]
  steps:
  - bash: "echo $(myVarFromDeploymentJob)"
    name: echovar

スクリプト内の変数の設定に適用される az pipelines コマンドはありません。

Azure DevOps CLI コマンドは、Azure DevOps Server ではサポートされていません。

式を使用して変数を設定できます。 変数を前のジョブから別のジョブの出力に設定するというこのケースは既に 1 件発生しました。

- job: B
  dependsOn: A
  variables:
    myVarFromJobsA1: $[ dependencies.A.outputs['job1.setvarStep.myOutputVar'] ] # remember to use single quotes

変数の設定には、サポートされている任意の式を使用できます。 100 から始まり、実行ごとに 1 ずつインクリメントされ、毎日 100 にリセットされるカウンターとして機能するように変数を設定する例を次に示します。

jobs:
- job:
  variables:
    a: $[counter(format('{0:yyyyMMdd}', pipeline.startTime), 100)]
  steps:
  - bash: echo $(a)

カウンター、依存関係、およびその他の式の詳細については、「式」を参照してください。

式を使用した変数の設定に適用される az Pipelines コマンドはありません。

Azure DevOps CLI コマンドは、Azure DevOps Server ではサポートされていません。

変数が YAML ファイルの variables ブロックに表示される場合、その値は固定され、キュー時にオーバーライドすることはできません。 ベスト プラクティスは、YAML ファイルで変数を定義することですが、これが意味をなさない場合があります。 たとえば、シークレット変数を定義し、その変数を YAML で公開しないようにできます。 または、パイプラインの実行中に変数値を手動で設定することが必要な場合があります。

キュー時の値を定義するには 2 つのオプションがあります。 UI で変数を定義し、 [このパイプラインの実行時に、ユーザーがこの値をオーバーライドできるようにする] オプションを選択することも、代わりに ランタイム パラメーター を使用することもできます。 変数がシークレットでない場合のベスト プラクティスは、 ランタイム パラメーターを使用することです。

キュー時に変数を設定するには、パイプライン内に新しい変数を追加し、オーバーライド オプションを選択します。

キュー時に変数を設定できるようにするには、その変数がパイプラインまたはジョブの variables ブロックにも表示されないようにしてください。 YAML の変数ブロックと UI の両方で変数を定義する場合、YAML の値が優先されます。

Azure DevOps CLI を使用してキュー時に設定できる変数を選択するには、「変数を作成する」または「変数を更新する」を参照してください。

Azure DevOps CLI コマンドは、Azure DevOps Server ではサポートされていません。

複数のスコープで同じ名前の変数を設定すると、次の優先順位が適用されます (優先順位が最も高いものが最初です)。

1. YAML ファイルに設定されたジョブ レベル変数
2. YAML ファイルに設定されたステージ レベル変数
3. YAML ファイルに設定されたパイプライン レベル変数
4. キュー時に設定された変数
5. パイプライン設定 UI で設定されたパイプライン変数

次の例では、YAML ファイルのパイプライン レベルとジョブ レベルで同じ変数 a が設定されています。 また、変数グループ G に設定され、パイプライン設定 UI の変数として設定されます。

variables:
  a: 'pipeline yaml'

stages:
- stage: one
  displayName: one
  variables:
  - name: a
    value: 'stage yaml'

  jobs:
  - job: A
    variables:
    - name: a
      value: 'job yaml'
    steps:
    - bash: echo $(a)        # This will be 'job yaml'

同じスコープに同じ名前の変数を設定すると、最後に設定した値が優先されます。

stages:
- stage: one
  displayName: Stage One
  variables: 
    - name: a
      value: alpha
    - name: a
      value: beta
  jobs: 
  - job: I
    displayName: Job I
    variables:
      - name: b
        value: uno
      - name: b
        value: dos
    steps: 
    - script: echo $(a) #outputs beta
    - script: echo $(b) #outputs dos

変数は、実行の開始時に 1 回展開され、各ステップの開始時にもう一度展開されます。 次に例を示します。

jobs:
- job: A
  variables:
    a: 10
  steps:
  - bash: |
      echo $(a)            # This will be 10
      echo '##vso[task.setvariable variable=a]20'
      echo $(a)            # This will also be 10, since the expansion of $(a) happens before the step
  - bash: echo $(a)        # This will be 20, since the variables are expanded just before the step

前の例には 2 つのステップがあります。 $(a) の拡張は、ジョブの開始時に 1 回、2 つのステップの開始時に 1 回行われます。

変数はジョブの開始時に展開されるため、戦略で使用することはできません。 次の例では、変数 a を使用してジョブ マトリックスを展開することはできません。これは、変数が、展開された各ジョブの開始時でのみ使用できるためです。

jobs:
- job: A
  variables:
    a: 10
  strategy:
    matrix:
      x:
        some_variable: $(a)    # This does not work

変数 a が前のジョブからの出力変数である場合は、将来のジョブで使用できます。

- job: A
  steps:
  - powershell: echo "##vso[task.setvariable variable=a;isOutput=true]10"
    name: a_step

# Map the variable into job B
- job: B
  dependsOn: A
  variables:
    some_variable: $[ dependencies.A.outputs['a_step.a'] ]

再帰的な展開

エージェントでは、 $( ) 構文を使用して参照される変数が再帰的に展開されます。 次に例を示します。

variables:
  myInner: someValue
  myOuter: $(myInner)

steps:
- script: echo $(myOuter)  # prints "someValue"
  displayName: Variable is $(myOuter)  # display name is "Variable is someValue"

変数の拡張に適用される az pipelines コマンドはありません。

Azure DevOps CLI コマンドは、Azure DevOps Server ではサポートされていません。