次の方法で共有

pipeline.parameters.parameter 定義

パラメーターは、パイプラインに渡される値を表します。

parameters:
- name: string # Required as first property.
  displayName: string # Human-readable name for the parameter.
  type: string
  default: string | parameters | [ parameters ] # Default value; if no default, then the parameter MUST be given by the user at runtime.
  values: [ string ] # Allowed list of values (for some data types).

parameters:
- name: string # Required as first property.
  displayName: string # Human-readable name for the parameter.
  type: string
  default: string | parameters | [ parameters ]
  values: [ string ]

この定義を参照する定義: パラメーター

プロパティ

name 文字列。 最初のプロパティとして必要です。

displayName 文字列。
パラメーターの人間が判読できる名前を します。

type 文字列。
の種類を参照してください。

type 文字列。
ブール値 |deployment |deploymentList |environment |filePath |job |jobList |number |object |pool |secureFile |serviceConnection |stage |stageList |step |stepList |糸。

パラメーターを default します。
既定値;デフォルトがない場合、パラメータは実行時にユーザーによって指定されなければなりません。

文字列リスト values します。
値の許可リスト (一部のデータ型)。

備考

パラメーターを定義するときは、 type フィールドと name フィールドが必要です。 パラメーター データ型の詳細を確認します。

parameters:
- name: string          # name of the parameter; required
  type: enum            # see the enum data types in the following section
  default: any          # default value; if no default, then the parameter MUST be given by the user at runtime
  values: [ string ]    # allowed list of values (for some data types)

種類

type 値は、次の表の enum メンバーのいずれかである必要があります。

データ型 筆記
string 糸
number は values:に制限できます。それ以外の場合は、任意の数値に似た文字列を受け入れます
boolean true または false
object 任意の YAML 構造体
step 1 つのステップ
stepList 一連の手順
job 1 つのジョブ
jobList ジョブのシーケンス
deployment 1 つのデプロイ ジョブ
deploymentList デプロイ ジョブのシーケンス
stage 1 つのステージ
stageList ステージのシーケンス

ステップ、stepList、job、jobList、deployment、deploymentList、stage、stageList のデータ型はすべて、標準の YAML スキーマ形式を使用します。 この例には、文字列、数値、ブール値、オブジェクト、ステップ、および stepList が含まれます。

parameters:
  - name: myString
    type: string
    default: a string
  - name: myMultiString
    type: string
    default: default
    values:
      - default
      - ubuntu
  - name: myNumber
    type: number
    default: 2
    values:
      - 1
      - 2
      - 4
      - 8
      - 16
  - name: myBoolean
    type: boolean
    default: true
  - name: myObject
    type: object
    default:
      foo: FOO
      bar: BAR
      things:
        - one
        - two
        - three
      nested:
        one: apple
        two: pear
        count: 3
  - name: myStep
    type: step
    default:
      script: echo my step
  - name: mySteplist
    type: stepList
    default:
      - script: echo step one
      - script: echo step two

trigger: none

jobs: 
  - job: stepList
    steps: ${{ parameters.mySteplist }}
  - job: myStep
    steps:
      - ${{ parameters.myStep }}

例

# File: azure-pipelines.yml
parameters:
- name: image
  displayName: Pool Image
  type: string
  default: ubuntu-latest
  values:
    - windows-latest
    - ubuntu-latest
    - macOS-latest

trigger: none

jobs:
  - job: build
    displayName: build
    pool: 
      vmImage: ${{ parameters.image }}
    steps:
      - script: echo The image parameter is ${{ parameters.image }}

パラメーターを使用してテンプレートを拡張します。 この例では、テンプレートを使用するパイプラインによって、テンプレートに入力する値が提供されます。

# File: simple-param.yml
parameters:
- name: yesNo # name of param; required
  type: boolean # data type of param; required
  default: false

steps:
- script: echo ${{ parameters.yesNo }}

# File: azure-pipelines.yml
trigger:
- main

extends:
    template: simple-param.yml
    parameters:
        yesNo: false

テンプレートを使用してパラメーターを定義し、それらのパラメーターをパイプラインに渡します。

# File: template.yml 
parameters:
  - name: environment
    type: string
    default: 'production'

jobs:
- job: Deploy
  displayName: 'Deploy to ${{ parameters.environment }}'
  pool:
    vmImage: 'ubuntu-latest'
  steps:
  - script: echo "Deploying to ${{ parameters.environment }}"
    displayName: 'Deploy Step'

# File: azure-pipelines.yml
trigger:
- main

pool:
  vmImage: 'ubuntu-latest'

jobs:
- template: template.yml
  parameters:
    environment: 'staging'

関連項目

テンプレートの操作の詳細については、テンプレートを参照してください。