Azure Invoke REST API を使用した変更管理の構成

YAML またはクラシック Azure パイプラインで Azure Invoke REST API を使用して、 DevOpsの変更管理を構成できます。

REST API の呼び出しを使用するには、 This property decides whether to create a Generic Connection on configure operation for Azure DevOps プロパティを有効にする必要があります。

Azure Invoke REST API の詳細については、 Microsoft ドキュメント サイト にアクセスし、「 Invoke HTTP REST API task- Azure Pipelines」を検索してください。

重要:

パイプライン実行ステップに重複または再利用されたジョブ名がある場合は、stageName 属性の値に azurestageName/jobName が含まれていることを確認します ( stageName = azureStageName/jobName)。アーティファクト登録タスクは、ステージ名とジョブ名の両方を送信して、アーティファクトバージョンを正しいタスク実行に関連付けます。

汎用サービス接続

Azure Invoke REST API を使用するには、 Azure DevOps で汎用サービス接続を作成する必要があります。

YAML Azure パイプライン

Azure DevOps では、サービス接続を変更コントロールエンドポイントとしてサーバータスクを作成する必要があります。

表 : 1. REST API を呼び出すペイロードの要件

Azure パイプラインタイプ	値
Build (構築)	buildNumber isMultiBranch branchName
リリース	リリース番号 projectName

注:

リリースパイプラインの場合は、 展開前の条件 > 詳細 > 完了イベント フィールドをコールバックに設定します。

パイプラインを構築:

- task: InvokeRESTAPI@1
      inputs:
        connectionType: 'connectedServiceName'
        serviceConnection: 'change1'
        method: 'POST'
        body: |
         {
            "buildNumber": "$(build.buildId)",
            "isMultiBranch": "true",
            "branchName": "$(build.sourceBranchName)"
         }
        waitForCompletion: 'true'

リリースパイプライン:

- task: InvokeRESTAPI@1
      inputs:
        connectionType: 'connectedServiceName'
        serviceConnection: 'change1'
        method: 'POST'
        body: |
         {
            "releaseNumber": "$(Release.ReleaseId)",
            "projectName": "$(System.TeamProject)"
         }
        waitForCompletion: 'true'

クラシック Azure パイプライン

クラシック Azure パイプラインの場合は、REST API サーバーの呼び出しタスクを追加する必要があります。

図 : 1. クラシック Azure ビルド パイプラインの例

図 : 2. クラシック Azure リリースパイプラインの例