Mongo DB Resources - Update Mongo DB Database Throughput

Aggiornare le UR al secondo di un database MongoDB di Azure Cosmos DB

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/throughputSettings/default?api-version=2021-11-15-preview

Parametri dell'URI

Name In Required Type Description
accountName
path True
  • string

Nome dell'account del database Cosmos DB.

Regex pattern: ^[a-z0-9]+(-[a-z0-9]+)*

databaseName
path True
  • string

Nome del database Cosmos DB.

resourceGroupName
path True
  • string

Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.

subscriptionId
path True
  • string

ID della sottoscrizione di destinazione.

api-version
query True
  • string

Versione dell'API da usare per questa operazione.

Corpo della richiesta

Name Type Description
updateThroughputParameters

Ur al secondo dei parametri da fornire per il database MongoDB corrente.

Risposte

Name Type Description
200 OK

Le UR al secondo dell'operazione di aggiornamento del database MongoDB sono state completate correttamente.

202 Accepted

Le UR al secondo dell'operazione di aggiornamento del database MongoDB verranno completate in modo asincrono.

Other Status Codes

Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

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

Scopes

Name Description
user_impersonation Rappresentare l'account utente

Esempio

CosmosDBMongoDBDatabaseThroughputUpdate

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/mongodbDatabases/databaseName/throughputSettings/default?api-version=2021-11-15-preview

{
  "location": "West US",
  "tags": {},
  "properties": {
    "resource": {
      "throughput": 400
    }
  }
}

Sample Response

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/mongodbDatabases/databaseName/throughputSettings/default",
  "name": "default",
  "type": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings",
  "location": "West US",
  "tags": {},
  "properties": {
    "resource": {
      "throughput": 400,
      "minimumThroughput": "400",
      "offerReplacePending": "true",
      "_rid": "PD5DALigDgw=",
      "_ts": 1459200611,
      "_etag": "\"00005900-0000-0000-0000-56f9a2630000\""
    }
  }
}

Definizioni

AutoscaleSettingsResource

Oggetto impostazioni velocità effettiva con provisioning di Cosmos DB

AutoUpgradePolicyResource

Criteri di aggiornamento automatico delle risorse di Cosmos DB

CloudError

Risposta di errore dal servizio.

ErrorResponse

Risposta errore.

ManagedServiceIdentity

Identità per la risorsa.

Resource
ResourceIdentityType

Tipo di identità usata per la risorsa. Il tipo 'SystemAssigned,UserAssigned' include sia un'identità creata in modo implicito che un set di identità assegnate dall'utente. Il tipo "Nessuno" rimuoverà le identità dal servizio.

ThroughputPolicyResource

Criteri di velocità effettiva delle risorse di Cosmos DB

ThroughputSettingsGetResults

Velocità effettiva delle risorse di Azure Cosmos DB.

ThroughputSettingsResource

Oggetto velocità effettiva delle risorse di Cosmos DB. La velocità effettiva è necessaria o è necessaria la scalabilità automaticaSettings, ma non entrambe.

ThroughputSettingsUpdateParameters

Ur al secondo dei parametri da fornire per il database MongoDB corrente.

UserAssignedIdentities

Elenco di identità utente associate alla risorsa. I riferimenti alla chiave del dizionario identità utente saranno ID risorsa ARM nel formato :'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

AutoscaleSettingsResource

Oggetto impostazioni velocità effettiva con provisioning di Cosmos DB

Name Type Description
autoUpgradePolicy

Criteri di aggiornamento automatico delle risorse di Cosmos DB

maxThroughput
  • integer

Rappresenta il contenitore di velocità effettiva massima in grado di aumentare le prestazioni.

targetMaxThroughput
  • integer

Rappresenta il contenitore di velocità effettiva massima di destinazione che può aumentare fino a una volta che l'offerta non è più in sospeso.

AutoUpgradePolicyResource

Criteri di aggiornamento automatico delle risorse di Cosmos DB

Name Type Description
throughputPolicy

Rappresenta i criteri di velocità effettiva che il servizio deve rispettare per l'aggiornamento automatico

CloudError

Risposta di errore dal servizio.

Name Type Description
error

Risposta errore.

ErrorResponse

Risposta errore.

Name Type Description
code
  • string

Codice di errore.

message
  • string

Messaggio di errore che indica il motivo per cui l'operazione non è riuscita.

ManagedServiceIdentity

Identità per la risorsa.

Name Type Description
principalId
  • string

ID dell'entità dell'identità assegnata dal sistema. Questa proprietà verrà fornita solo per un'identità assegnata dal sistema.

tenantId
  • string

ID tenant dell'identità assegnata dal sistema. Questa proprietà verrà fornita solo per un'identità assegnata dal sistema.

type

Tipo di identità usata per la risorsa. Il tipo 'SystemAssigned,UserAssigned' include sia un'identità creata in modo implicito che un set di identità assegnate dall'utente. Il tipo "Nessuno" rimuoverà le identità dal servizio.

