Table Resources - Migrate Table To Autoscale

Tjänst:: Cosmos DB Resource Provider

API-version:: 2026-03-15

Migrera en Azure Cosmos DB-tabell från manuellt dataflöde till autoskalning

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
accountName	path	True	string minLength: 3 maxLength: 50 pattern: ^[a-z0-9]+(-[a-z0-9]+)*	Namn på Cosmos DB-databaskonto.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
subscriptionId	path	True	string (uuid)	ID för målprenumerationen. Värdet måste vara ett UUID.
tableName	path	True	string	Namn på Cosmos DB-tabell.
api-version	query	True	string minLength: 1	Den API-version som ska användas för den här åtgärden.

Svar

Name	Typ	Description
200 OK	ThroughputSettingsGetResults	Azure-operationen slutfördes framgångsrikt.
202 Accepted		Resursåtgärden har godkänts. Sidhuvuden Azure-AsyncOperation: string Location: string Retry-After: integer
Other Status Codes	CloudError	Ett oväntat felsvar.

Name

Typ

Description

200 OK

ThroughputSettingsGetResults

Azure-operationen slutfördes framgångsrikt.

202 Accepted

Resursåtgärden har godkänts.

Sidhuvuden

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

Other Status Codes

CloudError

Ett oväntat felsvar.

Säkerhet

azure_auth

Azure Active Directory OAuth2-flöde.

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

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

CosmosDBTableMigrateToAutoscale

POST https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/tables/tableName/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_table_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.table_resources.begin_migrate_table_to_autoscale(
        resource_group_name="rg1",
        account_name="ddb1",
        table_name="tableName",
    ).result()
    print(response)


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

Exempelsvar

Statuskod:: 200

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

Statuskod:: 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

Definitioner

Name	Description
AutoscaleSettingsResource	Cosmos DB objekt för etablerade dataflödesinställningar
AutoUpgradePolicyResource	Princip för automatisk uppgradering av Cosmos DB-resurser
CloudError	Ett felsvar från tjänsten.
createdByType	Den typ av identitet som skapade resursen.
ErrorResponse	Svar på ett fel.
ManagedServiceIdentity	Identitet för resursen.
ManagedServiceIdentityUserAssignedIdentities
ResourceIdentityType	Den typ av identitet som används för resursen. Typen "SystemAssigned,UserAssigned" innehåller både en implicit skapad identitet och en uppsättning användartilldelade identiteter. Typen "Ingen" tar bort alla identiteter från tjänsten.
systemData	Metadata som rör skapande och senaste ändring av resursen.
ThroughputPolicyResource	Princip för Cosmos DB-resursdataflöde
ThroughputSettingsGetPropertiesResource
ThroughputSettingsGetResults	Ett dataflöde för Azure Cosmos DB-resursen.

AutoscaleSettingsResource

Objekt

Cosmos DB objekt för etablerade dataflödesinställningar

Name	Typ	Description
autoUpgradePolicy	AutoUpgradePolicyResource	Princip för automatisk uppgradering av Cosmos DB-resurser
maxThroughput	integer (int32)	Representerar maximalt dataflöde som containern kan skala upp till.
targetMaxThroughput	integer (int32)	Representerar det maximala dataflöde som containern kan skalas upp till när erbjudandet inte längre är i väntande tillstånd.

AutoUpgradePolicyResource

Objekt

Princip för automatisk uppgradering av Cosmos DB-resurser

Name	Typ	Description
throughputPolicy	ThroughputPolicyResource	Representerar den dataflödesprincip som tjänsten måste följa för automatisk uppgradering

CloudError

Objekt

Ett felsvar från tjänsten.

Name	Typ	Description
error	ErrorResponse	Svar på ett fel.

createdByType

Uppräkning

Den typ av identitet som skapade resursen.

Värde	Description
User
Application
ManagedIdentity
Key

ErrorResponse

Objekt

Svar på ett fel.

Name	Typ	Description
code	string	Felkod.
message	string	Felmeddelande som anger varför åtgärden misslyckades.

ManagedServiceIdentity

Objekt

Identitet för resursen.

