Bagikan melalui


Database Accounts - Create Update Mongo DB Collection

Membuat atau memperbarui Koleksi MongoDB Azure Cosmos DB

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

Parameter URI

Nama Dalam Diperlukan Jenis Deskripsi
accountName
path True

string

Nama akun database Cosmos DB.

Pola regex: ^[a-z0-9]+(-[a-z0-9]+)*

collectionName
path True

string

Nama koleksi Cosmos DB.

databaseName
path True

string

Nama database Cosmos DB.

resourceGroupName
path True

string

Nama grup sumber daya Azure.

Pola regex: ^[-\w\._\(\)]+$

subscriptionId
path True

string

ID Langganan Azure.

api-version
query True

string

Versi API yang akan digunakan dengan permintaan klien. Versi saat ini adalah 2015-04-08.

Isi Permintaan

Nama Diperlukan Jenis Deskripsi
properties.options True

object

Sepasang opsi kunci-nilai yang akan diterapkan untuk permintaan. Ini sesuai dengan header yang dikirim dengan permintaan.

properties.resource True

MongoDBCollectionResource

Format JSON standar dari koleksi MongoDB

Respons

Nama Jenis Deskripsi
200 OK

MongoDBCollection

Operasi pembuatan atau pembaruan Koleksi MongoDB berhasil diselesaikan.

202 Accepted

Operasi pembuatan atau pembaruan Koleksi MongoDB akan selesai secara asinkron.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama Deskripsi
user_impersonation Meniru akun pengguna Anda

Contoh

CosmosDBMongoDBCollectionCreateUpdate

Permintaan sampel

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": {}
  }
}

Respon sampel

{
  "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"
    }
  }
}

Definisi

Nama Deskripsi
MongoDBCollection

Koleksi Azure Cosmos DB MongoDB.

MongoDBCollectionCreateUpdateParameters

Parameter untuk membuat dan memperbarui koleksi Cosmos DB MongoDB.

MongoDBCollectionResource

Objek sumber daya koleksi Cosmos DB MongoDB

MongoIndex

Kunci indeks koleksi Cosmos DB MongoDB

MongoIndexKeys

Objek sumber daya koleksi Cosmos DB MongoDB

MongoIndexOptions

Opsi indeks koleksi Cosmos DB MongoDB

MongoDBCollection

Koleksi Azure Cosmos DB MongoDB.

Nama Jenis Deskripsi
id

string

Pengidentifikasi sumber daya unik akun database.

location

string

Lokasi grup sumber daya tempat sumber daya berada.

name

string

Nama akun database.

properties.id

string

Nama koleksi Cosmos DB MongoDB

properties.indexes

MongoIndex[]

Daftar kunci indeks

properties.shardKey

object

Sepasang kunci-nilai kunci shard yang akan diterapkan untuk permintaan tersebut.

tags

object

Tag adalah daftar pasangan kunci-nilai yang menjelaskan sumber daya. Tag ini dapat digunakan dalam melihat dan mengelompokkan sumber daya ini (di seluruh grup sumber daya). Maksimal 15 tag dapat disediakan untuk sumber daya. Setiap tag harus memiliki kunci yang tidak lebih besar dari 128 karakter dan nilai tidak lebih besar dari 256 karakter. Misalnya, pengalaman default untuk jenis templat diatur dengan "defaultExperience": "Cassandra". Nilai "defaultExperience" saat ini juga mencakup "Table", "Graph", "DocumentDB", dan "MongoDB".

type

string

Jenis sumber daya Azure.

MongoDBCollectionCreateUpdateParameters

Parameter untuk membuat dan memperbarui koleksi Cosmos DB MongoDB.

Nama Jenis Deskripsi
properties.options

object

Sepasang opsi kunci-nilai yang akan diterapkan untuk permintaan. Ini sesuai dengan header yang dikirim dengan permintaan.

properties.resource

MongoDBCollectionResource

Format JSON standar dari koleksi MongoDB

MongoDBCollectionResource

Objek sumber daya koleksi Cosmos DB MongoDB

Nama Jenis Deskripsi
id

string

Nama koleksi Cosmos DB MongoDB

indexes

MongoIndex[]

Daftar kunci indeks

shardKey

object

Sepasang kunci-nilai kunci shard yang akan diterapkan untuk permintaan tersebut.

MongoIndex

Kunci indeks koleksi Cosmos DB MongoDB

Nama Jenis Deskripsi
key

MongoIndexKeys

Kunci indeks koleksi Cosmos DB MongoDB

options

MongoIndexOptions

Opsi kunci indeks koleksi Cosmos DB MongoDB

MongoIndexKeys

Objek sumber daya koleksi Cosmos DB MongoDB

Nama Jenis Deskripsi
keys

string[]

Daftar kunci untuk setiap koleksi MongoDB di layanan Azure Cosmos DB

MongoIndexOptions

Opsi indeks koleksi Cosmos DB MongoDB

Nama Jenis Deskripsi
expireAfterSeconds

integer

Kedaluwarsa setelah detik

unique

boolean

Unik atau tidak