次の方法で共有


Database Accounts - Create Update Mongo DB Collection

Azure Cosmos DB MongoDB コレクションを作成または更新する

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/apis/mongodb/databases/{databaseName}/collections/{collectionName}?api-version=2016-03-31

URI パラメーター

名前 / 必須 説明
accountName
path True

string

Cosmos DB データベース アカウント名。

正規表現パターン: ^[a-z0-9]+(-[a-z0-9]+)*

collectionName
path True

string

Cosmos DB コレクション名。

databaseName
path True

string

Cosmos DB データベース名。

resourceGroupName
path True

string

Azure リソース グループの名前。

正規表現パターン: ^[-\w\._\(\)]+$

subscriptionId
path True

string

Azure サブスクリプション ID。

api-version
query True

string

クライアント要求で使用される API のバージョン。 現在のバージョンは 2015-04-08 です。

要求本文

名前 必須 説明
properties.options True

object

要求に適用するオプションのキーと値のペア。 これは、要求と共に送信されるヘッダーに対応します。

properties.resource True

MongoDBCollectionResource

MongoDB コレクションの標準 JSON 形式

応答

名前 説明
200 OK

MongoDBCollection

MongoDB コレクションの作成または更新操作が正常に完了しました。

202 Accepted

MongoDB コレクションの作成または更新操作は非同期的に完了します。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前 説明
user_impersonation ユーザー アカウントの借用

CosmosDBMongoDBCollectionCreateUpdate

要求のサンプル

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/apis/mongodb/databases/databaseName/collections/collectionName?api-version=2016-03-31

{
  "properties": {
    "resource": {
      "id": "testcoll",
      "indexes": [
        {
          "key": {
            "keys": [
              "testKey"
            ]
          },
          "options": {
            "expireAfterSeconds": 100,
            "unique": true
          }
        }
      ],
      "shardKey": {
        "testKey": "Hash"
      }
    },
    "options": {}
  }
}

応答のサンプル

{
  "id": "collectionName",
  "name": "collectionName",
  "type": "Microsoft.DocumentDB/databaseAccounts/apis/collection",
  "properties": {
    "id": "testcoll",
    "indexes": [
      {
        "key": {
          "keys": [
            "testKey"
          ]
        },
        "options": {
          "expireAfterSeconds": 100,
          "unique": true
        }
      }
    ],
    "shardKey": {
      "testKey": "Hash"
    }
  }
}

定義

名前 説明
MongoDBCollection

Azure Cosmos DB MongoDB コレクション。

MongoDBCollectionCreateUpdateParameters

Cosmos DB MongoDB コレクションを作成および更新するためのパラメーター。

MongoDBCollectionResource

Cosmos DB MongoDB コレクション リソース オブジェクト

MongoIndex

Cosmos DB MongoDB コレクションのインデックス キー

MongoIndexKeys

Cosmos DB MongoDB コレクション リソース オブジェクト

MongoIndexOptions

Cosmos DB MongoDB コレクションのインデックス オプション

MongoDBCollection

Azure Cosmos DB MongoDB コレクション。

名前 説明
id

string

データベース アカウントの一意のリソース識別子。

location

string

リソースが属しているリソース グループの場所。

name

string

データベース アカウントの名前。

properties.id

string

Cosmos DB MongoDB コレクションの名前

properties.indexes

MongoIndex[]

インデックス キーの一覧

properties.shardKey

object

要求に適用されるシャード キーのキーと値のペア。

tags

object

タグは、リソースを記述するキーと値のペアの一覧です。 これらのタグはリソース グループをまたがってこのリソースを表示およびグループ化する際に使用できます。 リソースには最大 15 個のタグを指定できます。 各タグには 128 文字以内のキーと、256 文字以内の値が必要です。 たとえば、テンプレートの種類の既定のエクスペリエンスは、"defaultExperience": "Cassandra" に設定されます。 現在の "defaultExperience" 値には、"Table"、"Graph"、"DocumentDB"、"MongoDB" も含まれます。

type

string

Azure リソースの種類。

MongoDBCollectionCreateUpdateParameters

Cosmos DB MongoDB コレクションを作成および更新するためのパラメーター。

名前 説明
properties.options

object

要求に適用するオプションのキーと値のペア。 これは、要求と共に送信されるヘッダーに対応します。

properties.resource

MongoDBCollectionResource

MongoDB コレクションの標準 JSON 形式

MongoDBCollectionResource

Cosmos DB MongoDB コレクション リソース オブジェクト

名前 説明
id

string

Cosmos DB MongoDB コレクションの名前

indexes

MongoIndex[]

インデックス キーの一覧

shardKey

object

要求に適用されるシャード キーのキーと値のペア。

MongoIndex

Cosmos DB MongoDB コレクションのインデックス キー

名前 説明
key

MongoIndexKeys

Cosmos DB MongoDB コレクションのインデックス キー

options

MongoIndexOptions

Cosmos DB MongoDB コレクションのインデックス キー オプション

MongoIndexKeys

Cosmos DB MongoDB コレクション リソース オブジェクト

名前 説明
keys

string[]

Azure Cosmos DB サービス内の各 MongoDB コレクションのキーの一覧

MongoIndexOptions

Cosmos DB MongoDB コレクションのインデックス オプション

名前 説明
expireAfterSeconds

integer

秒後に有効期限が切れる

unique

boolean

一意かどうか