Azure DevOps Services |Azure DevOps Server 2022 および Azure DevOps Server 2019
バージョン管理された REST API を使用すると、プロジェクトが時間の経過と同時にスケーラブルで保守可能であり、API の進化に合わせてアプリケーションとサービスが引き続き機能するようにすることができます。
ガイドライン
API バージョンは、すべての要求で指定 する必要があります 。
API のバージョンは、
{major}.{minor}[-{stage}[.{resource-version}]]形式です。 例:1.0、1.1、1.2-preview、2.0API はプレビュー段階ですが、必要に応じて、API の特定のリビジョンの正確なバージョンを指定できます。 例:
1.0-preview.1、1.0-preview.2API がリリースされた後 (
1.0など)、そのプレビュー バージョン (1.0-preview) は非推奨となり、12 週間後に非アクティブ化できます。この期間中に、リリースされたバージョンの API にアップグレードする必要があります。 プレビュー API が非アクティブ化されると、
-previewバージョンを指定する要求は拒否されます。
使用方法
API のバージョンは、HTTP 要求のヘッダーで指定することも、URL クエリ パラメーターとして指定することもできます。
HTTP 要求ヘッダー:
Accept: application/json;api-version=1.0
URIのクエリパラメーター
[scheme"://"][host[':'port]]"/v" major-version '/'namespace '/'resource ('/'resource)* '?' query
i.e. GET https://dev.azure.com/v1.0/{organization}/_apis/{area}/{resource}?some-query=1000
サポートされているバージョン
注
サポートされているすべての Rest API については、 Azure DevOps Services REST API リファレンスを参照してください。
Team Foundation Server は、2019 年に Azure DevOps Server の名前に変更されました。
| プロダクト | 1.0 | 2.0 | 3.0 | 4.0 | 5.0 | 6.0 | 7.0 |
|---|---|---|---|---|---|---|---|
| Azure DevOps Services | X | X | X | X | X | X | X |
| Azure DevOps Server 2022 | X | X | X | X | X | X | X |
| Azure DevOps Server 2020 | X | X | X | X | X | X | - |
| Azure DevOps Server 2019 | X | X | X | X | X | - | - |
| Team Foundation Server 2018 | X | X | X | X | - | - | - |
| Team Foundation Server 2017 | X | X | X | - | - | - | - |
| Team Foundation Server 2015 | X | X | - | - | - | - | - |
メジャー API バージョンのリリースは、Team Foundation Server RTM リリースと一致します。 たとえば、 3.0 API セットは Team Foundation Server 2017 で導入されました。
文書化されていないバージョン 1.0 API がいくつか Team Foundation Server 2013 に存在しましたが、サポートされていません。