Name	Typ	Description
principalId	string	Huvud-ID:t för den tilldelade systemidentiteten. Den här egenskapen tillhandahålls endast för en systemtilldelad identitet.
tenantId	string	Klientorganisations-ID:t för den tilldelade systemidentiteten. Den här egenskapen tillhandahålls endast för en systemtilldelad identitet.
type	ResourceIdentityType	Den typ av identitet som används för resursen. Typen "SystemAssigned,UserAssigned" innehåller både en implicit skapad identitet och en uppsättning användartilldelade identiteter. Typen "Ingen" tar bort alla identiteter från tjänsten.
userAssignedIdentities	<string, ManagedServiceIdentityUserAssignedIdentities>	Listan över användaridentiteter som är associerade med resursen. Nyckelreferenserna för användaridentitetsordlistan är ARM-resurs-ID:er i formuläret: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

ManagedServiceIdentityUserAssignedIdentities

Objekt

Name	Typ	Description
clientId	string	Klient-ID för användartilldelad identitet.
principalId	string	Huvud-ID för användartilldelad identitet.

ResourceIdentityType

Uppräkning

Den typ av identitet som används för resursen. Typen "SystemAssigned,UserAssigned" innehåller både en implicit skapad identitet och en uppsättning användartilldelade identiteter. Typen "Ingen" tar bort alla identiteter från tjänsten.

Värde	Description
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned
None

systemData

Objekt

Metadata som rör skapande och senaste ändring av resursen.

Name	Typ	Description
createdAt	string (date-time)	Tidsstämpeln för resursskapande (UTC).
createdBy	string	Identiteten som skapade resursen.
createdByType	createdByType	Den typ av identitet som skapade resursen.
lastModifiedAt	string (date-time)	Tidsstämpeln för resursens senaste ändring (UTC)
lastModifiedBy	string	Identiteten som senast ändrade resursen.
lastModifiedByType	createdByType	Den typ av identitet som senast ändrade resursen.

ThroughputPolicyResource

Objekt

Princip för Cosmos DB-resursdataflöde

Name	Typ	Description
incrementPercent	integer (int32)	Representerar den procentandel med vilken dataflödet kan öka varje gång dataflödesprincipen startar.
isEnabled	boolean	Avgör om ThroughputPolicy är aktiv eller inte

ThroughputSettingsGetPropertiesResource

Objekt

Name	Typ	Description
_etag	string	En systemgenererad egenskap som representerar den resurstagg som krävs för optimistisk samtidighetskontroll.
_rid	string	En systemgenererad egenskap. En unik identifierare.
_ts	number (float)	En systemgenererad egenskap som anger den senast uppdaterade tidsstämpeln för resursen.
autoscaleSettings	AutoscaleSettingsResource	Cosmos DB-resurs för autoskalningsinställningar. Antingen krävs dataflöde eller autoscaleSettings, men inte båda.
instantMaximumThroughput	string	Erbjudandets dataflödesvärde för att omedelbart skala upp utan att utlösa delningar
minimumThroughput	string	Minsta dataflöde för resursen
offerReplacePending	string	Ersättandet av dataflödet väntar
softAllowedMaximumThroughput	string	Det maximala dataflödesvärdet eller det maximala maxThroughput-värdet (för autoskalning) som kan anges
throughput	integer (int32)	Värdet för Cosmos DB-resursens dataflöde. Antingen krävs dataflöde eller autoscaleSettings, men inte båda.

ThroughputSettingsGetResults

Objekt

Ett dataflöde för Azure Cosmos DB-resursen.

Name	Typ	Description
id	string (arm-id)	Fullständigt kvalificerat resurs-ID för resursen. T.ex. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity	ManagedServiceIdentity	Identitet för resursen.
location	string	Platsen för den resursgrupp som resursen tillhör.
name	string	Namnet på resursen
properties.resource	ThroughputSettingsGetPropertiesResource
systemData	systemData	Azure Resource Manager-metadata som innehåller createdBy och modifiedBy information.
tags	object	Taggar är en lista över nyckel/värde-par som beskriver resursen. Dessa taggar 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	Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"