Cassandra Resources - Update Cassandra Keyspace Throughput

Actualización de ru por segundo de un espacio de claves de Cassandra de Azure Cosmos DB

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/throughputSettings/default?api-version=2021-07-01-preview

Parámetros de identificador URI

Name In Required Type Description
accountName
path True
  • string

Nombre de la cuenta de base de datos de Cosmos DB.

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

keyspaceName
path True
  • string

Nombre del espacio de claves de Cosmos DB.

resourceGroupName
path True
  • string

Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.

subscriptionId
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

Name Required Type Description
properties.resource True

El formato JSON estándar de un rendimiento de recursos

identity

Identidad del recurso.

location
  • string

Ubicación del grupo de recursos al que pertenece el recurso.

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".

Respuestas

Name Type Description
200 OK

Las RU por segundo de la operación de actualización de Cassandra Keyspace se completaron correctamente.

202 Accepted

Las RU por segundo de la operación de actualización de Cassandra Keyspace se completarán de forma asincrónica.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory

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

Scopes

Name Description
user_impersonation Suplantación de su cuenta de usuario

Ejemplos

CosmosDBCassandraKeyspaceThroughputUpdate

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/cassandraKeyspaces/keyspaceName/throughputSettings/default?api-version=2021-07-01-preview

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

Sample Response

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

Definiciones

AutoscaleSettingsResource

Objeto de configuración de rendimiento aprovisionado de Cosmos DB

AutoUpgradePolicyResource

Directiva de actualización automática de recursos de Cosmos DB

ManagedServiceIdentity

Identidad del recurso.

Resource
ResourceIdentityType

Tipo de identidad que se usa para el recurso. El tipo "SystemAssigned",UserAssigned" incluye una identidad creada implícitamente y un conjunto de identidades asignadas por el usuario. El tipo "None" quitará las identidades del servicio.

ThroughputPolicyResource

Directiva de rendimiento de recursos de Cosmos DB

ThroughputSettingsGetResults

Un rendimiento de recursos de Azure Cosmos DB.

ThroughputSettingsResource

Objeto de rendimiento de recursos de Cosmos DB. Se requiere el rendimiento o se requiere autoscaleSettings, pero no ambos.

ThroughputSettingsUpdateParameters

Parámetros para actualizar el rendimiento de los recursos de Cosmos DB.

UserAssignedIdentities

Lista de identidades de usuario asociadas al recurso. Las referencias de clave del diccionario de identidades de usuario serán identificadores de recurso de ARM con el formato : '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

AutoscaleSettingsResource

Objeto de configuración de rendimiento aprovisionado de Cosmos DB

Name Type 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

Name Type Description
throughputPolicy

Representa la directiva de rendimiento que el servicio debe cumplir para la actualización automática.

ManagedServiceIdentity

Identidad del recurso.

Name Type Description
principalId
  • string

Identificador de entidad de seguridad de la identidad asignada por el sistema. Esta propiedad solo se proporcionará para una identidad asignada por el sistema.

tenantId
  • string

Identificador de inquilino de la identidad asignada por el sistema. Esta propiedad solo se proporcionará para una identidad asignada por el sistema.

type

Tipo de identidad que se usa para el recurso. El tipo "SystemAssigned",UserAssigned" incluye una identidad creada implícitamente y un conjunto de identidades asignadas por el usuario. El tipo "None" quitará las identidades del servicio.

userAssignedIdentities

Lista de identidades de usuario asociadas al recurso. Las referencias de clave del diccionario de identidades de usuario serán identificadores de recurso de ARM con el formato : '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

Resource

Name Type 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.

minimumThroughput
  • string

Rendimiento mínimo del recurso

offerReplacePending
  • string

El reemplazo del rendimiento está pendiente

throughput
  • integer

Valor del rendimiento de los recursos de Cosmos DB. Se requiere el rendimiento o se requiere autoscaleSettings, pero no ambos.

ResourceIdentityType

Tipo de identidad que se usa para el recurso. El tipo "SystemAssigned",UserAssigned" incluye una identidad creada implícitamente y un conjunto de identidades asignadas por el usuario. El tipo "None" quitará las identidades del servicio.

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

ThroughputPolicyResource

Directiva de rendimiento de recursos de Cosmos DB

Name Type 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.

Name Type Description
id
  • string

Identificador de recurso único del recurso de ARM.

identity

Identidad del recurso.

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.

Name Type 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.

minimumThroughput
  • string

Rendimiento mínimo del recurso

offerReplacePending
  • string

El reemplazo del rendimiento está pendiente

throughput
  • integer

Valor del rendimiento de los recursos de Cosmos DB. Se requiere el rendimiento o se requiere autoscaleSettings, pero no ambos.

ThroughputSettingsUpdateParameters

Parámetros para actualizar el rendimiento de los recursos de Cosmos DB.

Name Type Description
id
  • string

Identificador de recurso único del recurso de ARM.

identity

Identidad del recurso.

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.

UserAssignedIdentities

Lista de identidades de usuario asociadas al recurso. Las referencias de clave del diccionario de identidades de usuario serán identificadores de recurso de ARM con el formato : '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

Name Type Description