Sql Resources - Migrate Sql Database To Autoscale

Service:: Cosmos DB Resource Provider

Version d’API:: 2026-03-15

Migrer une base de données SQL Azure Cosmos DB du débit manuel à la mise à l’échelle automatique

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
accountName	path	True	string minLength: 3 maxLength: 50 pattern: ^[a-z0-9]+(-[a-z0-9]+)*	Nom du compte de base de données Cosmos DB.
databaseName	path	True	string	Nom de la base de données Cosmos DB.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nom du groupe de ressources. Le nom ne respecte pas la casse.
subscriptionId	path	True	string (uuid)	ID de l’abonnement cible. La valeur doit être un UUID.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

Réponses

Nom	Type	Description
200 OK	ThroughputSettingsGetResults	Opération Azure terminée avec succès.
202 Accepted		Exploitation des ressources acceptée. En-têtes Azure-AsyncOperation: string Location: string Retry-After: integer
Other Status Codes	CloudError	Réponse d’erreur inattendue.

Nom

Type

Description

200 OK

ThroughputSettingsGetResults

Opération Azure terminée avec succès.

202 Accepted

Exploitation des ressources acceptée.

En-têtes

Azure-AsyncOperation: string
Location: string
Retry-After: integer

Other Status Codes

CloudError

Réponse d’erreur inattendue.

Sécurité

azure_auth

Flux OAuth2 d’Azure Active Directory.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	Usurper l’identité de votre compte utilisateur

Exemples

CosmosDBSqlDatabaseMigrateToAutoscale

Exemple de requête

POST https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/sqlDatabases/databaseName/throughputSettings/default/migrateToAutoscale?api-version=2026-03-15

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_sql_database_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="SUBSCRIPTION_ID",
    )

    response = client.sql_resources.begin_migrate_sql_database_to_autoscale(
        resource_group_name="rg1",
        account_name="ddb1",
        database_name="databaseName",
    ).result()
    print(response)


# x-ms-original-file: 2026-03-15/CosmosDBSqlDatabaseMigrateToAutoscale.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

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

/**
 * This sample demonstrates how to migrate an Azure Cosmos DB SQL database from manual throughput to autoscale
 *
 * @summary migrate an Azure Cosmos DB SQL database from manual throughput to autoscale
 * x-ms-original-file: 2026-03-15/CosmosDBSqlDatabaseMigrateToAutoscale.json
 */
async function cosmosDBSqlDatabaseMigrateToAutoscale() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-1111-2222-3333-444444444444";
  const client = new CosmosDBManagementClient(credential, subscriptionId);
  const result = await client.sqlResources.migrateSqlDatabaseToAutoscale(
    "rg1",
    "ddb1",
    "databaseName",
  );
  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

Exemple de réponse

Code d’état:: 200

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

Code d’état:: 202

Location: https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2026-03-15
Azure-AsyncOperation: https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2026-03-15

Définitions

Nom	Description
AutoscaleSettingsResource	Objet de paramètres de débit provisionnés Cosmos DB
AutoUpgradePolicyResource	Stratégie de mise à niveau automatique des ressources Cosmos DB
CloudError	Réponse d’erreur du service.
createdByType	Type d’identité qui a créé la ressource.
ErrorResponse	Réponse d’erreur.
ManagedServiceIdentity	Identité de la ressource.
ManagedServiceIdentityUserAssignedIdentities
ResourceIdentityType	Type d’identité utilisé pour la ressource. Le type « SystemAssigned, UserAssigned » inclut à la fois une identité créée implicitement et un ensemble d’identités affectées par l’utilisateur. Le type « None » supprime toutes les identités du service.
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.
ThroughputPolicyResource	Stratégie de débit des ressources Cosmos DB
ThroughputSettingsGetPropertiesResource
ThroughputSettingsGetResults	Débit d’une ressource Azure Cosmos DB.

AutoscaleSettingsResource

Objet

Objet de paramètres de débit provisionnés Cosmos DB

Nom	Type	Description
autoUpgradePolicy	AutoUpgradePolicyResource	Stratégie de mise à niveau automatique des ressources Cosmos DB
maxThroughput	integer (int32)	Représente le nombre maximal de conteneurs à débit pouvant être mis à l’échelle.
targetMaxThroughput	integer (int32)	Représente le débit maximal cible que le conteneur peut atteindre une fois que l’offre n’est plus à l’état en attente.

AutoUpgradePolicyResource

Objet

Stratégie de mise à niveau automatique des ressources Cosmos DB

Nom	Type	Description
throughputPolicy	ThroughputPolicyResource	Représente la stratégie de débit à laquelle le service doit adhérer pour la mise à niveau automatique

CloudError

Objet

Réponse d’erreur du service.

Nom	Type	Description
error	ErrorResponse	Réponse d’erreur.

createdByType

Énumération

Type d’identité qui a créé la ressource.

