Database Account Region - List Metrics

Referencia

Szolgáltatás:: Cosmos DB Resource Provider

API-verzió:: 2025-04-15

Lekéri az adott adatbázisfiók és -régió adott szűrője által meghatározott metrikákat.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
accountName	path	True	string minLength: 3 maxLength: 50 pattern: ^[a-z0-9]+(-[a-z0-9]+)*	Cosmos DB-adatbázisfiók neve.
region	path	True	string	Cosmos DB-régió, szóközökkel a szavak és az egyes szavak között nagybetűvel.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.
subscriptionId	path	True	string minLength: 1	A cél-előfizetés azonosítója.
$filter	query	True	string	OData szűrőkifejezés, amely a visszaadandó metrikák egy részhalmazát írja le. A szűrhető paraméterek a name.value (a metrika neve, több neve is lehet), startTime, endTime és timeGrain. A támogatott operátor az eq.
api-version	query	True	string minLength: 1	A művelethez használandó API-verzió.

Válaszok

Name	Típus	Description
200 OK	MetricListResult	Az adatbázisfiók metrikáinak lekérése sikeresen megtörtént.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	Személyesítse meg a felhasználói fiókját

Példák

CosmosDBDatabaseAccountRegionGetMetrics

Mintakérelem

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/region/North Europe/metrics?api-version=2025-04-15&$filter=$filter=(name.value eq 'Total Requests') and timeGrain eq duration'PT5M' and startTime eq '2017-11-19T23:53:55.2780000Z' and endTime eq '2017-11-20T00:13:55.2780000Z


/**
 * Samples for DatabaseAccountRegion ListMetrics.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2025-04-15/examples/
     * CosmosDBDatabaseAccountRegionGetMetrics.json
     */
    /**
     * Sample code: CosmosDBDatabaseAccountRegionGetMetrics.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void cosmosDBDatabaseAccountRegionGetMetrics(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.cosmosDBAccounts().manager().serviceClient().getDatabaseAccountRegions().listMetrics("rg1", "ddb1",
            "North Europe",
            "$filter=(name.value eq 'Total Requests') and timeGrain eq duration'PT5M' and startTime eq '2017-11-19T23:53:55.2780000Z' and endTime eq '2017-11-20T00:13:55.2780000Z",
            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

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_account_region_get_metrics.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_account_region.list_metrics(
        resource_group_name="rg1",
        account_name="ddb1",
        region="North Europe",
        filter="$filter=(name.value eq 'Total Requests') and timeGrain eq duration'PT5M' and startTime eq '2017-11-19T23:53:55.2780000Z' and endTime eq '2017-11-20T00:13:55.2780000Z",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2025-04-15/examples/CosmosDBDatabaseAccountRegionGetMetrics.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

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/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/CosmosDBDatabaseAccountRegionGetMetrics.json
func ExampleDatabaseAccountRegionClient_NewListMetricsPager() {
	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.NewDatabaseAccountRegionClient().NewListMetricsPager("rg1", "ddb1", "North Europe", "$filter=(name.value eq 'Total Requests') and timeGrain eq duration'PT5M' and startTime eq '2017-11-19T23:53:55.2780000Z' and endTime eq '2017-11-20T00:13:55.2780000Z", nil)
	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.MetricListResult = armcosmos.MetricListResult{
		// 	Value: []*armcosmos.Metric{
		// 		{
		// 			Name: &armcosmos.MetricName{
		// 				LocalizedValue: to.Ptr("Total Requests"),
		// 				Value: to.Ptr("Total Requests"),
		// 			},
		// 			EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-11-20T00:13:55.278Z"); return t}()),
		// 			MetricValues: []*armcosmos.MetricValue{
		// 				{
		// 					Count: to.Ptr[int32](0),
		// 					Average: to.Ptr[float64](0),
		// 					Timestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-11-19T23:53:55.278Z"); return t}()),
		// 					Total: to.Ptr[float64](0),
		// 				},
		// 				{
		// 					Count: to.Ptr[int32](0),
		// 					Average: to.Ptr[float64](0),
		// 					Timestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-11-19T23:58:55.278Z"); return t}()),
		// 					Total: to.Ptr[float64](0),
		// 				},
		// 				{
		// 					Count: to.Ptr[int32](0),
		// 					Average: to.Ptr[float64](0),
		// 					Timestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-11-20T00:03:55.278Z"); return t}()),
		// 					Total: to.Ptr[float64](0),
		// 				},
		// 				{
		// 					Count: to.Ptr[int32](0),
		// 					Average: to.Ptr[float64](0),
		// 					Timestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-11-20T00:08:55.278Z"); return t}()),
		// 					Total: to.Ptr[float64](0),
		// 			}},
		// 			StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-11-19T23:53:55.278Z"); return t}()),
		// 			TimeGrain: to.Ptr("PT5M"),
		// 			Unit: to.Ptr(armcosmos.UnitTypeCount),
		// 	}},
		// }
	}
}

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

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

/**
 * This sample demonstrates how to Retrieves the metrics determined by the given filter for the given database account and region.
 *
 * @summary Retrieves the metrics determined by the given filter for the given database account and region.
 * x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2025-04-15/examples/CosmosDBDatabaseAccountRegionGetMetrics.json
 */
