Mongo DB Resources - Create Update Mongo DB Collection

Usługa:: Cosmos DB Resource Provider

Wersja interfejsu API:: 2025-04-15

Tworzenie lub aktualizowanie kolekcji bazy danych MongoDB usługi Azure Cosmos DB

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/collections/{collectionName}?api-version=2025-04-15

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
accountName	path	True	string minLength: 3 maxLength: 50 pattern: ^[a-z0-9]+(-[a-z0-9]+)*	Nazwa konta bazy danych usługi Cosmos DB.
collectionName	path	True	string	Nazwa kolekcji usługi Cosmos DB.
databaseName	path	True	string	Nazwa bazy danych usługi Cosmos DB.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
subscriptionId	path	True	string minLength: 1	Identyfikator subskrypcji docelowej.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.

Treść żądania

Nazwa	Typ	Opis
createUpdateMongoDBCollectionParameters	MongoDBCollectionCreateUpdateParameters	Parametry, które mają być podane dla bieżącej kolekcji bazy danych MongoDB.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	MongoDBCollectionGetResults	Operacja tworzenia lub aktualizowania kolekcji bazy danych MongoDB została ukończona pomyślnie.
202 Accepted		Operacja tworzenia lub aktualizowania kolekcji bazy danych MongoDB zostanie ukończona asynchronicznie. Nagłówki azure-AsyncOperation: string location: string

Nazwa

Typ

Opis

200 OK

MongoDBCollectionGetResults

Operacja tworzenia lub aktualizowania kolekcji bazy danych MongoDB została ukończona pomyślnie.

202 Accepted

Operacja tworzenia lub aktualizowania kolekcji bazy danych MongoDB zostanie ukończona asynchronicznie.

Nagłówki

azure-AsyncOperation: string
location: string

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	Personifikuj konto użytkownika

Przykłady

CosmosDBMongoDBCollectionCreateUpdate

Przykładowe żądanie

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/mongodbDatabases/databaseName/collections/collectionName?api-version=2025-04-15

{
  "location": "West US",
  "tags": {},
  "properties": {
    "resource": {
      "id": "collectionName",
      "indexes": [
        {
          "key": {
            "keys": [
              "_ts"
            ]
          },
          "options": {
            "expireAfterSeconds": 100,
            "unique": true
          }
        },
        {
          "key": {
            "keys": [
              "_id"
            ]
          }
        }
      ],
      "shardKey": {
        "testKey": "Hash"
      }
    },
    "options": {}
  }
}


