Microsoft Azure DocumentDB: プレビュー版の SDK の提供終了

このポストは、12 月 1 日に投稿された Microsoft Azure DocumentDB: Retirement of Preview SDKs の翻訳です。

2015 年 4 月 8 日に Azure DocumentDB の一般提供を開始して以来、マイクロソフトでは複数のバージョンをリリースし、各バージョンでプロトコルの改良と新機能の追加を行ってまいりました。最新の SDK ではこれまで以上にパフォーマンスが強化され、DocumentDB 開発者向けの最も包括的な機能セットが提供されています。4 月のリリースに先立って、サポートが制限された Azure DocumentDB のパブリック プレビューが実施されました。このときのサービス バージョンと関連するクライアント SDK は、このパブリック プレビュー固有のものでした。

このたび、プレビュー版の REST API とクライアント SDK の提供を終了することになりました。この記事では、該当するバージョンが削除された後もご利用のアプリケーションが引き続き問題なく動作するようにするために、皆様に知っておいていただきたい情報をお伝えします。

背景: DocumentDB のバージョン管理

Azure DocumentDB にはサービスの REST API (機械翻訳) を使用してアクセスします。この API は、Azure DocumentDB のプレビュー版がリリースされた 2014 年 8 月に初めてリリースされました。マイクロソフトでは、機能の追加や変更によってサービスを改善していく中で、既存のアプリケーションに支障が出ないようにバージョン管理を利用してきました。変更を加える際に既存のアプリケーションに支障が出るおそれがある場合は必ず、新しいバージョンを発表しています。アプリケーション側では、新しいバージョンを使用する際に明示的に選択する必要があります。新しいバージョンが導入されても、既存のアプリケーションが影響を受けることはありません。DocumentDB への呼び出しを行う際は、REST 要求の HTTP ヘッダーで x-ms-version を設定することで、使用するバージョンを明示的に指定できます。このヘッダーが設定されていない場合は、最新バージョンを使用して要求が処理されます。

クライアント ライブラリ、SDK、ツールについて

ユーザーの皆様の大半は、DocumentDB を利用するためにマイクロソフトが提供している公開クライアント ライブラリを使用しています。こうした各クライアント ライブラリは REST API への呼び出しをラップしたもので、特定のバージョンの REST API に依存しています。

変更内容

マイクロソフトのバージョン管理に対するアプローチは変わりません。つまり今後も、変更を加える際に既存のバージョンとの互換性に影響が出るおそれがある場合は必ず新しいバージョンの REST API を発表します。ただし今回、旧バージョンの REST API と関連するプレビュー版のクライアント SDK の提供を終了することになりました。

提供終了に関する詳細

提供が終了するバージョン

2016 年 2 月 29 日に、バージョン 2015-04-08 より前のすべてのバージョンの提供が終了する予定です。これには、以下のバージョンが含まれます。

  • バージョン 2014-08-21 (一般提供開始前のリリース)

以下のバージョンはこの影響を受けることなく、引き続き完全にサポートされます。

  • バージョン 2015-04-08
  • バージョン 2015-06-03
  • バージョン 2015-08-06 (最新バージョン)

REST API と現在サポートされているバージョンの詳細については、MSDN の「Azure DocumentDB API リファレンス (機械翻訳)」のドキュメントをご覧ください。

これらのバージョンが削除されるタイミング

対象となるバージョンは、2016 2 29 に削除される予定です。

これらのバージョンの削除による影響

x-ms-version 要求ヘッダーを使用してバージョンを明示的に指定 (削除対象のいずれかのバージョンに設定) した要求が失敗し、HTTP ステータス コード 400 (無効な要求) が返されます。

サポート対象の最も古いバージョン/ライブラリ/SDK

ユーザーの皆様には、可能な限り最新バージョンのクライアント SDK にアップグレードしていただくことをお勧めします。

2015 年 4 月 8 日の一般提供開始よりも前にリリースされたクライアント SDK (バージョン番号が 1.0.0 よりも小さいもの (0.9.x-preview)) は、2016 年 2 月 29 日に提供が終了し、サポート対象外となります。

以下の表では、提供終了予定のバージョン向けのコンポーネントを使用していないかどうかを簡単に確認することができます。

言語

サポート対象の最も古いバージョン

最新バージョン

.NET

1.0.0 (英語)

1.5.0 (英語)

Node.js

1.0.0 (英語)

1.5.0 (英語)

Java

1.0.0 (英語)

1.5.0 (英語)

Python

1.0.0 (英語)

1.5.0 (英語)

お客様にご対応いただくこと

ユーザーの皆様には、2016 年 3 月 1 日にプレビュー版のサービス バージョンが削除される際に影響を受けないように、少なくとも各プラットフォームでサポート対象の最も古いバージョンへのアプリケーションのアップグレードをなるべく早期に実施することをお勧めします。各 SDK のバージョンの相違点を確認し、変更された API を特定するには、.NET (英語)Node.js (英語)Java (英語)Python (英語) のリリース ノートをご覧ください。

なお、何らかの理由で 2016 年 3 月 1 日までにアプリケーションをアップグレードできないお客様は、提供終了前に Azure DocumentDB チームまでご連絡ください。

まとめ

DocumentDB をまだご利用になったことがない方は、無料試用版にサインアップし、DocumentDB アカウントを作成してください。

サポートが必要な場合やご不明な点がある場合は、MSDN (英語) または Stack Overflow (英語) の開発者フォーラムにてお問い合わせください。

また、Twitter アカウント (@DocumentDB) をフォローすると、DocumentDB の最新情報や新機能をいち早くチェックしていただけます。