Freigeben über


Database Accounts - Create Update Mongo DB Collection

Erstellen oder Aktualisieren einer MongoDB-Sammlung in 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

URI-Parameter

Name In Erforderlich Typ Beschreibung
accountName
path True

string

Name des Cosmos DB-Datenbankkontos.

RegEx-Muster: ^[a-z0-9]+(-[a-z0-9]+)*

collectionName
path True

string

Cosmos DB-Sammlungsname.

databaseName
path True

string

Name der Cosmos DB-Datenbank.

resourceGroupName
path True

string

Name einer Azure-Ressourcengruppe.

RegEx-Muster: ^[-\w\._\(\)]+$

subscriptionId
path True

string

Die Azure-Abonnement-ID.

api-version
query True

string

Version der API, die mit der Clientanforderung verwendet werden soll. Die aktuelle Version ist 2015-04-08.

Anforderungstext

Name Erforderlich Typ Beschreibung
properties.options True

object

Ein Schlüssel-Wert-Paar von Optionen, die für die Anforderung angewendet werden sollen. Dies entspricht den Headern, die mit der Anforderung gesendet werden.

properties.resource True

MongoDBCollectionResource

Das JSON-Standardformat einer MongoDB-Auflistung

Antworten

Name Typ Beschreibung
200 OK

MongoDBCollection

Der Erstellungs- oder Aktualisierungsvorgang der MongoDB-Sammlung wurde erfolgreich abgeschlossen.

202 Accepted

Der Erstellungs- oder Aktualisierungsvorgang der MongoDB-Sammlung wird asynchron abgeschlossen.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name Beschreibung
user_impersonation Identitätswechsel Ihres Benutzerkontos

Beispiele

CosmosDBMongoDBCollectionCreateUpdate

Beispielanforderung

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

Beispiel für eine Antwort

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

Definitionen

Name Beschreibung
MongoDBCollection

Eine MongoDB-Sammlung von Azure Cosmos DB.

MongoDBCollectionCreateUpdateParameters

Parameter zum Erstellen und Aktualisieren der MongoDB-Sammlung von Cosmos DB.

MongoDBCollectionResource

MongoDB-Sammlungsressourcenobjekt von Cosmos DB

MongoIndex

Cosmos DB MongoDB-Sammlungsindexschlüssel

MongoIndexKeys

MongoDB-Sammlungsressourcenobjekt von Cosmos DB

MongoIndexOptions

Cosmos DB MongoDB-Sammlungsindexoptionen

MongoDBCollection

Eine MongoDB-Sammlung von Azure Cosmos DB.

Name Typ Beschreibung
id

string

Der eindeutige Ressourcenbezeichner des Datenbankkontos.

location

string

Der Speicherort der Ressourcengruppe, zu der die Ressource gehört.

name

string

Der Name des Datenbankkontos.

properties.id

string

Name der MongoDB-Sammlung von Cosmos DB

properties.indexes

MongoIndex[]

Liste der Indexschlüssel

properties.shardKey

object

Ein Schlüssel-Wert-Paar von Shardschlüsseln, die für die Anforderung angewendet werden sollen.

tags

object

Tags sind eine Liste von Schlüssel-Wert-Paaren, die die Ressource beschreiben. Diese Tags können über Ressourcengruppen hinweg zum Anzeigen und Gruppieren von Ressourcen verwendet werden. Für eine Ressource können maximal 15 Tags bereitgestellt werden. Der Schlüssel eines Tags darf nicht länger als 128 Zeichen und der Wert nicht länger als 256 Zeichen sein. Beispielsweise ist die Standardumgebung für einen Vorlagentyp auf "defaultExperience": "Cassandra" festgelegt. Zu den aktuellen "defaultExperience"-Werten gehören auch "Table", "Graph", "DocumentDB" und "MongoDB".

type

string

Der Typ der Azure-Ressource.

MongoDBCollectionCreateUpdateParameters

Parameter zum Erstellen und Aktualisieren der MongoDB-Sammlung von Cosmos DB.

Name Typ Beschreibung
properties.options

object

Ein Schlüssel-Wert-Paar von Optionen, die für die Anforderung angewendet werden sollen. Dies entspricht den Headern, die mit der Anforderung gesendet werden.

properties.resource

MongoDBCollectionResource

Das JSON-Standardformat einer MongoDB-Auflistung

MongoDBCollectionResource

MongoDB-Sammlungsressourcenobjekt von Cosmos DB

Name Typ Beschreibung
id

string

Name der MongoDB-Sammlung von Cosmos DB

indexes

MongoIndex[]

Liste der Indexschlüssel

shardKey

object

Ein Schlüssel-Wert-Paar von Shardschlüsseln, die für die Anforderung angewendet werden sollen.

MongoIndex

Cosmos DB MongoDB-Sammlungsindexschlüssel

Name Typ Beschreibung
key

MongoIndexKeys

Cosmos DB MongoDB-Sammlungsindexschlüssel

options

MongoIndexOptions

Optionen für Cosmos DB-MongoDB-Sammlungsindexschlüssel

MongoIndexKeys

MongoDB-Sammlungsressourcenobjekt von Cosmos DB

Name Typ Beschreibung
keys

string[]

Liste der Schlüssel für jede MongoDB-Sammlung im Azure Cosmos DB-Dienst

MongoIndexOptions

Cosmos DB MongoDB-Sammlungsindexoptionen

Name Typ Beschreibung
expireAfterSeconds

integer

Ablauf nach Sekunden

unique

boolean

Ist eindeutig oder nicht