Database - List Usages

Dienst:

Cosmos DB Resource Provider

API-Version:

2025-04-15

Ruft die Verwendungen (neueste Daten) für die angegebene Datenbank ab.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/usages?api-version=2025-04-15

Mit optionalen Parametern:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/usages?api-version=2025-04-15&$filter={$filter}

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
accountName	path	True	string minLength: 3 maxLength: 50 pattern: ^[a-z0-9]+(-[a-z0-9]+)*	Name des Cosmos DB-Datenbankkontos.
databaseRid	path	True	string	Cosmos DB-Datenbank wird entfernt.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string minLength: 1	Die ID des Zielabonnements.
api-version	query	True	string minLength: 1	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.
$filter	query		string	Ein OData-Filterausdruck, der eine Teilmenge der zurückzugebenden Verwendungen beschreibt. Der unterstützte Parameter ist name.value (name of the metric, can have an or of multiple names).

Antworten

Name	Typ	Beschreibung
200 OK	UsagesResult	Die Verwendungen für die Datenbank wurden erfolgreich abgerufen.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

CosmosDBDatabaseGetUsages

Beispielanforderung

HTTP

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/databases/databaseRid/usages?api-version=2025-04-15&$filter=$filter=name.value eq 'Storage'

Java

/**
 * Samples for Database ListUsages.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2025-04-15/examples/
     * CosmosDBDatabaseGetUsages.json
     */
    /**
     * Sample code: CosmosDBDatabaseGetUsages.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void cosmosDBDatabaseGetUsages(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.cosmosDBAccounts().manager().serviceClient().getDatabases().listUsages("rg1", "ddb1", "databaseRid",
            "$filter=name.value eq 'Storage'", 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_database_get_usages.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.database.list_usages(
        resource_group_name="rg1",
        account_name="ddb1",
        database_rid="databaseRid",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2025-04-15/examples/CosmosDBDatabaseGetUsages.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/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/cosmos/armcosmos/v3"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/011ecc5633300a5eefe43dde748f269d39e96458/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2025-04-15/examples/CosmosDBDatabaseGetUsages.json
func ExampleDatabaseClient_NewListUsagesPager() {
	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)
	}
	pager := clientFactory.NewDatabaseClient().NewListUsagesPager("rg1", "ddb1", "databaseRid", &armcosmos.DatabaseClientListUsagesOptions{Filter: to.Ptr("$filter=name.value eq 'Storage'")})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.UsagesResult = armcosmos.UsagesResult{
		// 	Value: []*armcosmos.Usage{
		// 		{
		// 			Name: &armcosmos.MetricName{
		// 				LocalizedValue: to.Ptr("Storage"),
		// 				Value: to.Ptr("Storage"),
		// 			},
		// 			CurrentValue: to.Ptr[int64](0),
		// 			Limit: to.Ptr[int64](10737418240),
		// 			QuotaPeriod: to.Ptr("P1D"),
		// 			Unit: to.Ptr(armcosmos.UnitTypeBytes),
		// 	}},
		// }
	}
}

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");
require("dotenv/config");

/**
 * This sample demonstrates how to Retrieves the usages (most recent data) for the given database.
 *
 * @summary Retrieves the usages (most recent data) for the given database.
 * x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2025-04-15/examples/CosmosDBDatabaseGetUsages.json
 */
async function cosmosDbDatabaseGetUsages() {
  const subscriptionId = process.env["COSMOSDB_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["COSMOSDB_RESOURCE_GROUP"] || "rg1";
  const accountName = "ddb1";
  const databaseRid = "databaseRid";
  const filter = "$filter=name.value eq 'Storage'";
  const options = { filter };
  const credential = new DefaultAzureCredential();
  const client = new CosmosDBManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.database.listUsages(
    resourceGroupName,
    accountName,
    databaseRid,
    options,
  )) {
    resArray.push(item);
  }
  console.log(resArray);
}

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

Beispiel für eine Antwort

Statuscode:

200

{
  "value": [
    {
      "unit": "Bytes",
      "quotaPeriod": "P1D",
      "limit": 10737418240,
      "currentValue": 0,
      "name": {
        "value": "Storage",
        "localizedValue": "Storage"
      }
    }
  ]
}

Definitionen

Name	Beschreibung
MetricName	Ein Metrikname.
UnitType	Die Einheit der Metrik.
Usage	Die Nutzungsdaten für eine Verwendungsanforderung.
UsagesResult	Die Antwort auf eine Listenverwendungsanforderung.

MetricName

Objekt

Ein Metrikname.

Name	Typ	Beschreibung
localizedValue	string	Der Anzeigename der Metrik.
value	string	The name of the metric.

UnitType

Enumeration

Die Einheit der Metrik.

Wert	Beschreibung
Bytes
BytesPerSecond
Count
CountPerSecond
Milliseconds
Percent
Seconds

Usage

Objekt

Die Nutzungsdaten für eine Verwendungsanforderung.

Name	Typ	Beschreibung
currentValue	integer (int64)	Aktueller Wert für diese Metrik
limit	integer (int64)	Maximalwert für diese Metrik
name	MetricName	Die Namensinformationen für die Metrik.
quotaPeriod	string	Der Kontingentzeitraum, der zum Zusammenfassen der Verwendungswerte verwendet wird.
unit	UnitType	Die Einheit der Metrik.

UsagesResult

Objekt

Die Antwort auf eine Listenverwendungsanforderung.

Name	Typ	Beschreibung
value	Usage[]	Die Liste der Verwendungen für die Datenbank. Eine Verwendung ist eine Zeitmetrik