userAssignedIdentities

Elenco di identità utente associate alla risorsa. I riferimenti alla chiave del dizionario identità utente saranno ID risorsa ARM nel formato :'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

Resource

Name Type Description
_etag
  • string

Proprietà generata dal sistema che rappresenta l'etag della risorsa necessaria per il controllo della concorrenza ottimistica.

_rid
  • string

Proprietà generata dal sistema. Identificatore univoco.

_ts
  • number

Proprietà generata dal sistema che indica il timestamp dell'ultimo aggiornamento della risorsa.

autoscaleSettings

Risorsa Cosmos DB per le impostazioni di scalabilità automatica. La velocità effettiva è necessaria o è necessaria la scalabilità automaticaSettings, ma non entrambe.

minimumThroughput
  • string

Velocità effettiva minima della risorsa

offerReplacePending
  • string

La sostituzione della velocità effettiva è in sospeso

throughput
  • integer

Valore della velocità effettiva delle risorse di Cosmos DB. La velocità effettiva è necessaria o è necessaria la scalabilità automaticaSettings, ma non entrambe.

ResourceIdentityType

Tipo di identità usata per la risorsa. Il tipo 'SystemAssigned,UserAssigned' include sia un'identità creata in modo implicito che un set di identità assegnate dall'utente. Il tipo "Nessuno" rimuoverà le identità dal servizio.

Name Type Description
None
  • string
SystemAssigned
  • string
SystemAssigned,UserAssigned
  • string
UserAssigned
  • string

ThroughputPolicyResource

Criteri di velocità effettiva delle risorse di Cosmos DB

Name Type Description
incrementPercent
  • integer

Rappresenta la percentuale in base alla quale la velocità effettiva può aumentare ogni volta che viene attivato il criterio di velocità effettiva.

isEnabled
  • boolean

Determina se ThroughputPolicy è attivo o meno

ThroughputSettingsGetResults

Velocità effettiva delle risorse di Azure Cosmos DB.

Name Type Description
id
  • string

Identificatore univoco della risorsa arm.

identity

Identità per la risorsa.

location
  • string

Posizione del gruppo di risorse a cui appartiene la risorsa.

name
  • string

Nome della risorsa arm.

properties.resource
tags
  • object

I tag sono un elenco di coppie chiave-valore che descrivono la risorsa. Questi tag possono essere utilizzati nella visualizzazione e nel raggruppamento di questa risorsa (tra gruppi di risorse). È possibile specificare un massimo di 15 tag per una risorsa. Ogni tag deve avere una chiave non superiore a 128 caratteri con un valore che non superi i 256 caratteri. Ad esempio, l'esperienza predefinita per un tipo di modello è impostata con "defaultExperience": "Cassandra". I valori correnti "defaultExperience" includono anche "Table", "Graph", "DocumentDB" e "MongoDB".

type
  • string

Tipo di risorsa di Azure.

ThroughputSettingsResource

Oggetto velocità effettiva delle risorse di Cosmos DB. La velocità effettiva è necessaria o è necessaria la scalabilità automaticaSettings, ma non entrambe.

Name Type Description
autoscaleSettings

Risorsa Cosmos DB per le impostazioni di scalabilità automatica. La velocità effettiva è necessaria o è necessaria la scalabilità automaticaSettings, ma non entrambe.

minimumThroughput
  • string

Velocità effettiva minima della risorsa

offerReplacePending
  • string

La sostituzione della velocità effettiva è in sospeso

throughput
  • integer

Valore della velocità effettiva delle risorse di Cosmos DB. La velocità effettiva è necessaria o è necessaria la scalabilità automaticaSettings, ma non entrambe.

ThroughputSettingsUpdateParameters

Ur al secondo dei parametri da fornire per il database MongoDB corrente.

Name Type Description
id
  • string

Identificatore univoco della risorsa arm.

identity

Identità per la risorsa.

location
  • string

Posizione del gruppo di risorse a cui appartiene la risorsa.

name
  • string

Nome della risorsa arm.

properties.resource

Formato JSON standard di una velocità effettiva delle risorse

tags
  • object

I tag sono un elenco di coppie chiave-valore che descrivono la risorsa. Questi tag possono essere utilizzati nella visualizzazione e nel raggruppamento di questa risorsa (tra gruppi di risorse). È possibile specificare un massimo di 15 tag per una risorsa. Ogni tag deve avere una chiave non superiore a 128 caratteri con un valore che non superi i 256 caratteri. Ad esempio, l'esperienza predefinita per un tipo di modello è impostata con "defaultExperience": "Cassandra". I valori correnti "defaultExperience" includono anche "Table", "Graph", "DocumentDB" e "MongoDB".

type
  • string

Tipo di risorsa di Azure.

UserAssignedIdentities

Elenco di identità utente associate alla risorsa. I riferimenti alla chiave del dizionario identità utente saranno ID risorsa ARM nel formato :'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

Name Type Description