Dela via


Database Accounts - Create Update Mongo DB Collection

Skapa eller uppdatera en Azure Cosmos DB MongoDB-samling

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

Name I Obligatorisk Typ Description
accountName
path True

string

Namn på Cosmos DB-databaskonto.

Reguljärt uttrycksmönster: ^[a-z0-9]+(-[a-z0-9]+)*

collectionName
path True

string

Cosmos DB-samlingsnamn.

databaseName
path True

string

Cosmos DB-databasnamn.

resourceGroupName
path True

string

Namnet på en Azure-resursgrupp.

Reguljärt uttrycksmönster: ^[-\w\._\(\)]+$

subscriptionId
path True

string

Prenumerations-ID för Azure.

api-version
query True

string

Version av API:et som ska användas med klientbegäran. Den aktuella versionen är 2015-04-08.

Begärandetext

Name Obligatorisk Typ Description
properties.options True

object

Ett nyckel/värde-par med alternativ som ska tillämpas för begäran. Detta motsvarar de huvuden som skickas med begäran.

properties.resource True

MongoDBCollectionResource

JSON-standardformatet för en MongoDB-samling

Svar

Name Typ Description
200 OK

MongoDBCollection

Åtgärden för att skapa eller uppdatera MongoDB-samlingen har slutförts.

202 Accepted

Åtgärden för att skapa eller uppdatera MongoDB-samlingen slutförs asynkront.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name Description
user_impersonation Personifiera ditt användarkonto

Exempel

CosmosDBMongoDBCollectionCreateUpdate

Exempelbegäran

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

Exempelsvar

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

Definitioner

Name Description
MongoDBCollection

En Azure Cosmos DB MongoDB-samling.

MongoDBCollectionCreateUpdateParameters

Parametrar för att skapa och uppdatera Cosmos DB MongoDB-samlingen.

MongoDBCollectionResource

Cosmos DB MongoDB-samlingsresursobjekt

MongoIndex

Cosmos DB MongoDB-samlingsindexnyckel

MongoIndexKeys

Cosmos DB MongoDB-samlingsresursobjekt

MongoIndexOptions

Alternativ för Cosmos DB MongoDB-samlingsindex

MongoDBCollection

En Azure Cosmos DB MongoDB-samling.

Name Typ Description
id

string

Databaskontots unika resursidentifierare.

location

string

Platsen för resursgruppen som resursen tillhör.

name

string

Namnet på databaskontot.

properties.id

string

Namnet på Cosmos DB MongoDB-samlingen

properties.indexes

MongoIndex[]

Lista över indexnycklar

properties.shardKey

object

Ett nyckel/värde-par med shardnycklar som ska användas för begäran.

tags

object

Taggar är en lista över nyckel/värde-par som beskriver resursen. De här taggarna kan användas för att visa och gruppera den här resursen (mellan resursgrupper). Högst 15 taggar kan anges för en resurs. Varje tagg måste ha en nyckel som inte är större än 128 tecken och värdet får inte vara större än 256 tecken. Standardupplevelsen för en malltyp anges till exempel med "defaultExperience": "Cassandra". Aktuella "defaultExperience"-värden inkluderar även "Table", "Graph", "DocumentDB" och "MongoDB".

type

string

Typen av Azure-resurs.

MongoDBCollectionCreateUpdateParameters

Parametrar för att skapa och uppdatera Cosmos DB MongoDB-samlingen.

Name Typ Description
properties.options

object

Ett nyckel/värde-par med alternativ som ska tillämpas för begäran. Detta motsvarar de huvuden som skickas med begäran.

properties.resource

MongoDBCollectionResource

JSON-standardformatet för en MongoDB-samling

MongoDBCollectionResource

Cosmos DB MongoDB-samlingsresursobjekt

Name Typ Description
id

string

Namnet på Cosmos DB MongoDB-samlingen

indexes

MongoIndex[]

Lista över indexnycklar

shardKey

object

Ett nyckel/värde-par med shardnycklar som ska användas för begäran.

MongoIndex

Cosmos DB MongoDB-samlingsindexnyckel

Name Typ Description
key

MongoIndexKeys

Cosmos DB MongoDB-samlingsindexnycklar

options

MongoIndexOptions

Alternativ för Cosmos DB MongoDB-samlingsindexnyckel

MongoIndexKeys

Cosmos DB MongoDB-samlingsresursobjekt

Name Typ Description
keys

string[]

Lista över nycklar för varje MongoDB-samling i Azure Cosmos DB-tjänsten

MongoIndexOptions

Alternativ för Cosmos DB MongoDB-samlingsindex

Name Typ Description
expireAfterSeconds

integer

Upphör att gälla efter sekunder

unique

boolean

Är unik eller inte