Valeur	Description
User
Application
ManagedIdentity
Key

ErrorResponse

Objet

Réponse d’erreur.

Nom	Type	Description
code	string	Code d’erreur.
message	string	Message d’erreur indiquant pourquoi l’opération a échoué.

ManagedServiceIdentity

Objet

Identité de la ressource.

Nom	Type	Description
principalId	string	ID principal de l’identité attribuée par le système. Cette propriété est fournie uniquement pour une identité affectée par le système.
tenantId	string	ID de locataire de l’identité attribuée par le système. Cette propriété est fournie uniquement pour une identité affectée par le système.
type	ResourceIdentityType	Type d’identité utilisé pour la ressource. Le type « SystemAssigned, UserAssigned » inclut à la fois une identité créée implicitement et un ensemble d’identités affectées par l’utilisateur. Le type « None » supprime toutes les identités du service.
userAssignedIdentities	<string, ManagedServiceIdentityUserAssignedIdentities>	Liste des identités utilisateur associées à la ressource. Les références de clé de dictionnaire d’identité utilisateur seront des ID de ressource ARM sous la forme : « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ».

ManagedServiceIdentityUserAssignedIdentities

Objet

Nom	Type	Description
clientId	string	ID client de l’identité affectée par l’utilisateur.
principalId	string	ID principal de l’identité affectée par l’utilisateur.

ResourceIdentityType

Énumération

Type d’identité utilisé pour la ressource. Le type « SystemAssigned, UserAssigned » inclut à la fois une identité créée implicitement et un ensemble d’identités affectées par l’utilisateur. Le type « None » supprime toutes les identités du service.

Valeur	Description
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned
None

systemData

Objet

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom	Type	Description
createdAt	string (date-time)	Horodatage de la création de ressources (UTC).
createdBy	string	Identité qui a créé la ressource.
createdByType	createdByType	Type d’identité qui a créé la ressource.
lastModifiedAt	string (date-time)	Horodatage de la dernière modification de ressource (UTC)
lastModifiedBy	string	Identité qui a modifié la ressource pour la dernière fois.
lastModifiedByType	createdByType	Type d’identité qui a modifié la ressource pour la dernière fois.

ThroughputPolicyResource

Objet

Stratégie de débit des ressources Cosmos DB

Nom	Type	Description
incrementPercent	integer (int32)	Représente le pourcentage par lequel le débit peut augmenter chaque fois que la stratégie de débit est lancée.
isEnabled	boolean	Détermine si La stratégie de débit est active ou non

ThroughputSettingsGetPropertiesResource

Objet

Nom	Type	Description
_etag	string	Propriété générée par le système représentant l’etag de ressource requis pour le contrôle optimiste de la concurrence.
_rid	string	Propriété générée par le système. Un identificateur unique.
_ts	number (float)	Propriété générée par le système qui indique l’horodatage de la dernière mise à jour de la ressource.
autoscaleSettings	AutoscaleSettingsResource	Ressource Cosmos DB pour les paramètres de mise à l’échelle automatique. Le débit est requis ou autoscaleSettings est requis, mais pas les deux.
instantMaximumThroughput	string	La valeur de débit de l’offre permet d’augmenter instantanément sans déclencher de divisions
minimumThroughput	string	Débit minimum de la ressource
offerReplacePending	string	Le remplacement du débit est en attente
softAllowedMaximumThroughput	string	Valeur de débit maximale ou valeur maxThroughput maximale (pour la mise à l’échelle automatique) qui peut être spécifiée
throughput	integer (int32)	Valeur du débit des ressources Cosmos DB. Le débit est requis ou autoscaleSettings est requis, mais pas les deux.

ThroughputSettingsGetResults

Objet

Débit d’une ressource Azure Cosmos DB.

Nom	Type	Description
id	string (arm-id)	Identifiant de ressource entièrement qualifié pour la ressource. Par exemple, « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} »
identity	ManagedServiceIdentity	Identité de la ressource.
location	string	Emplacement du groupe de ressources auquel appartient la ressource.
name	string	nom de la ressource.
properties.resource	ThroughputSettingsGetPropertiesResource
systemData	systemData	Métadonnées Azure Resource Manager contenant les informations createdBy et modifiedBy.
tags	object	Les balises sont une liste de paires clé-valeur qui décrivent la ressource. Ces balises peuvent être utilisées dans l’affichage et le regroupement de cette ressource (entre les groupes de ressources). Un maximum de 15 balises peut être fourni pour une ressource. Chaque balise doit avoir une clé supérieure à 128 caractères et une valeur supérieure à 256 caractères. Par exemple, l’expérience par défaut d’un type de modèle est définie avec « defaultExperience » : « Cassandra ». Les valeurs « defaultExperience » actuelles incluent également « Table », « Graph », « DocumentDB » et « MongoDB ».
type	string	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »