Mongo DB Resources - Update Mongo DB Database Throughput

Atualizar RUs por segundo de um banco de dados mongoDB do 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

Parâmetros de URI

Name In Required Type Description
accountName
path True
  • string

Nome da conta de banco de dados do Cosmos DB.

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

databaseName
path True
  • string

Nome do banco de dados do Cosmos DB.

resourceGroupName
path True
  • string

O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.

subscriptionId
path True
  • string

A ID da assinatura de destino.

api-version
query True
  • string

A versão da API a ser usada para esta operação.

Corpo da solicitação

Name Type Description
updateThroughputParameters

As RUs por segundo dos parâmetros a serem fornecidos para o banco de dados mongoDB atual.

Respostas

Name Type Description
200 OK

As RUs por segundo da operação de atualização do banco de dados MongoDB foram concluídas com êxito.

202 Accepted

As RUs por segundo da operação de atualização do banco de dados MongoDB serão concluídas de forma assíncrona.

Other Status Codes

Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

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

Scopes

Name Description
user_impersonation Representar sua conta de usuário

Exemplos

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\""
    }
  }
}

Definições

AutoscaleSettingsResource

Objeto de configurações de taxa de transferência provisionada do Cosmos DB

AutoUpgradePolicyResource

Política de atualização automática de recursos do Cosmos DB

CloudError

Uma resposta de erro do serviço.

ErrorResponse

Resposta de erro.

ManagedServiceIdentity

Identidade do recurso.

Resource
ResourceIdentityType

O tipo de identidade usado para o recurso. O tipo 'SystemAssigned,UserAssigned' inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo usuário. O tipo 'Nenhum' removerá as identidades do serviço.

ThroughputPolicyResource

Política de taxa de transferência de recursos do Cosmos DB

ThroughputSettingsGetResults

Uma taxa de transferência de recurso do Azure Cosmos DB.

ThroughputSettingsResource

Objeto de taxa de transferência de recurso do Cosmos DB. A taxa de transferência é necessária ou o dimensionamento automático deSettings é necessário, mas não ambos.

ThroughputSettingsUpdateParameters

As RUs por segundo dos parâmetros a serem fornecidos para o banco de dados mongoDB atual.

UserAssignedIdentities

A lista de identidades de usuário associadas ao recurso. As referências de chave do dicionário de identidade do usuário serão IDs de recurso do ARM no formulário: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

AutoscaleSettingsResource

Objeto de configurações de taxa de transferência provisionada do Cosmos DB

Name Type Description
autoUpgradePolicy

Política de atualização automática de recursos do Cosmos DB

maxThroughput
  • integer

Representa que o contêiner de taxa de transferência máxima pode ser escalado verticalmente.

targetMaxThroughput
  • integer

Representa que o contêiner de taxa de transferência máxima de destino pode ser dimensionado até que a oferta não esteja mais em estado pendente.

AutoUpgradePolicyResource

Política de atualização automática de recursos do Cosmos DB

Name Type Description
throughputPolicy

Representa a política de taxa de transferência à qual o serviço deve aderir para atualização automática

CloudError

Uma resposta de erro do serviço.

Name Type Description
error

Resposta de erro.

ErrorResponse

Resposta de erro.

Name Type Description
code
  • string

Código do erro.

message
  • string

Mensagem de erro indicando por que a operação falhou.

ManagedServiceIdentity

Identidade do recurso.

Name Type Description
principalId
  • string

A ID principal da identidade atribuída pelo sistema. Essa propriedade só será fornecida para uma identidade atribuída pelo sistema.

tenantId
  • string

A ID do locatário da identidade atribuída pelo sistema. Essa propriedade só será fornecida para uma identidade atribuída pelo sistema.

type

O tipo de identidade usado para o recurso. O tipo 'SystemAssigned,UserAssigned' inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo usuário. O tipo 'Nenhum' removerá as identidades do serviço.

userAssignedIdentities

A lista de identidades de usuário associadas ao recurso. As referências de chave do dicionário de identidade do usuário serão IDs de recurso do ARM no formulário: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

Resource

Name Type Description
_etag
  • string

Uma propriedade gerada pelo sistema que representa a etag de recurso necessária para o controle de simultaneidade otimista.

_rid
  • string

