Azure Invoke REST API を使用した変更コントロールの構成

  • リリースバージョン: Yokohama
  • 更新日 2025年01月30日
  • 所要時間:2分
  • 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 のドキュメントサイト にアクセスし、「 HTTP REST API の呼び出しタスク- Azure Pipelines」を検索してください。

    重要:

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

    汎用サービス接続

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

    Azure YAML REST API 変更コントロール接続

    YAML Azure パイプライン

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

    表 : 1. REST API ペイロード要件を呼び出す
    Azure パイプラインタイプ
    構築
    • 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 ビルドパイプラインの例
    Azure パイプライン呼び出し REST API 変更コントロール
    図 : 2. クラシック Azure リリース パイプラインの例
    DevOps Azure クラシックリリースパイプライン