import com.azure.resourcemanager.cosmos.models.CreateUpdateOptions;
import com.azure.resourcemanager.cosmos.models.MongoDBCollectionCreateUpdateParameters;
import com.azure.resourcemanager.cosmos.models.MongoDBCollectionResource;
import com.azure.resourcemanager.cosmos.models.MongoIndex;
import com.azure.resourcemanager.cosmos.models.MongoIndexKeys;
import com.azure.resourcemanager.cosmos.models.MongoIndexOptions;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for MongoDBResources CreateUpdateMongoDBCollection.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2025-04-15/examples/
     * CosmosDBMongoDBCollectionCreateUpdate.json
     */
    /**
     * Sample code: CosmosDBMongoDBCollectionCreateUpdate.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void cosmosDBMongoDBCollectionCreateUpdate(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.cosmosDBAccounts().manager().serviceClient().getMongoDBResources().createUpdateMongoDBCollection("rg1",
            "ddb1", "databaseName", "collectionName",
            new MongoDBCollectionCreateUpdateParameters().withLocation("West US").withTags(mapOf())
                .withResource(new MongoDBCollectionResource().withId("collectionName")
                    .withShardKey(mapOf("testKey", "fakeTokenPlaceholder"))
                    .withIndexes(Arrays.asList(
                        new MongoIndex().withKey(new MongoIndexKeys().withKeys(Arrays.asList("_ts")))
                            .withOptions(new MongoIndexOptions().withExpireAfterSeconds(100).withUnique(true)),
                        new MongoIndex().withKey(new MongoIndexKeys().withKeys(Arrays.asList("_id"))))))
                .withOptions(new CreateUpdateOptions()),
            com.azure.core.util.Context.NONE);
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armcosmos_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/cosmos/armcosmos/v3"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/011ecc5633300a5eefe43dde748f269d39e96458/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2025-04-15/examples/CosmosDBMongoDBCollectionCreateUpdate.json
func ExampleMongoDBResourcesClient_BeginCreateUpdateMongoDBCollection() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcosmos.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewMongoDBResourcesClient().BeginCreateUpdateMongoDBCollection(ctx, "rg1", "ddb1", "databaseName", "collectionName", armcosmos.MongoDBCollectionCreateUpdateParameters{
		Location: to.Ptr("West US"),
		Tags:     map[string]*string{},
		Properties: &armcosmos.MongoDBCollectionCreateUpdateProperties{
			Options: &armcosmos.CreateUpdateOptions{},
			Resource: &armcosmos.MongoDBCollectionResource{
				ID: to.Ptr("collectionName"),
				Indexes: []*armcosmos.MongoIndex{
					{
						Key: &armcosmos.MongoIndexKeys{
							Keys: []*string{
								to.Ptr("_ts")},
						},
						Options: &armcosmos.MongoIndexOptions{
							ExpireAfterSeconds: to.Ptr[int32](100),
							Unique:             to.Ptr(true),
						},
					},
					{
						Key: &armcosmos.MongoIndexKeys{
							Keys: []*string{
								to.Ptr("_id")},
						},
					}},
				ShardKey: map[string]*string{
					"testKey": to.Ptr("Hash"),
				},
			},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.MongoDBCollectionGetResults = armcosmos.MongoDBCollectionGetResults{
	// 	Name: to.Ptr("collectionName"),
	// 	Type: to.Ptr("Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/mongodbCollections"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/mongodbDatabases/databaseName/mongodbCollections/collectionName"),
	// 	Location: to.Ptr("West US"),
	// 	Tags: map[string]*string{
	// 	},
	// 	Properties: &armcosmos.MongoDBCollectionGetProperties{
	// 		Resource: &armcosmos.MongoDBCollectionGetPropertiesResource{
	// 			ID: to.Ptr("collectionName"),
	// 			Indexes: []*armcosmos.MongoIndex{
	// 				{
	// 					Key: &armcosmos.MongoIndexKeys{
	// 						Keys: []*string{
	// 							to.Ptr("_ts")},
	// 						},
	// 						Options: &armcosmos.MongoIndexOptions{
	// 							ExpireAfterSeconds: to.Ptr[int32](100),
	// 							Unique: to.Ptr(true),
	// 						},
	// 					},
	// 					{
	// 						Key: &armcosmos.MongoIndexKeys{
	// 							Keys: []*string{
	// 								to.Ptr("_id")},
	// 							},
	// 					}},
	// 					ShardKey: map[string]*string{
	// 						"testKey": to.Ptr("Hash"),
	// 					},
	// 				},
	// 			},
	// 		}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { CosmosDBManagementClient } = require("@azure/arm-cosmosdb");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Create or update an Azure Cosmos DB MongoDB Collection
 *
 * @summary Create or update an Azure Cosmos DB MongoDB Collection
 * x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2025-04-15/examples/CosmosDBMongoDBCollectionCreateUpdate.json
 */
