Mongo DB Resources - Migrate Mongo DB Collection To Autoscale

Service:

Cosmos DB Resource Provider

API Version:

2023-03-15-preview

Migrieren einer MongoDB-Sammlung von Azure Cosmos DB vom manuellen Durchsatz zur automatischen Skalierung

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/collections/{collectionName}/throughputSettings/default/migrateToAutoscale?api-version=2023-03-15-preview

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
accountName	path	True	string	Name des Cosmos DB-Datenbankkontos. Regex pattern: ^[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	Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string	Hierbei handelt es sich um die ID des Zielabonnements.
api-version	query	True	string	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Antworten

Name	Typ	Beschreibung
200 OK	ThroughputSettingsGetResults	Der MongoDB-Sammlungsmigrationsvorgang wurde erfolgreich abgeschlossen.
202 Accepted		Der MongoDB-Sammlungsmigrationsvorgang wird asynchron abgeschlossen. Headers azure-AsyncOperation: string location: string
Other Status Codes	CloudError	Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

CosmosDBMongoDBCollectionMigrateToAutoscale

Sample Request

HTTP

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/mongodbDatabases/databaseName/collections/collectionName/throughputSettings/default/migrateToAutoscale?api-version=2023-03-15-preview

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.cosmosdb import CosmosDBManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-cosmosdb
# USAGE
    python cosmos_db_mongo_db_collection_migrate_to_autoscale.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = CosmosDBManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.mongo_db_resources.begin_migrate_mongo_db_collection_to_autoscale(
        resource_group_name="rg1",
        account_name="ddb1",
        database_name="databaseName",
        collection_name="collectionName",
    ).result()
    print(response)


# x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2023-03-15-preview/examples/CosmosDBMongoDBCollectionMigrateToAutoscale.json
if __name__ == "__main__":
    main()

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

Go

package armcosmos_test

import (
	"context"
	"log"

	"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/1b33e81bbdc28fcd6644a1315b8d7b1b6d030590/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2023-03-15-preview/examples/CosmosDBMongoDBCollectionMigrateToAutoscale.json
func ExampleMongoDBResourcesClient_BeginMigrateMongoDBCollectionToAutoscale() {
	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().BeginMigrateMongoDBCollectionToAutoscale(ctx, "rg1", "ddb1", "databaseName", "collectionName", 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.ThroughputSettingsGetResults = armcosmos.ThroughputSettingsGetResults{
	// 	Properties: &armcosmos.ThroughputSettingsGetProperties{
	// 		Resource: &armcosmos.ThroughputSettingsGetPropertiesResource{
	// 			Etag: to.Ptr("\"00005900-0000-0000-0000-56f9a2630000\""),
	// 			Rid: to.Ptr("PD5DALigDgw="),
	// 			Ts: to.Ptr[float32](1459200611),
	// 			AutoscaleSettings: &armcosmos.AutoscaleSettingsResource{
	// 				MaxThroughput: to.Ptr[int32](4000),
	// 			},
	// 			MinimumThroughput: to.Ptr("4000"),
	// 			OfferReplacePending: to.Ptr("false"),
	// 			Throughput: to.Ptr[int32](400),
	// 		},
	// 	},
	// }
}

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

JavaScript

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

/**
 * This sample demonstrates how to Migrate an Azure Cosmos DB MongoDB collection from manual throughput to autoscale
 *
 * @summary Migrate an Azure Cosmos DB MongoDB collection from manual throughput to autoscale
 * x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2023-03-15-preview/examples/CosmosDBMongoDBCollectionMigrateToAutoscale.json
 */
async function cosmosDbMongoDbcollectionMigrateToAutoscale() {
  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 credential = new DefaultAzureCredential();
  const client = new CosmosDBManagementClient(credential, subscriptionId);
  const result = await client.mongoDBResources.beginMigrateMongoDBCollectionToAutoscaleAndWait(
    resourceGroupName,
    accountName,
    databaseName,
    collectionName
  );
  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

Sample Response

Status code:

200

{
  "properties": {
    "resource": {
      "throughput": 400,
      "autoscaleSettings": {
        "maxThroughput": 4000
      },
      "minimumThroughput": "4000",
      "offerReplacePending": "false",
      "_rid": "PD5DALigDgw=",
      "_ts": 1459200611,
      "_etag": "\"00005900-0000-0000-0000-56f9a2630000\""
    }
  }
}

Status code:

202

azure-AsyncOperation: https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2023-03-15-preview
location: https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2023-03-15-preview

Definitionen

Name	Beschreibung
AutoscaleSettingsResource	Cosmos DB-Objekt für bereitgestellte Durchsatzeinstellungen
AutoUpgradePolicyResource	Richtlinie für automatisches Upgrade von Cosmos DB-Ressourcen
CloudError	Eine Fehlerantwort vom Dienst.
ErrorResponse	Fehlerantwort.
ManagedServiceIdentity	Identität für die Ressource.
Resource
ResourceIdentityType	Der Identitätstyp, der für die Ressource verwendet wird. Der Typ "SystemAssigned,UserAssigned" umfasst sowohl eine implizit erstellte Identität als auch eine Reihe von benutzerseitig zugewiesenen Identitäten. Der Typ "None" entfernt alle Identitäten aus dem Dienst.
ThroughputPolicyResource	Cosmos DB-Ressourcendurchsatzrichtlinie
ThroughputSettingsGetResults	Ein Azure Cosmos DB-Ressourcendurchsatz.
UserAssignedIdentities	Die Liste der Benutzeridentitäten, die der Ressource zugeordnet sind. Die Verweise auf das Benutzeridentitätswörterbuch sind ARM-Ressourcen-IDs im Format "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

AutoscaleSettingsResource

Cosmos DB-Objekt für bereitgestellte Durchsatzeinstellungen

Name	Typ	Beschreibung
autoUpgradePolicy	AutoUpgradePolicyResource	Richtlinie für automatisches Upgrade von Cosmos DB-Ressourcen
maxThroughput	integer	Stellt einen Container mit maximalem Durchsatz dar, auf den hochskaliert werden kann.
targetMaxThroughput	integer	Stellt den Zielcontainer für maximalen Durchsatz dar, der auf hochskaliert werden kann, sobald sich das Angebot nicht mehr im Status "Ausstehend" befindet.

AutoUpgradePolicyResource

Richtlinie für automatisches Upgrade von Cosmos DB-Ressourcen

Name	Typ	Beschreibung
throughputPolicy	ThroughputPolicyResource	Stellt eine Durchsatzrichtlinie dar, die der Dienst für das automatische Upgrade einhalten muss.

CloudError

Eine Fehlerantwort vom Dienst.

Name	Typ	Beschreibung
error	ErrorResponse	Fehlerantwort.

ErrorResponse

Fehlerantwort.

Name	Typ	Beschreibung
code	string	Fehlercode
message	string	Eine Fehlermeldung, die angibt, warum der Vorgang fehlgeschlagen ist.

ManagedServiceIdentity

Identität für die Ressource.

Name	Typ	Beschreibung
principalId	string	Die Prinzipal-ID der systemseitig zugewiesenen Identität. Diese Eigenschaft wird nur für eine systemseitig zugewiesene Identität bereitgestellt.
tenantId	string	Die Mandanten-ID der systemseitig zugewiesenen Identität. Diese Eigenschaft wird nur für eine systemseitig zugewiesene Identität bereitgestellt.
type	ResourceIdentityType	Der Identitätstyp, der für die Ressource verwendet wird. Der Typ "SystemAssigned,UserAssigned" umfasst sowohl eine implizit erstellte Identität als auch eine Reihe von benutzerseitig zugewiesenen Identitäten. Der Typ "None" entfernt alle Identitäten aus dem Dienst.
userAssignedIdentities	UserAssignedIdentities	Die Liste der Benutzeridentitäten, die der Ressource zugeordnet sind. Die Verweise auf das Benutzeridentitätswörterbuch sind ARM-Ressourcen-IDs im Format "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

Resource

Name	Typ	Beschreibung
_etag	string	Eine vom System generierte Eigenschaft, die das Ressourcen-etag darstellt, das für die Steuerung der optimistischen Parallelität erforderlich ist.
_rid	string	Eine vom System generierte Eigenschaft. Einen eindeutigen Bezeichner.
_ts	number	Eine vom System generierte Eigenschaft, die den letzten aktualisierten Zeitstempel der Ressource angibt.
autoscaleSettings	AutoscaleSettingsResource	Cosmos DB-Ressource für Einstellungen für die autoskalierte Skalierung. Entweder ist Durchsatz erforderlich, oder autoscaleSettings ist erforderlich, aber nicht beides.
minimumThroughput	string	Der minimale Durchsatz der Ressource
offerReplacePending	string	Der Durchsatzersetzung steht aus.
throughput	integer	Wert des Cosmos DB-Ressourcendurchsatzes. Entweder ist Durchsatz erforderlich, oder autoscaleSettings ist erforderlich, aber nicht beides.

ResourceIdentityType

Der Identitätstyp, der für die Ressource verwendet wird. Der Typ "SystemAssigned,UserAssigned" umfasst sowohl eine implizit erstellte Identität als auch eine Reihe von benutzerseitig zugewiesenen Identitäten. Der Typ "None" entfernt alle Identitäten aus dem Dienst.

Name	Typ	Beschreibung
None	string
SystemAssigned	string
SystemAssigned,UserAssigned	string
UserAssigned	string

ThroughputPolicyResource

Cosmos DB-Ressourcendurchsatzrichtlinie

Name	Typ	Beschreibung
incrementPercent	integer	Stellt den Prozentsatz dar, um den der Durchsatz bei jeder Einführung der Durchsatzrichtlinie erhöht werden kann.
isEnabled	boolean	Bestimmt, ob die ThroughputPolicy aktiv ist oder nicht.

ThroughputSettingsGetResults

Ein Azure Cosmos DB-Ressourcendurchsatz.

Name	Typ	Beschreibung
id	string	Der eindeutige Ressourcenbezeichner der ARM-Ressource.
identity	ManagedServiceIdentity	Identität für die Ressource.
location	string	Der Speicherort der Ressourcengruppe, zu der die Ressource gehört.
name	string	Der Name der ARM-Ressource.
properties.resource	Resource
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.

UserAssignedIdentities

Die Liste der Benutzeridentitäten, die der Ressource zugeordnet sind. Die Verweise auf das Benutzeridentitätswörterbuch sind ARM-Ressourcen-IDs im Format "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

Name	Typ	Beschreibung