Cassandra Resources - Migrate Cassandra View To Manual Throughput

Service:: Cosmos DB Resource Provider

Version d'API:: 2025-11-01-preview

Migrer une vue Cassandra Azure Cosmos DB de la mise à l’échelle automatique vers le débit manuel

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/views/{viewName}/throughputSettings/default/migrateToManualThroughput?api-version=2025-11-01-preview

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.
keyspaceName	path	True	string	Nom de l’espace de clé 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 minLength: 1	ID de l’abonnement cible.
viewName	path	True	string	Nom de la vue Cosmos DB.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

Réponses

Nom	Type	Description
200 OK	ThroughputSettingsGetResults	L’opération de migration de la vue Cassandra s’est déroulée avec succès.
202 Accepted		L’opération de migration de la vue Cassandra se terminera de manière asynchrone. En-têtes azure-AsyncOperation: string location: string
Other Status Codes	CloudError	Réponse d’erreur décrivant pourquoi l’opération a échoué.

Nom

Type

Description

200 OK

ThroughputSettingsGetResults

L’opération de migration de la vue Cassandra s’est déroulée avec succès.

202 Accepted

L’opération de migration de la vue Cassandra se terminera de manière asynchrone.

En-têtes

azure-AsyncOperation: string
location: string

Other Status Codes

CloudError

Réponse d’erreur décrivant pourquoi l’opération a échoué.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

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

Étendues

Nom	Description
user_impersonation	Usurper votre compte d'utilisateur

Exemples

CosmosDBCassandraViewMigrateToManualThroughput

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/cassandraKeyspaces/keyspacename/views/viewname/throughputSettings/default/migrateToManualThroughput?api-version=2025-11-01-preview

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

/**
 * This sample demonstrates how to Migrate an Azure Cosmos DB Cassandra view from autoscale to manual throughput
 *
 * @summary Migrate an Azure Cosmos DB Cassandra view from autoscale to manual throughput
 * x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/DocumentDB/preview/2025-11-01-preview/examples/CosmosDBCassandraViewMigrateToManualThroughput.json
 */
async function cosmosDbCassandraViewMigrateToManualThroughput() {
  const subscriptionId = process.env["COSMOSDB_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["COSMOSDB_RESOURCE_GROUP"] || "rg1";
  const accountName = "ddb1";
  const keyspaceName = "keyspacename";
  const viewName = "viewname";
  const credential = new DefaultAzureCredential();
  const client = new CosmosDBManagementClient(credential, subscriptionId);
  const result = await client.cassandraResources.beginMigrateCassandraViewToManualThroughputAndWait(
    resourceGroupName,
    accountName,
    keyspaceName,
    viewName,
  );
  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,
      "minimumThroughput": "400",
      "offerReplacePending": "false"
    }
  }
}

Code d’état:: 202

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

Définitions

Nom	Description
AutoscaleSettingsResource	Objet de paramètres de débit provisionné Cosmos DB
AutoUpgradePolicyResource	Stratégie de mise à niveau automatique des ressources Cosmos DB
CloudError	Réponse d’erreur du service.
ErrorResponse	Réponse d’erreur.
ManagedServiceIdentity	Identité de la ressource.
Resource
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.
ThroughputBucketResource	Objet bucket de débit Cosmos DB
ThroughputPolicyResource	Stratégie de débit de ressources Cosmos DB
ThroughputSettingsGetResults	Débit d’une ressource Azure Cosmos DB.
UserAssignedIdentities	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} ».

AutoscaleSettingsResource

Objet

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

Nom	Type	Description
autoUpgradePolicy	AutoUpgradePolicyResource	Stratégie de mise à niveau automatique des ressources Cosmos DB
maxThroughput	integer	Représente le nombre maximal de conteneurs à débit pouvant être mis à l’échelle.
targetMaxThroughput	integer	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.

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	UserAssignedIdentities	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} ».

Resource

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 identifiant unique.
_ts	number	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	Valeur du débit des ressources Cosmos DB. Le débit est requis ou autoscaleSettings est requis, mais pas les deux.
throughputBuckets	ThroughputBucketResource[]	Tableau des limites de volume de débit à appliquer au conteneur Cosmos DB

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

ThroughputBucketResource

Objet

Objet bucket de débit Cosmos DB

Nom	Type	Description
id	integer (int32)	Représente l’ID du compartiment de débit
isDefaultBucket	boolean	Indique s’il s’agit du compartiment de débit par défaut
maxThroughputPercentage	integer (int32)	Représente le débit maximal de pourcentage qui peut être utilisé par le compartiment

ThroughputPolicyResource

Objet

Stratégie de débit de ressources Cosmos DB

Nom	Type	Description
incrementPercent	integer	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

ThroughputSettingsGetResults

Objet

Débit d’une ressource Azure Cosmos DB.

Nom	Type	Description
id	string	Identificateur de ressource unique de la ressource ARM.
identity	ManagedServiceIdentity	Identité de la ressource.
location	string	Emplacement du groupe de ressources auquel appartient la ressource.
name	string	Nom de la ressource ARM.
properties.resource	Resource
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 actuelles de « defaultExperience » incluent également « Table », « Graph », « DocumentDB » et « MongoDB ».
type	string	Type de ressource Azure.

UserAssignedIdentities

Objet

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} ».

Nom	Type	Description

Partager via

Cassandra Resources - Migrate Cassandra View To Manual Throughput

Paramètres URI

Réponses

Sécurité

azure_auth

Étendues

Exemples

CosmosDBCassandraViewMigrateToManualThroughput

Exemple de requête

Exemple de réponse

Définitions

AutoscaleSettingsResource

AutoUpgradePolicyResource

CloudError

ErrorResponse

ManagedServiceIdentity

Resource

ResourceIdentityType

ThroughputBucketResource

ThroughputPolicyResource

ThroughputSettingsGetResults

UserAssignedIdentities