async function cosmosDbMongoDbcollectionCreateUpdate() {
  const subscriptionId = process.env["COSMOSDB_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["COSMOSDB_RESOURCE_GROUP"] || "rg1";
  const accountName = "ddb1";
  const databaseName = "databaseName";
  const collectionName = "collectionName";
  const createUpdateMongoDBCollectionParameters = {
    location: "West US",
    options: {},
    resource: {
      id: "collectionName",
      indexes: [
        {
          key: { keys: ["_ts"] },
          options: { expireAfterSeconds: 100, unique: true },
        },
        { key: { keys: ["_id"] } },
      ],
      shardKey: { testKey: "Hash" },
    },
    tags: {},
  };
  const credential = new DefaultAzureCredential();
  const client = new CosmosDBManagementClient(credential, subscriptionId);
  const result = await client.mongoDBResources.beginCreateUpdateMongoDBCollectionAndWait(
    resourceGroupName,
    accountName,
    databaseName,
    collectionName,
    createUpdateMongoDBCollectionParameters,
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Przykładowa odpowiedź

Kod stanu:: 200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/mongodbDatabases/databaseName/mongodbCollections/collectionName",
  "name": "collectionName",
  "type": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/mongodbCollections",
  "location": "West US",
  "tags": {},
  "properties": {
    "resource": {
      "id": "collectionName",
      "indexes": [
        {
          "key": {
            "keys": [
              "_ts"
            ]
          },
          "options": {
            "expireAfterSeconds": 100,
            "unique": true
          }
        },
        {
          "key": {
            "keys": [
              "_id"
            ]
          }
        }
      ],
      "shardKey": {
        "testKey": "Hash"
      }
    }
  }
}

Kod stanu:: 202

Definicje

Nazwa	Opis
AutoscaleSettings
CreateMode	Enum to indicate the mode of account creation.
CreateUpdateOptions	Para klucz-wartość opcji, które mają zostać zastosowane do żądania. Odpowiada to nagłówkom wysyłanym z żądaniem.
MongoDBCollectionCreateUpdateParameters	Parametry, które mają być podane dla bieżącej kolekcji bazy danych MongoDB.
MongoDBCollectionGetResults	Kolekcja mongoDB usługi Azure Cosmos DB.
MongoDBCollectionResource	Obiekt zasobu kolekcji MongoDB usługi Cosmos DB
MongoIndex	Klucz indeksu kolekcji mongoDB usługi Cosmos DB
MongoIndexKeys	Obiekt zasobu kolekcji MongoDB usługi Cosmos DB
MongoIndexOptions	Opcje indeksu kolekcji Bazy danych MongoDB w usłudze Cosmos DB
Options
Resource
ResourceRestoreParameters	Parameters to indicate the information about the restore.

AutoscaleSettings

Objekt

Nazwa	Typ	Opis
maxThroughput	integer	Reprezentuje maksymalną przepływność, zasób może być skalowany w górę do.

CreateMode

Wyliczanie

Enum to indicate the mode of account creation.

Wartość	Opis
Default
Restore

CreateUpdateOptions

Objekt

Para klucz-wartość opcji, które mają zostać zastosowane do żądania. Odpowiada to nagłówkom wysyłanym z żądaniem.

Nazwa	Typ	Opis
autoscaleSettings	AutoscaleSettings	Określa ustawienia autoskalu. Uwaga: wymagana jest przepływność lub autoskalowanieUstawienia, ale nie obie.
throughput	integer	Liczba jednostek żądania na sekundę. Na przykład "przepływność": 10000.

MongoDBCollectionCreateUpdateParameters

Objekt

Parametry, które mają być podane dla bieżącej kolekcji bazy danych MongoDB.

Nazwa	Typ	Opis
id	string	Unikatowy identyfikator zasobu usługi ARM.
location	string	The location of the resource group to which the resource belongs.
name	string	Nazwa zasobu usługi ARM.
properties.options	CreateUpdateOptions	Para klucz-wartość opcji, które mają zostać zastosowane do żądania. Odpowiada to nagłówkom wysyłanym z żądaniem.
properties.resource	MongoDBCollectionResource	Standardowy format JSON kolekcji mongoDB
tags	object	Tagi to lista par klucz-wartość, które opisują zasób. Te tagi mogą służyć do wyświetlania i grupowania tego zasobu (między grupami zasobów). Dla zasobu można podać maksymalnie 15 tagów. Każdy tag musi mieć klucz nie większy niż 128 znaków i wartość nie większą niż 256 znaków. Na przykład domyślne środowisko dla typu szablonu jest ustawione z wartością "defaultExperience": "Cassandra". Bieżące wartości "defaultExperience" obejmują również wartości "Table", "Graph", "DocumentDB" i "MongoDB".
type	string	Typ zasobu platformy Azure.

MongoDBCollectionGetResults

Objekt

Kolekcja mongoDB usługi Azure Cosmos DB.

Nazwa	Typ	Opis
id	string	Unikatowy identyfikator zasobu usługi ARM.
location	string	The location of the resource group to which the resource belongs.
name	string	Nazwa zasobu usługi ARM.
properties.options	Options
properties.resource	Resource
tags	object	Tagi to lista par klucz-wartość, które opisują zasób. Te tagi mogą służyć do wyświetlania i grupowania tego zasobu (między grupami zasobów). Dla zasobu można podać maksymalnie 15 tagów. Każdy tag musi mieć klucz nie większy niż 128 znaków i wartość nie większą niż 256 znaków. Na przykład domyślne środowisko dla typu szablonu jest ustawione z wartością "defaultExperience": "Cassandra". Bieżące wartości "defaultExperience" obejmują również wartości "Table", "Graph", "DocumentDB" i "MongoDB".
type	string	Typ zasobu platformy Azure.

MongoDBCollectionResource

Objekt

Obiekt zasobu kolekcji MongoDB usługi Cosmos DB

Nazwa	Typ	Domyślna wartość	Opis
analyticalStorageTtl	integer		Analityczny czas wygaśnięcia.
createMode	CreateMode	Default	Wyliczenie wskazujące tryb tworzenia zasobów.
id	string		Nazwa kolekcji MongoDB usługi Cosmos DB
indexes	MongoIndex[]		Lista kluczy indeksu
restoreParameters	ResourceRestoreParameters		Parametry wskazujące informacje o przywracaniu
shardKey	object		Para klucz-wartość kluczy do zastosowania dla żądania.

MongoIndex

Objekt

Klucz indeksu kolekcji mongoDB usługi Cosmos DB

Nazwa	Typ	Opis
key	MongoIndexKeys	Klucze indeksu kolekcji mongoDB usługi Cosmos DB
options	MongoIndexOptions	Opcje klucza indeksu kolekcji MongoDB usługi Cosmos DB

MongoIndexKeys

Objekt

Obiekt zasobu kolekcji MongoDB usługi Cosmos DB

Nazwa	Typ	Opis
keys	string[]	Lista kluczy dla każdej kolekcji bazy danych MongoDB w usłudze Azure Cosmos DB

MongoIndexOptions

Objekt

Opcje indeksu kolekcji Bazy danych MongoDB w usłudze Cosmos DB

Nazwa	Typ	Opis
expireAfterSeconds	integer	Wygaśnięcie po sekundach
unique	boolean	Jest unikatowy lub nie

Options

Objekt

Nazwa	Typ	Opis
autoscaleSettings	AutoscaleSettings	Określa ustawienia autoskalu.
throughput	integer	Wartość przepływności zasobu usługi Cosmos DB lub autoskalowaniaUstawienia. Użyj zasobu PrzepływnośćUstawienia podczas pobierania szczegółów oferty.

Resource

Objekt

Nazwa	Typ	Domyślna wartość	Opis
_etag	string		Właściwość wygenerowana przez system reprezentująca element etag zasobu wymagany do optymistycznej kontroli współbieżności.
_rid	string		Właściwość wygenerowana przez system. Unikatowy identyfikator.
_ts	number		Właściwość wygenerowana przez system, która określa ostatnio zaktualizowany znacznik czasu zasobu.
analyticalStorageTtl	integer		Analityczny czas wygaśnięcia.
createMode	CreateMode	Default	Wyliczenie wskazujące tryb tworzenia zasobów.
id	string		Nazwa kolekcji MongoDB usługi Cosmos DB
indexes	MongoIndex[]		Lista kluczy indeksu
restoreParameters	ResourceRestoreParameters		Parametry wskazujące informacje o przywracaniu
shardKey	object		Para klucz-wartość kluczy do zastosowania dla żądania.

ResourceRestoreParameters

Objekt

Parameters to indicate the information about the restore.

Nazwa	Typ	Opis
restoreSource	string	The id of the restorable database account from which the restore has to be initiated. For example: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}
restoreTimestampInUtc	string (date-time)	Time to which the account has to be restored (ISO-8601 format).
restoreWithTtlDisabled	boolean	Określa, czy przywrócone konto będzie mieć czas-To-Live wyłączone po pomyślnym przywróceniu.

Udostępnij za pośrednictwem

Mongo DB Resources - Create Update Mongo DB Collection

Parametry identyfikatora URI

Treść żądania

Odpowiedzi

Zabezpieczenia

azure_auth

Zakresy

Przykłady

CosmosDBMongoDBCollectionCreateUpdate

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

AutoscaleSettings

CreateMode

CreateUpdateOptions

MongoDBCollectionCreateUpdateParameters

MongoDBCollectionGetResults

MongoDBCollectionResource

MongoIndex

MongoIndexKeys

MongoIndexOptions

Options

Resource

ResourceRestoreParameters