Uma propriedade gerada pelo sistema. Um identificador exclusivo.

_ts
  • number

Uma propriedade gerada pelo sistema que denota o último carimbo de data/hora atualizado do recurso.

autoscaleSettings

Recurso do Cosmos DB para configurações de dimensionamento automático. A taxa de transferência é necessária ou o dimensionamento automático deSettings é necessário, mas não ambos.

minimumThroughput
  • string

A taxa de transferência mínima do recurso

offerReplacePending
  • string

A substituição da taxa de transferência está pendente

throughput
  • integer

Valor da taxa de transferência de recursos do Cosmos DB. A taxa de transferência é necessária ou o dimensionamento automático deSettings é necessário, mas não ambos.

ResourceIdentityType

O tipo de identidade usado para o recurso. O tipo 'SystemAssigned,UserAssigned' inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo usuário. O tipo 'Nenhum' removerá as identidades do serviço.

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

ThroughputPolicyResource

Política de taxa de transferência de recursos do Cosmos DB

Name Type Description
incrementPercent
  • integer

Representa o percentual pelo qual a taxa de transferência pode aumentar sempre que a política de taxa de transferência começar.

isEnabled
  • boolean

Determina se a ThroughputPolicy está ativa ou não

ThroughputSettingsGetResults

Uma taxa de transferência de recurso do Azure Cosmos DB.

Name Type Description
id
  • string

O identificador de recurso exclusivo do recurso do ARM.

identity

Identidade do recurso.

location
  • string

O local do grupo de recursos ao qual o recurso pertence.

name
  • string

O nome do recurso arm.

properties.resource
tags
  • object

As marcas são uma lista de pares chave-valor que descrevem o recurso. Essas marcas podem ser usadas para exibir e agrupar esse recurso (entre grupos de recursos). Um máximo de 15 marcas pode ser fornecido para um recurso. Cada marca deve ter uma chave com no máximo 128 caracteres e um valor com no máximo 256 caracteres. Por exemplo, a experiência padrão para um tipo de modelo é definida com "defaultExperience": "Cassandra". Os valores atuais de "defaultExperience" também incluem "Table", "Graph", "DocumentDB" e "MongoDB".

type
  • string

O tipo de recurso do Azure.

ThroughputSettingsResource

Objeto de taxa de transferência de recurso do Cosmos DB. A taxa de transferência é necessária ou o dimensionamento automático deSettings é necessário, mas não ambos.

Name Type Description
autoscaleSettings

Recurso do Cosmos DB para configurações de dimensionamento automático. A taxa de transferência é necessária ou o dimensionamento automático deSettings é necessário, mas não ambos.

minimumThroughput
  • string

A taxa de transferência mínima do recurso

offerReplacePending
  • string

A substituição da taxa de transferência está pendente

throughput
  • integer

Valor da taxa de transferência de recursos do Cosmos DB. A taxa de transferência é necessária ou o dimensionamento automático deSettings é necessário, mas não ambos.

ThroughputSettingsUpdateParameters

As RUs por segundo dos parâmetros a serem fornecidos para o banco de dados mongoDB atual.

Name Type Description
id
  • string

O identificador de recurso exclusivo do recurso do ARM.

identity

Identidade do recurso.

location
  • string

O local do grupo de recursos ao qual o recurso pertence.

name
  • string

O nome do recurso arm.

properties.resource

O formato JSON padrão de uma taxa de transferência de recurso

tags
  • object

As marcas são uma lista de pares chave-valor que descrevem o recurso. Essas marcas podem ser usadas para exibir e agrupar esse recurso (entre grupos de recursos). Um máximo de 15 marcas pode ser fornecido para um recurso. Cada marca deve ter uma chave com no máximo 128 caracteres e um valor com no máximo 256 caracteres. Por exemplo, a experiência padrão para um tipo de modelo é definida com "defaultExperience": "Cassandra". Os valores atuais de "defaultExperience" também incluem "Table", "Graph", "DocumentDB" e "MongoDB".

type
  • string

O tipo de recurso do Azure.

UserAssignedIdentities

A lista de identidades de usuário associadas ao recurso. As referências de chave do dicionário de identidade do usuário serão IDs de recurso do ARM no formulário: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

Name Type Description