Accounts - List Usages

Service:

Azure AI Services

API Version:

2023-05-01

Get usages for the requested Cognitive Services account

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/usages?api-version=2023-05-01

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/usages?api-version=2023-05-01&$filter={$filter}

URI Parameters

Name	In	Required	Type	Description
accountName	path	True	string	The name of Cognitive Services account. Regex pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$
resourceGroupName	path	True	string	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string	The ID of the target subscription.
api-version	query	True	string	The API version to use for this operation.
$filter	query		string	An OData filter expression that describes a subset of usages to return. The supported parameter is name.value (name of the metric, can have an or of multiple names).

Responses

Name	Type	Description
200 OK	UsageListResult	The usages for Cognitive Services account were retrieved successfully.
Other Status Codes	ErrorResponse	Error response describing why the operation failed. If the resource does not exist, 404 (NotFound) will be returned.

Examples

Get Usages

Sample Request

HTTP

GET https://management.azure.com/subscriptions/5a4f5c2e-6983-4ccb-bd34-2196d5b5bbd3/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/TestUsage02/usages?api-version=2023-05-01

Java

/** Samples for Accounts ListUsages. */
public final class Main {
    /*
     * x-ms-original-file: specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2023-05-01/examples/GetUsages.json
     */
    /**
     * Sample code: Get Usages.
     *
     * @param manager Entry point to CognitiveServicesManager.
     */
    public static void getUsages(com.azure.resourcemanager.cognitiveservices.CognitiveServicesManager manager) {
        manager
            .accounts()
            .listUsagesWithResponse("myResourceGroup", "TestUsage02", null, 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.cognitiveservices import CognitiveServicesManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-cognitiveservices
# USAGE
    python 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 = CognitiveServicesManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="5a4f5c2e-6983-4ccb-bd34-2196d5b5bbd3",
    )

    response = client.accounts.list_usages(
        resource_group_name="myResourceGroup",
        account_name="TestUsage02",
    )
    print(response)


# x-ms-original-file: specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2023-05-01/examples/GetUsages.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 armcognitiveservices_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/cognitiveservices/armcognitiveservices"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/310a0100f5b020c1900c527a6aa70d21992f078a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2023-05-01/examples/GetUsages.json
func ExampleAccountsClient_ListUsages() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcognitiveservices.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewAccountsClient().ListUsages(ctx, "myResourceGroup", "TestUsage02", &armcognitiveservices.AccountsClientListUsagesOptions{Filter: 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.UsageListResult = armcognitiveservices.UsageListResult{
	// 	Value: []*armcognitiveservices.Usage{
	// 		{
	// 			Name: &armcognitiveservices.MetricName{
	// 				LocalizedValue: to.Ptr("Face.Transactions"),
	// 				Value: to.Ptr("Face.Transactions"),
	// 			},
	// 			CurrentValue: to.Ptr[float64](3),
	// 			Limit: to.Ptr[float64](30000),
	// 			NextResetTime: to.Ptr("2018-03-28T09:33:51Z"),
	// 			QuotaPeriod: to.Ptr("30.00:00:00"),
	// 			Status: to.Ptr(armcognitiveservices.QuotaUsageStatusIncluded),
	// 			Unit: to.Ptr(armcognitiveservices.UnitTypeCount),
	// 	}},
	// }
}

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 { CognitiveServicesManagementClient } = require("@azure/arm-cognitiveservices");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Get usages for the requested Cognitive Services account
 *
 * @summary Get usages for the requested Cognitive Services account
 * x-ms-original-file: specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2023-05-01/examples/GetUsages.json
 */
async function getUsages() {
  const subscriptionId =
    process.env["COGNITIVESERVICES_SUBSCRIPTION_ID"] || "5a4f5c2e-6983-4ccb-bd34-2196d5b5bbd3";
  const resourceGroupName = process.env["COGNITIVESERVICES_RESOURCE_GROUP"] || "myResourceGroup";
  const accountName = "TestUsage02";
  const credential = new DefaultAzureCredential();
  const client = new CognitiveServicesManagementClient(credential, subscriptionId);
  const result = await client.accounts.listUsages(resourceGroupName, accountName);
  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

dotnet

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.CognitiveServices;
using Azure.ResourceManager.CognitiveServices.Models;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2023-05-01/examples/GetUsages.json
// this example is just showing the usage of "Accounts_ListUsages" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this CognitiveServicesAccountResource created on azure
// for more information of creating CognitiveServicesAccountResource, please refer to the document of CognitiveServicesAccountResource
string subscriptionId = "5a4f5c2e-6983-4ccb-bd34-2196d5b5bbd3";
string resourceGroupName = "myResourceGroup";
string accountName = "TestUsage02";
ResourceIdentifier cognitiveServicesAccountResourceId = CognitiveServicesAccountResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName);
CognitiveServicesAccountResource cognitiveServicesAccount = client.GetCognitiveServicesAccountResource(cognitiveServicesAccountResourceId);

// invoke the operation and iterate over the result
await foreach (ServiceAccountUsage item in cognitiveServicesAccount.GetUsagesAsync())
{
    Console.WriteLine($"Succeeded: {item}");
}

Console.WriteLine($"Succeeded");

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

{
  "value": [
    {
      "name": {
        "value": "Face.Transactions",
        "localizedValue": "Face.Transactions"
      },
      "status": "Included",
      "currentValue": 3,
      "limit": 30000,
      "nextResetTime": "2018-03-28T09:33:51Z",
      "quotaPeriod": "30.00:00:00",
      "unit": "Count"
    }
  ]
}

Definitions

Name	Description
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
MetricName	A metric name.
QuotaUsageStatus	Cognitive Services account quota usage status.
UnitType	The unit of the metric.
Usage	The usage data for a usage request.
UsageListResult	The response to a list usage request.

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Error response

Name	Type	Description
error	ErrorDetail	The error object.

MetricName

A metric name.

Name	Type	Description
localizedValue	string	The friendly name of the metric.
value	string	The name of the metric.

QuotaUsageStatus

Cognitive Services account quota usage status.

Name	Type	Description
Blocked	string
InOverage	string
Included	string
Unknown	string

UnitType

The unit of the metric.

Name	Type	Description
Bytes	string
BytesPerSecond	string
Count	string
CountPerSecond	string
Milliseconds	string
Percent	string
Seconds	string

Usage

The usage data for a usage request.

Name	Type	Description
currentValue	number	Current value for this metric.
limit	number	Maximum value for this metric.
name	MetricName	The name information for the metric.
nextResetTime	string	Next reset time for current quota.
quotaPeriod	string	The quota period used to summarize the usage values.
status	QuotaUsageStatus	Cognitive Services account quota usage status.
unit	UnitType	The unit of the metric.

UsageListResult

The response to a list usage request.

Name	Type	Description
nextLink	string	The link used to get the next page of Usages.
value	Usage[]	The list of usages for Cognitive Service account.