Create Database操作により、データベース アカウントに新しいデータベースが作成されます。
注
これらの API リファレンス記事では、Azure Cosmos DB データ プレーン API を使用してリソースを作成する方法を示します。 データ プレーン API を使用すると、Cosmos DB ソフトウェア開発キット (SDK) の場合と同様に、インデックス作成ポリシー、パーティション キーなどの基本オプションを構成できます。 すべての Azure Cosmos DB リソースに対して完全な機能サポートが必要な場合は、 Cosmos DB リソース プロバイダーを使用することをお勧めします。
リクエスト
| メソッド | URI リクエスト | 説明 |
|---|---|---|
| 投稿 | https://{databaseaccount}.documents.azure.com/dbs |
{databaseaccount} は、サブスクリプションで作成した Azure Cosmos DB アカウントの名前です。 |
ヘッダー
すべての Azure Cosmos DB 要求で使用されるヘッダーについては、「 一般的な Azure Cosmos DB REST 要求ヘッダー 」を参照してください。
| プロパティ | 必須 | タイプ | 説明 |
|---|---|---|---|
| x-ms-offer-スループット | オプション | 番号 | ユーザーが指定したデータベースの手動スループット (RU/秒) は、100 要求ユニット/秒の単位で表されます。 最小値は 400 から 1,000,000 までです (または制限の引き上げを要求する場合はそれ以上)。x-ms-offer-throughputまたはx-ms-cosmos-offer-autopilot-settingsのいずれかを指定する必要があります。 これらのヘッダーを一緒に指定することはできません。 |
| x-ms-cosmos-offer-autopilot-settings | オプション | JSON | ユーザーがデータベースの最大 RU/秒を自動スケーリング指定しました。 値は、プロパティが maxThroughput の JSON です。 たとえば、 {"maxThroughput": 4000}と指定します。x-ms-offer-throughputまたはx-ms-cosmos-offer-autopilot-settingsのいずれかを指定する必要があります。 これらのヘッダーを一緒に指定することはできません。 |
注
データベースにスループットを設定すると、共有 スループット データベース が作成され、その中のすべてのコレクションがプロビジョニングされたスループットを共有します。 共有スループット データベースには 25 個のコンテナーの制限があります。 共有スループット データベースを使用しない場合は、スループット ヘッダーを設定せずにデータベースを作成します。 詳細については、こちらを参照してください。
体
| プロパティ | 必須 | タイプ | 説明 |
|---|---|---|---|
| 識別子 | 必須 | 糸 | データベースのユーザーが生成した一意の名前。 これは、255 文字を超えてはならない文字列です。 |
{
"id": "volcanodb2"
}
[応答]
ヘッダー
すべての Azure Cosmos DB 応答によって返されるヘッダーについては、「 一般的な Azure Cosmos DB REST 応答ヘッダー 」を参照してください。
状態コード
次の表に、この操作によって返される一般的な状態コードを示します。 ステータスコードの完全なリストについては、「 HTTP ステータスコード」を参照してください。
| HTTP 状態コード | 説明 |
|---|---|
| 201 作成済み | 操作が成功すると返されます。 |
| 400 無効な要求 | JSON 本文が無効な場合に返されます。 中かっこや引用符の不足がないか確認してください。 |
| 409 競合 | 新しいデータベースに指定された ID が既存のデータベースによって取得された場合に返されます。 |
体
| プロパティ | 説明 |
|---|---|
| ID | データベースのユーザーが生成した一意の名前。 |
| _rid | これは 、システム生成プロパティです。 リソース ID (_rid) は、リソース モデル上のリソース スタックごとに階層構造になっている一意の識別子です。 これは、データベース・リソースの配置およびナビゲーションのために内部的に使用されます。 |
| _ts | これは、システムによって生成されたプロパティです。 リソースの最後に更新されたタイムスタンプを指定します。 値はタイムスタンプです。 |
| _自己 | これは、システムによって生成されたプロパティです。 これは、リソースの一意のアドレス指定可能な URI です。 |
| _etag | これは、オプティミスティック同時実行制御に必要なリソース etag を指定するシステム生成プロパティです。 |
| _colls | これは、コレクション リソースのアドレス指定可能なパスを指定するシステム生成プロパティです。 |
| _ユーザー | これは、ユーザー・リソースのアドレス指定可能なパスを指定するシステム生成プロパティーです。 |
{
"id": "volcanodb2",
"_rid": "CqNBAA==",
"_ts": 1449602962,
"_self": "dbs\/CqNBAA==\/",
"_etag": "\"00000a00-0000-0000-0000-56672f920000\"",
"_colls": "colls\/",
"_users": "users\/"
}
例 1
次の例では、データベースを作成します。
POST https://contosomarketing.documents.azure.com/dbs HTTP/1.1
x-ms.date: 04/20/2021
authorization: type%3dmaster%26ver%3d1.0%26sig%3dsc0%2fu25RB8wSqbY1%2bUZqTGD0yCQC5KkGOAP%2bgnHFceQ%3d
Cache-Control: no-cache
User-Agent: contoso/1.0
x-ms-version: 2015-08-06
Accept: application/json
Host: contosomarketing.documents.azure.com
Content-Length: 19
Expect: 100-continue
{"id":"volcanodb2"}
HTTP/1.1 201 Created
Cache-Control: no-store, no-cache
Pragma: no-cache
Content-Type: application/json
Server: Microsoft-HTTPAPI/2.0
Strict-Transport-Security: max-age=31536000
x-ms-last-state-change-utc: Sun, 29 Nov 2015 02:25:35.212 GMT
etag: "00000a00-0000-0000-0000-56672f920000"
x-ms-resource-quota: databases=100;
x-ms-resource-usage: databases=15;
x-ms-schemaversion: 1.1
x-ms-quorum-acked-lsn: 859
x-ms-session-token: 860
x-ms-current-write-quorum: 3
x-ms-current-replica-set-size: 4
x-ms-request-charge: 4.95
x-ms-serviceversion: version=1.5.57.3
x-ms-activity-id: f171e571-994e-4dc2-b443-7c3d5fa4a293
x-ms-gatewayversion: version=1.5.57.3
Date: Tue, 08 Dec 2015 19:29:21 GMT
Content-Length: 169
{
"id": "volcanodb2",
"_rid": "CqNBAA==",
"_ts": 1449602962,
"_self": "dbs\/CqNBAA==\/",
"_etag": "\"00000a00-0000-0000-0000-56672f920000\"",
"_colls": "colls\/",
"_users": "users\/"
}
例 2
次の例では、手動スループットが 400 RU/秒の 共有スループット データベース を作成します。
x-ms-offer-throughput ヘッダーは、スループット (RU/秒) 値を設定するために使用されます。 100 単位で増分される最小 400 の数値を受け入れます。
POST https://contosomarketing.documents.azure.com/dbs HTTP/1.1
x-ms-date: Tue, 08 Dec 2015 19:29:22 GMT
authorization: type%3dmaster%26ver%3d1.0%26sig%3dsc0%2fu25RB8wSqbY1%2bUZqTGD0yCQC5KkGOAP%2bgnHFceQ%3d
Cache-Control: no-cache
User-Agent: contoso/1.0
x-ms-version: 2015-08-06
Accept: application/json
x-ms-offer-throughput = 400
Host: contosomarketing.documents.azure.com
Content-Length: 19
Expect: 100-continue
{"id":"volcanodb2"}
例 3
次の例では、自動スケーリングの最大スループットが 4000 RU/秒 (400 から 4000 RU/秒の間でスケーリング) の共有スループット データベースを作成します。
x-ms-cosmos-offer-autopilot-settings ヘッダーは、自動スケーリングの最大 RU/秒値である maxThroughput を設定するために使用されます。 1000単位で増分される最小4000の数値を受け入れます。
注
既存のデータベースまたはコンテナーで自動スケーリングを有効にする方法、または自動スケーリングから手動スループットに切り替えるには、「 オファーを置き換える」の記事を参照してください。
POST https://contosomarketing.documents.azure.com:443/dbs HTTP/1.1
x-ms-version: 2018-12-31
x-ms-date: Wed, 22 Jul 2020 20:09:50 GMT
authorization: type%3dmaster%26ver%3d1.0%26sig%3dsc0%2fu25RB8wSqbY1%2bUZqTGD0yCQC5KkGOAP%2bgnHFceQ%3d
Accept: application/json
x-ms-cosmos-offer-autopilot-settings: {"maxThroughput": 4000}
Content-Type: application/json
User-Agent: contoso/1.0
Postman-Token: 81c0a4ac-4b7c-4f98-8d46-8c662969bc7e
Host: contosomarketing.documents.azure.com:443
Accept-Encoding: gzip, deflate, br
Connection: keep-alive
Content-Length: 27
{"id":"volcanodb3"}
こちらもご覧ください
- Azure Cosmos DB
- Azure Cosmos DB SQL API の
- Azure Cosmos DB SQL API SDK
- .NET サンプル から REST を する