async function cosmosDbDatabaseAccountRegionGetMetrics() {
  const subscriptionId = process.env["COSMOSDB_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["COSMOSDB_RESOURCE_GROUP"] || "rg1";
  const accountName = "ddb1";
  const region = "North Europe";
  const filter =
    "$filter=(name.value eq 'Total Requests') and timeGrain eq duration'PT5M' and startTime eq '2017-11-19T23:53:55.2780000Z' and endTime eq '2017-11-20T00:13:55.2780000Z";
  const credential = new DefaultAzureCredential();
  const client = new CosmosDBManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.databaseAccountRegion.listMetrics(
    resourceGroupName,
    accountName,
    region,
    filter,
  )) {
    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

Mintaválasz

Állapotkód:: 200

{
  "value": [
    {
      "timeGrain": "PT5M",
      "startTime": "2017-11-19T23:53:55.2780000Z",
      "endTime": "2017-11-20T00:13:55.2780000Z",
      "unit": "Count",
      "metricValues": [
        {
          "timestamp": "2017-11-19T23:53:55.2780000Z",
          "total": 0,
          "_count": 0,
          "average": 0
        },
        {
          "timestamp": "2017-11-19T23:58:55.2780000Z",
          "total": 0,
          "_count": 0,
          "average": 0
        },
        {
          "timestamp": "2017-11-20T00:03:55.2780000Z",
          "total": 0,
          "_count": 0,
          "average": 0
        },
        {
          "timestamp": "2017-11-20T00:08:55.2780000Z",
          "total": 0,
          "_count": 0,
          "average": 0
        }
      ],
      "name": {
        "value": "Total Requests",
        "localizedValue": "Total Requests"
      }
    }
  ]
}

Definíciók

Name	Description
Metric	Metrikaadatok
MetricListResult	A listametrika-kérésre adott válasz.
MetricName	Metrikanév.
MetricValue	Metrikák értékeit jelöli.
UnitType	A metrika mértékegysége.

Metric

Objektum

Metrikaadatok

Name	Típus	Description
endTime	string (date-time)	A metrika befejezési ideje (ISO-8601 formátum).
metricValues	MetricValue[]	A megadott időablak és időbélyeg metrikaértékei.
name	MetricName	A metrika névadatai.
startTime	string (date-time)	A metrika kezdő időpontja (ISO-8601 formátum).
timeGrain	string	A metrikaértékek összegzéséhez használandó időfelbontás.
unit	UnitType	A metrika mértékegysége.

MetricListResult

Objektum

A listametrika-kérésre adott válasz.

Name	Típus	Description
value	Metric[]	A fiók metrikáinak listája.

MetricName

Objektum

Metrikanév.

Name	Típus	Description
localizedValue	string	A metrika rövid neve.
value	string	A metrika neve.

MetricValue

Objektum

Metrikák értékeit jelöli.

Name	Típus	Description
_count	number (int32)	A metrika értékeinek száma.
average	number (double)	A metrika átlagos értéke.
maximum	number (double)	A metrika maximális értéke.
minimum	number (double)	A metrika minimális értéke.
timestamp	string (date-time)	A metrika időbélyege (ISO-8601 formátum).
total	number (double)	A metrika teljes értéke.

UnitType

Enumerálás

A metrika mértékegysége.

Érték	Description
Bytes
BytesPerSecond
Count
CountPerSecond
Milliseconds
Percent
Seconds

Megosztás a következőn keresztül:

Database Account Region - List Metrics

URI-paraméterek

Válaszok

Biztonság

azure_auth

Hatókörök

Példák

CosmosDBDatabaseAccountRegionGetMetrics

Mintakérelem

Mintaválasz

Definíciók

Metric

MetricListResult

MetricName

MetricValue

UnitType