Mengambil penggunaan (data terbaru) untuk akun database yang diberikan.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/usages?api-version=2023-11-15
With optional parameters:
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/usages?api-version=2023-11-15&$filter={$filter}
Parameter URI
| Nama |
Dalam |
Diperlukan |
Jenis |
Deskripsi |
|
accountName
|
path |
True
|
string
|
Nama akun database Cosmos DB.
Regex pattern: ^[a-z0-9]+(-[a-z0-9]+)*
|
|
resourceGroupName
|
path |
True
|
string
|
Nama grup sumber daya. Nama tidak peka huruf besar/kecil.
|
|
subscriptionId
|
path |
True
|
string
|
ID langganan target.
|
|
api-version
|
query |
True
|
string
|
Versi API yang digunakan untuk operasi ini.
|
|
$filter
|
query |
|
string
|
Ekspresi filter OData yang menjelaskan subset penggunaan yang akan dikembalikan. Parameter yang didukung adalah name.value (nama metrik, dapat memiliki atau beberapa nama).
|
Respons
| Nama |
Jenis |
Deskripsi |
|
200 OK
|
UsagesResult
|
Penggunaan untuk akun database berhasil diambil.
|
Keamanan
azure_auth
Alur OAuth2 Azure Active Directory
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
| Nama |
Deskripsi |
|
user_impersonation
|
Meniru akun pengguna Anda
|
Contoh
CosmosDBDatabaseAccountGetUsages
Sample Request
GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/usages?api-version=2023-11-15&$filter=$filter=name.value eq 'Storage'
/**
* Samples for DatabaseAccounts ListUsages.
*/
public final class Main {
/*
* x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/
* CosmosDBDatabaseAccountGetUsages.json
*/
/**
* Sample code: CosmosDBDatabaseAccountGetUsages.
*
* @param azure The entry point for accessing resource management APIs in Azure.
*/
public static void cosmosDBDatabaseAccountGetUsages(com.azure.resourcemanager.AzureResourceManager azure) {
azure.cosmosDBAccounts().manager().serviceClient().getDatabaseAccounts().listUsages("rg1", "ddb1",
"$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
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_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_accounts.list_usages(
resource_group_name="rg1",
account_name="ddb1",
)
for item in response:
print(item)
# x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBDatabaseAccountGetUsages.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/azcore/to"
"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/CosmosDBDatabaseAccountGetUsages.json
func ExampleDatabaseAccountsClient_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.NewDatabaseAccountsClient().NewListUsagesPager("rg1", "ddb1", &armcosmos.DatabaseAccountsClientListUsagesOptions{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
const { CosmosDBManagementClient } = require("@azure/arm-cosmosdb");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to Retrieves the usages (most recent data) for the given database account.
*
* @summary Retrieves the usages (most recent data) for the given database account.
* x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBDatabaseAccountGetUsages.json
*/
async function cosmosDbDatabaseAccountGetUsages() {
const subscriptionId = process.env["COSMOSDB_SUBSCRIPTION_ID"] || "subid";
const resourceGroupName = process.env["COSMOSDB_RESOURCE_GROUP"] || "rg1";
const accountName = "ddb1";
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 (let item of client.databaseAccounts.listUsages(
resourceGroupName,
accountName,
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
Sample Response
{
"value": [
{
"unit": "Bytes",
"quotaPeriod": "P1D",
"limit": 10737418240,
"currentValue": 0,
"name": {
"value": "Storage",
"localizedValue": "Storage"
}
}
]
}
Definisi
MetricName
Nama metrik.
| Nama |
Jenis |
Deskripsi |
|
localizedValue
|
string
|
Nama metrik yang mudah diingat.
|
|
value
|
string
|
Nama metrik.
|
UnitType
Unit metrik.
| Nama |
Jenis |
Deskripsi |
|
Bytes
|
string
|
|
|
BytesPerSecond
|
string
|
|
|
Count
|
string
|
|
|
CountPerSecond
|
string
|
|
|
Milliseconds
|
string
|
|
|
Percent
|
string
|
|
|
Seconds
|
string
|
|
Usage
Data penggunaan untuk permintaan penggunaan.
| Nama |
Jenis |
Deskripsi |
|
currentValue
|
integer
|
Nilai saat ini untuk metrik ini
|
|
limit
|
integer
|
Nilai maksimum untuk metrik ini
|
|
name
|
MetricName
|
Informasi nama untuk metrik.
|
|
quotaPeriod
|
string
|
Periode kuota yang digunakan untuk meringkas nilai penggunaan.
|
|
unit
|
UnitType
|
Unit metrik.
|
UsagesResult
Respons terhadap permintaan penggunaan daftar.
| Nama |
Jenis |
Deskripsi |
|
value
|
Usage[]
|
Daftar penggunaan untuk database. Penggunaan adalah metrik titik waktu
|