Delen via


Database Accounts - Create Update Mongo DB Collection

Een Azure Cosmos DB MongoDB-verzameling maken of bijwerken

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-parameters

Name In Vereist Type Description
accountName
path True

string

Naam van cosmos DB-databaseaccount.

Regex-patroon: ^[a-z0-9]+(-[a-z0-9]+)*

collectionName
path True

string

Naam van Cosmos DB-verzameling.

databaseName
path True

string

Cosmos DB-databasenaam.

resourceGroupName
path True

string

Naam van een Azure-resourcegroep.

Regex-patroon: ^[-\w\._\(\)]+$

subscriptionId
path True

string

Azure-abonnements-id.

api-version
query True

string

Versie van de API die moet worden gebruikt met de clientaanvraag. De huidige versie is 2015-04-08.

Aanvraagbody

Name Vereist Type Description
properties.options True

object

Een sleutel-waardepaar met opties die voor de aanvraag moeten worden toegepast. Dit komt overeen met de headers die met de aanvraag zijn verzonden.

properties.resource True

MongoDBCollectionResource

De standaard-JSON-indeling van een MongoDB-verzameling

Antwoorden

Name Type Description
200 OK

MongoDBCollection

Het maken of bijwerken van de MongoDB-verzameling is voltooid.

202 Accepted

De bewerking voor het maken of bijwerken van de MongoDB-verzameling wordt asynchroon voltooid.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name Description
user_impersonation Uw gebruikersaccount imiteren

Voorbeelden

CosmosDBMongoDBCollectionCreateUpdate

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Definities

Name Description
MongoDBCollection

Een Azure Cosmos DB MongoDB-verzameling.

MongoDBCollectionCreateUpdateParameters

Parameters voor het maken en bijwerken van Cosmos DB MongoDB-verzameling.

MongoDBCollectionResource

Cosmos DB MongoDB-verzamelingsresourceobject

MongoIndex

Cosmos DB MongoDB-verzamelingsindexsleutel

MongoIndexKeys

Cosmos DB MongoDB-verzamelingsresourceobject

MongoIndexOptions

Indexopties voor Cosmos DB MongoDB-verzameling

MongoDBCollection

Een Azure Cosmos DB MongoDB-verzameling.

Name Type Description
id

string

De unieke resource-id van het databaseaccount.

location

string

De locatie van de resourcegroep waartoe de resource behoort.

name

string

De naam van het databaseaccount.

properties.id

string

Naam van de Cosmos DB MongoDB-verzameling

properties.indexes

MongoIndex[]

Lijst met indexsleutels

properties.shardKey

object

Een sleutel-waardepaar van shardsleutels die moeten worden toegepast op de aanvraag.

tags

object

Tags zijn een lijst met sleutel-waardeparen die de resource beschrijven. Deze tags kunnen worden gebruikt bij het weergeven en groeperen van deze resource (tussen resourcegroepen). Er kunnen maximaal 15 tags worden opgegeven voor een resource. Elke tag moet een sleutel hebben die niet groter is dan 128 tekens en de waarde niet groter is dan 256 tekens. De standaardervaring voor een sjabloontype is bijvoorbeeld ingesteld met 'defaultExperience': 'Cassandra'. Huidige 'defaultExperience'-waarden omvatten ook 'Table', 'Graph', 'DocumentDB' en 'MongoDB'.

type

string

Het type Azure-resource.

MongoDBCollectionCreateUpdateParameters

Parameters voor het maken en bijwerken van Cosmos DB MongoDB-verzameling.

Name Type Description
properties.options

object

Een sleutel-waardepaar met opties die voor de aanvraag moeten worden toegepast. Dit komt overeen met de headers die met de aanvraag zijn verzonden.

properties.resource

MongoDBCollectionResource

De standaard-JSON-indeling van een MongoDB-verzameling

MongoDBCollectionResource

Cosmos DB MongoDB-verzamelingsresourceobject

Name Type Description
id

string

Naam van de Cosmos DB MongoDB-verzameling

indexes

MongoIndex[]

Lijst met indexsleutels

shardKey

object

Een sleutel-waardepaar van shardsleutels die moeten worden toegepast op de aanvraag.

MongoIndex

Cosmos DB MongoDB-verzamelingsindexsleutel

Name Type Description
key

MongoIndexKeys

Indexsleutels voor Cosmos DB MongoDB-verzameling

options

MongoIndexOptions

Opties voor cosmos DB MongoDB-verzamelingsindexsleutels

MongoIndexKeys

Cosmos DB MongoDB-verzamelingsresourceobject

Name Type Description
keys

string[]

Lijst met sleutels voor elke MongoDB-verzameling in de Azure Cosmos DB-service

MongoIndexOptions

Indexopties voor Cosmos DB MongoDB-verzameling

Name Type Description
expireAfterSeconds

integer

Verlopen na seconden

unique

boolean

Is uniek of niet