Gremlin Resources - Get Gremlin Database Throughput

Obtém as RUs por segundo do banco de dados Gremlin em uma conta de banco de dados existente do Azure Cosmos DB com o nome fornecido.

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

Parâmetros de URI

Name In Required Type Description
accountName
path True
  • string

Cosmos nome da conta de banco de dados do BD.

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

databaseName
path True
  • string

Cosmos nome do banco de dados do BD.

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 essa operação.

Respostas

Name Type Description
200 OK

As RUs por segundo do banco de dados Gremlin foram recuperadas com êxito.

Segurança

azure_auth

Flow Azure Active Directory OAuth2

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

CosmosDBGremlinDatabaseThroughputGet

Sample Request

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

Sample Response

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/gremlinDatabases/databaseName/throughputSettings/default",
  "name": "default",
  "type": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/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

Cosmos objeto de configurações de taxa de transferência provisionada por banco de dados

AutoUpgradePolicyResource

Cosmos política de atualização automática de recursos do BD

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

Cosmos política de taxa de transferência de recursos do BD

ThroughputSettingsGetResults

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

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

Cosmos objeto de configurações de taxa de transferência provisionada por banco de dados

Name Type Description
autoUpgradePolicy

Cosmos política de atualização automática de recursos do BD

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 escalado verticalmente até uma vez que a oferta não esteja mais no estado pendente.

AutoUpgradePolicyResource

Cosmos política de atualização automática de recursos do BD

Name Type Description
throughputPolicy

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

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 indica o último carimbo de data/hora atualizado do recurso.

autoscaleSettings

Cosmos recurso de BD para configurações de dimensionamento automático. A taxa de transferência é necessária ou as dimensionamentos automáticos são necessárias, mas não ambas.

minimumThroughput
  • string

A taxa de transferência mínima do recurso

offerReplacePending
  • string

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

throughput
  • integer

Valor da taxa de transferência do recurso Cosmos banco de dados. A taxa de transferência é necessária ou as dimensionamentos automáticos são necessárias, mas não ambas.

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

Cosmos política de taxa de transferência de recursos do BD

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 o ThroughputPolicy está ativo 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 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.

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