Azure Cosmos DB: REST API リファレンス
Azure Cosmos DB は、ドキュメント、グラフ、キー値のデータ モデルをサポートするグローバルに分散されたマルチモデル データベースです。 このセクションの内容は、REST を介して SQL API を使用してドキュメント リソースを作成、クエリ、および管理するための内容です。
Azure Cosmos DB REST API では、Azure Cosmos DB リソースへのプログラムによるアクセスにより、データベース、ドキュメント コレクション、ドキュメントを作成、クエリ、削除します。 Azure Cosmos DB リソースに対する操作を実行するには、サポートされているメソッド GET、POSTPUTまたは DELETE を使用して、リソース コレクションまたは特定のリソースを対象とするエンドポイントに HTTPS 要求を送信します。 このセクションでは、REST API を使用してリソースを操作する方法について説明します。
注意
これらの API リファレンス記事では、Azure Cosmos DB データ プレーン API を使用してリソースを作成する方法について説明します。 データ プレーン API を使用すると、Cosmos DB SDK と同様に、インデックス作成ポリシー、パーティション キーなどの基本的なオプションを構成できます。 すべての Azure Cosmos DB リソースの完全な機能サポートが必要な場合は、 Cosmos DB リソース プロバイダーを使用することをお勧めします。 API リファレンス記事を以下に示します。
サポートされている REST API のバージョン
次の表に、Azure Cosmos DB サービスでサポートされている REST API のバージョンを示します。 バージョンは、すべての要求で ヘッダーを x-ms-version 使用して指定する必要があります。 ヘッダーが指定されていない場合、最新バージョンが使用されます。
| バージョン | 導入された変更 | 提供終了日 |
|---|---|---|
| 2018-12-31 | パーティション分割コレクションの自動移行 | |
| 2018-09-17 | 複合および追加の空間インデックス作成 | |
| 2018-08-31 | 動的コレクションのスケーリングの機能強化 | |
| 2018-06-18 | マルチリージョンの書き込みのサポート | |
| 2017-11-15 | 複数リージョンの強力な整合性 | |
| 2017-05-03 | 大きなパーティション キー | |
| 2017-02-22 | 整合性のあるプレフィックス | |
| 2017-01-19 | パーティション分割されたコレクションの最小スループットを 2500 RU/秒に削減しました | |
| 2016-07-11 | 変更フィード | |
| 2015-12-16 | パーティション分割されたコレクション | |
| 2015-08-06 | Upsert | |
| 2015-06-03 | サポート別の注文 | |
| 2015-04-08 | DocumentDB の一般提供 (現在は Azure Cosmos DB の一部) | |
| 2014-08-21 | DocumentDB パブリック プレビュー (現在は Azure Cosmos DB の一部) | 2016 年 2 月 29 日 |
Cosmos DB リソース
次の記事では、各リソースの種類でサポートされている REST API について説明します。 リソース モデルの一般的な情報については、「 リソース モデル 」と 「Cosmos DB リソース URI」を参照してください。
要求を承認する方法については、「 アクセス制御 」を参照してください。 要求と応答のオプションに関する一般的な情報については、次の記事を参照してください。