指定されたデータベース アカウントのメトリック定義を取得します。
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/metricDefinitions?api-version=2023-11-15
URI パラメーター
| 名前 |
/ |
必須 |
型 |
説明 |
|
accountName
|
path |
True
|
string
|
Cosmos DB データベース アカウント名。
Regex pattern: ^[a-z0-9]+(-[a-z0-9]+)*
|
|
resourceGroupName
|
path |
True
|
string
|
リソース グループの名前。 名前の大文字と小文字は区別されます。
|
|
subscriptionId
|
path |
True
|
string
|
ターゲット サブスクリプションの ID。
|
|
api-version
|
query |
True
|
string
|
この操作に使用する API バージョン。
|
応答
セキュリティ
azure_auth
Azure Active Directory OAuth2 フロー
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
| 名前 |
説明 |
|
user_impersonation
|
ユーザー アカウントの借用
|
例
CosmosDBDatabaseAccountGetMetricDefinitions
Sample Request
GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/metricDefinitions?api-version=2023-11-15
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_metric_definitions.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_metric_definitions(
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/CosmosDBDatabaseAccountGetMetricDefinitions.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/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/CosmosDBDatabaseAccountGetMetricDefinitions.json
func ExampleDatabaseAccountsClient_NewListMetricDefinitionsPager() {
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().NewListMetricDefinitionsPager("rg1", "ddb1", 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.MetricDefinitionsListResult = armcosmos.MetricDefinitionsListResult{
// Value: []*armcosmos.MetricDefinition{
// {
// Name: &armcosmos.MetricName{
// LocalizedValue: to.Ptr("Total Requests"),
// Value: to.Ptr("Total Requests"),
// },
// MetricAvailabilities: []*armcosmos.MetricAvailability{
// {
// Retention: to.Ptr("P2D"),
// TimeGrain: to.Ptr("PT5M"),
// },
// {
// Retention: to.Ptr("P14D"),
// TimeGrain: to.Ptr("PT1H"),
// },
// {
// Retention: to.Ptr("P60D"),
// TimeGrain: to.Ptr("P1D"),
// }},
// PrimaryAggregationType: to.Ptr(armcosmos.PrimaryAggregationTypeTotal),
// ResourceURI: to.Ptr("/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1"),
// 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");
/**
* This sample demonstrates how to Retrieves metric definitions for the given database account.
*
* @summary Retrieves metric definitions for the given database account.
* x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBDatabaseAccountGetMetricDefinitions.json
*/
async function cosmosDbDatabaseAccountGetMetricDefinitions() {
const subscriptionId = process.env["COSMOSDB_SUBSCRIPTION_ID"] || "subid";
const resourceGroupName = process.env["COSMOSDB_RESOURCE_GROUP"] || "rg1";
const accountName = "ddb1";
const credential = new DefaultAzureCredential();
const client = new CosmosDBManagementClient(credential, subscriptionId);
const resArray = new Array();
for await (let item of client.databaseAccounts.listMetricDefinitions(
resourceGroupName,
accountName,
)) {
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": [
{
"metricAvailabilities": [
{
"timeGrain": "PT5M",
"retention": "P2D"
},
{
"timeGrain": "PT1H",
"retention": "P14D"
},
{
"timeGrain": "P1D",
"retention": "P60D"
}
],
"primaryAggregationType": "Total",
"unit": "Count",
"resourceUri": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1",
"name": {
"value": "Total Requests",
"localizedValue": "Total Requests"
}
}
]
}
定義
MetricAvailability
メトリックの可用性。
| 名前 |
型 |
説明 |
|
retention
|
string
|
メトリック値のリテンション期間。
|
|
timeGrain
|
string
|
メトリック値の集計に使用する時間グレイン。
|
MetricDefinition
メトリックの定義。
MetricDefinitionsListResult
リスト メトリック定義要求に対する応答。
MetricName
メトリック名。
| 名前 |
型 |
説明 |
|
localizedValue
|
string
|
メトリックのフレンドリ名。
|
|
value
|
string
|
メトリックの名前。
|
PrimaryAggregationType
メトリックのプライマリ集計の種類。
| 名前 |
型 |
説明 |
|
Average
|
string
|
|
|
Last
|
string
|
|
|
Maximum
|
string
|
|
|
Minimum
|
string
|
|
|
None
|
string
|
|
|
Total
|
string
|
|
UnitType
メトリックの単位。
| 名前 |
型 |
説明 |
|
Bytes
|
string
|
|
|
BytesPerSecond
|
string
|
|
|
Count
|
string
|
|
|
CountPerSecond
|
string
|
|
|
Milliseconds
|
string
|
|
|
Percent
|
string
|
|
|
Seconds
|
string
|
|