Mongo DB Resources - Update Mongo DB Database Throughput
Actualización de ru por segundo de una base de datos de MongoDB de Azure Cosmos DB
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/throughputSettings/default?api-version=2023-11-15
Parámetros de identificador URI
Nombre | En | Requerido | Tipo | Description |
---|---|---|---|---|
account
|
path | True |
string |
Nombre de la cuenta de base de datos de Cosmos DB. Regex pattern: |
database
|
path | True |
string |
Nombre de la base de datos de Cosmos DB. |
resource
|
path | True |
string |
Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas. |
subscription
|
path | True |
string |
Identificador de la suscripción de destino. |
api-version
|
query | True |
string |
Versión de API que se usará para la operación. |
Cuerpo de la solicitud
Nombre | Tipo | Description |
---|---|---|
updateThroughputParameters |
Las RU por segundo de los parámetros que se van a proporcionar para la base de datos de MongoDB actual. |
Respuestas
Nombre | Tipo | Description |
---|---|---|
200 OK |
Las RU por segundo de la operación de actualización de base de datos de MongoDB se completaron correctamente. |
|
202 Accepted |
Las RU por segundo de la operación de actualización de base de datos de MongoDB se completarán de forma asincrónica. Headers
|
|
Other Status Codes |
Respuesta de error que describe el motivo del error de la operación. |
Seguridad
azure_auth
Flujo OAuth2 de Azure Active Directory
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Nombre | Description |
---|---|
user_impersonation | Suplantación de su cuenta de usuario |
Ejemplos
CosmosDBMongoDBDatabaseThroughputUpdate
Sample Request
PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/mongodbDatabases/databaseName/throughputSettings/default?api-version=2023-11-15
{
"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\""
}
}
}
Definiciones
Nombre | Description |
---|---|
Autoscale |
Objeto de configuración de rendimiento aprovisionado de Cosmos DB |
Auto |
Directiva de actualización automática de recursos de Cosmos DB |
Cloud |
Respuesta de error del servicio. |
Error |
Respuesta de error. |
Resource | |
Throughput |
Directiva de rendimiento de recursos de Cosmos DB |
Throughput |
Un rendimiento de recursos de Azure Cosmos DB. |
Throughput |
Objeto de rendimiento de recursos de Cosmos DB. Se requiere el rendimiento o se requiere autoscaleSettings, pero no ambos. |
Throughput |
Las RU por segundo de los parámetros que se van a proporcionar para la base de datos de MongoDB actual. |
AutoscaleSettingsResource
Objeto de configuración de rendimiento aprovisionado de Cosmos DB
Nombre | Tipo | Description |
---|---|---|
autoUpgradePolicy |
Directiva de actualización automática de recursos de Cosmos DB |
|
maxThroughput |
integer |
Representa el contenedor de rendimiento máximo al que se puede escalar verticalmente. |
targetMaxThroughput |
integer |
Representa el contenedor de rendimiento máximo de destino que se puede escalar verticalmente una vez que la oferta ya no está en estado pendiente. |
AutoUpgradePolicyResource
Directiva de actualización automática de recursos de Cosmos DB
Nombre | Tipo | Description |
---|---|---|
throughputPolicy |
Representa la directiva de rendimiento que el servicio debe cumplir para la actualización automática. |
CloudError
Respuesta de error del servicio.
Nombre | Tipo | Description |
---|---|---|
error |
Respuesta de error. |
ErrorResponse
Respuesta de error.
Nombre | Tipo | Description |
---|---|---|
code |
string |
Código de error. |
message |
string |
Mensaje de error que indica por qué se produjo un error en la operación. |
Resource
Nombre | Tipo | Description |
---|---|---|
_etag |
string |
Propiedad generada por el sistema que representa la etag de recursos necesaria para el control de simultaneidad optimista. |
_rid |
string |
Propiedad generada por el sistema. Identificador único. |
_ts |
number |
Propiedad generada por el sistema que indica la última marca de tiempo actualizada del recurso. |
autoscaleSettings |
Recurso de Cosmos DB para la configuración de escalabilidad automática. Se requiere el rendimiento o se requiere autoscaleSettings, pero no ambos. |
|
instantMaximumThroughput |
string |
Valor de rendimiento de la oferta para escalar verticalmente al instante sin desencadenar divisiones |
minimumThroughput |
string |
Rendimiento mínimo del recurso |
offerReplacePending |
string |
El reemplazo del rendimiento está pendiente |
softAllowedMaximumThroughput |
string |
El valor de rendimiento máximo o el valor máximo de maxThroughput (para la escalabilidad automática) que se puede especificar. |
throughput |
integer |
Valor del rendimiento de los recursos de Cosmos DB. Se requiere el rendimiento o se requiere autoscaleSettings, pero no ambos. |
ThroughputPolicyResource
Directiva de rendimiento de recursos de Cosmos DB
Nombre | Tipo | Description |
---|---|---|
incrementPercent |
integer |
Representa el porcentaje por el que el rendimiento puede aumentar cada vez que se inicia la directiva de rendimiento. |
isEnabled |
boolean |
Determina si ThroughputPolicy está activo o no. |
ThroughputSettingsGetResults
Un rendimiento de recursos de Azure Cosmos DB.
Nombre | Tipo | Description |
---|---|---|
id |
string |
Identificador de recurso único del recurso de ARM. |
location |
string |
Ubicación del grupo de recursos al que pertenece el recurso. |
name |
string |
Nombre del recurso de ARM. |
properties.resource | ||
tags |
object |
Las etiquetas son una lista de pares clave-valor que describen el recurso. Estas etiquetas pueden utilizarse para visualizar y agrupar este recurso a través de grupos de recursos. Se puede proporcionar un máximo de 15 etiquetas para un recurso. Cada etiqueta debe tener una clave no superior a 128 caracteres y un valor no superior a 256 caracteres. Por ejemplo, la experiencia predeterminada para un tipo de plantilla se establece con "defaultExperience": "Cassandra". Los valores actuales "defaultExperience" también incluyen "Table", "Graph", "DocumentDB" y "MongoDB". |
type |
string |
Tipo de recurso de Azure. |
ThroughputSettingsResource
Objeto de rendimiento de recursos de Cosmos DB. Se requiere el rendimiento o se requiere autoscaleSettings, pero no ambos.
Nombre | Tipo | Description |
---|---|---|
autoscaleSettings |
Recurso de Cosmos DB para la configuración de escalabilidad automática. Se requiere el rendimiento o se requiere autoscaleSettings, pero no ambos. |
|
instantMaximumThroughput |
string |
Valor de rendimiento de la oferta para escalar verticalmente al instante sin desencadenar divisiones |
minimumThroughput |
string |
Rendimiento mínimo del recurso |
offerReplacePending |
string |
El reemplazo del rendimiento está pendiente |
softAllowedMaximumThroughput |
string |
El valor de rendimiento máximo o el valor máximo de maxThroughput (para la escalabilidad automática) que se puede especificar. |
throughput |
integer |
Valor del rendimiento de los recursos de Cosmos DB. Se requiere el rendimiento o se requiere autoscaleSettings, pero no ambos. |
ThroughputSettingsUpdateParameters
Las RU por segundo de los parámetros que se van a proporcionar para la base de datos de MongoDB actual.
Nombre | Tipo | Description |
---|---|---|
id |
string |
Identificador de recurso único del recurso de ARM. |
location |
string |
Ubicación del grupo de recursos al que pertenece el recurso. |
name |
string |
Nombre del recurso de ARM. |
properties.resource |
El formato JSON estándar de un rendimiento de recursos |
|
tags |
object |
Las etiquetas son una lista de pares clave-valor que describen el recurso. Estas etiquetas pueden utilizarse para visualizar y agrupar este recurso a través de grupos de recursos. Se puede proporcionar un máximo de 15 etiquetas para un recurso. Cada etiqueta debe tener una clave no superior a 128 caracteres y un valor no superior a 256 caracteres. Por ejemplo, la experiencia predeterminada para un tipo de plantilla se establece con "defaultExperience": "Cassandra". Los valores actuales "defaultExperience" también incluyen "Table", "Graph", "DocumentDB" y "MongoDB". |
type |
string |
Tipo de recurso de Azure. |