Gremlin Resources - Get Gremlin Database Throughput

Service:

Cosmos DB Resource Provider

API Version:

2023-11-15

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=2023-11-15

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	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.

Respostas

Nome	Tipo	Description
200 OK	ThroughputSettingsGetResults	As RUs por segundo do banco de dados Gremlin foram recuperadas com êxito.

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory

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

Scopes

Nome	Description
user_impersonation	Representar sua conta de usuário

Exemplos

CosmosDBGremlinDatabaseThroughputGet

Sample Request

HTTP

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

Java

/**
 * Samples for GremlinResources GetGremlinDatabaseThroughput.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/
     * CosmosDBGremlinDatabaseThroughputGet.json
     */
    /**
     * Sample code: CosmosDBGremlinDatabaseThroughputGet.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void cosmosDBGremlinDatabaseThroughputGet(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.cosmosDBAccounts().manager().serviceClient().getGremlinResources()
            .getGremlinDatabaseThroughputWithResponse("rg1", "ddb1", "databaseName", com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.cosmosdb import CosmosDBManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-cosmosdb
# USAGE
    python cosmos_db_gremlin_database_throughput_get.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = CosmosDBManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.gremlin_resources.get_gremlin_database_throughput(
        resource_group_name="rg1",
        account_name="ddb1",
        database_name="databaseName",
    )
    print(response)


# x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBGremlinDatabaseThroughputGet.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armcosmos_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/cosmos/armcosmos/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/41e4538ed7bb3ceac3c1322c9455a0812ed110ac/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBGremlinDatabaseThroughputGet.json
func ExampleGremlinResourcesClient_GetGremlinDatabaseThroughput() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcosmos.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewGremlinResourcesClient().GetGremlinDatabaseThroughput(ctx, "rg1", "ddb1", "databaseName", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.ThroughputSettingsGetResults = armcosmos.ThroughputSettingsGetResults{
	// 	Name: to.Ptr("default"),
	// 	Type: to.Ptr("Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/throughputSettings"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/gremlinDatabases/databaseName/throughputSettings/default"),
	// 	Location: to.Ptr("West US"),
	// 	Tags: map[string]*string{
	// 	},
	// 	Properties: &armcosmos.ThroughputSettingsGetProperties{
	// 		Resource: &armcosmos.ThroughputSettingsGetPropertiesResource{
	// 			Etag: to.Ptr("\"00005900-0000-0000-0000-56f9a2630000\""),
	// 			Rid: to.Ptr("PD5DALigDgw="),
	// 			Ts: to.Ptr[float32](1459200611),
	// 			InstantMaximumThroughput: to.Ptr("10000"),
	// 			MinimumThroughput: to.Ptr("400"),
	// 			OfferReplacePending: to.Ptr("true"),
	// 			SoftAllowedMaximumThroughput: to.Ptr("1000000"),
	// 			Throughput: to.Ptr[int32](400),
	// 		},
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { CosmosDBManagementClient } = require("@azure/arm-cosmosdb");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets the RUs per second of the Gremlin database under an existing Azure Cosmos DB database account with the provided name.
 *
 * @summary Gets the RUs per second of the Gremlin database under an existing Azure Cosmos DB database account with the provided name.
 * x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBGremlinDatabaseThroughputGet.json
 */
async function cosmosDbGremlinDatabaseThroughputGet() {
  const subscriptionId = process.env["COSMOSDB_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["COSMOSDB_RESOURCE_GROUP"] || "rg1";
  const accountName = "ddb1";
  const databaseName = "databaseName";
  const credential = new DefaultAzureCredential();
  const client = new CosmosDBManagementClient(credential, subscriptionId);
  const result = await client.gremlinResources.getGremlinDatabaseThroughput(
    resourceGroupName,
    accountName,
    databaseName,
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

200

{
  "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",
      "instantMaximumThroughput": "10000",
      "softAllowedMaximumThroughput": "1000000",
      "_rid": "PD5DALigDgw=",
      "_ts": 1459200611,
      "_etag": "\"00005900-0000-0000-0000-56f9a2630000\""
    }
  }
}

Definições

Nome	Description
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
Resource
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.

AutoscaleSettingsResource

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

Nome	Tipo	Description
autoUpgradePolicy	AutoUpgradePolicyResource	Política de atualização automática de recursos do Cosmos DB
maxThroughput	integer	Representa o contêiner de taxa de transferência máxima que pode escalar verticalmente.
targetMaxThroughput	integer	Representa que o contêiner de taxa de transferência máxima de destino pode ser escalado verticalmente até quando a oferta não estiver mais no estado pendente.

AutoUpgradePolicyResource

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

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

Resource

Nome	Tipo	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	AutoscaleSettingsResource	Recurso do Cosmos DB para configurações de dimensionamento automático. A taxa de transferência é necessária ou dimensionamento automáticoConfigurações é necessária, mas não ambas.
instantMaximumThroughput	string	O valor da taxa de transferência da oferta para escalar verticalmente instantaneamente sem disparar divisões
minimumThroughput	string	A taxa de transferência mínima do recurso
offerReplacePending	string	A substituição de taxa de transferência está pendente
softAllowedMaximumThroughput	string	O valor máximo da taxa de transferência ou o valor máximo de maxThroughput (para dimensionamento automático) que pode ser especificado
throughput	integer	Valor da taxa de transferência do recurso do Cosmos DB. A taxa de transferência é necessária ou dimensionamento automáticoConfigurações é necessária, mas não ambas.

ThroughputPolicyResource

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

Nome	Tipo	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 é iniciada.
isEnabled	boolean	Determina se a ThroughputPolicy está ativa ou não

ThroughputSettingsGetResults

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

Nome	Tipo	Description
id	string	O identificador de recurso exclusivo do recurso arm.
location	string	O local do grupo de recursos ao qual o recurso pertence.
name	string	O nome do recurso arm.
properties.resource	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). No máximo 15 marcas podem ser fornecidas 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.