Usages - List

Referens

Tjänst:: Azure AI Services

API-version:: 2024-10-01

Hämta användning för den begärda prenumerationen

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/locations/{location}/usages?api-version=2024-10-01

URI-parametrar

Name	I	Obligatorisk	Typ	Description
location	path	True	string	Resursplats.
subscriptionId	path	True	string minLength: 1	ID för målprenumerationen.
api-version	query	True	string minLength: 1	DEN API-version som ska användas för den här åtgärden.

Svar

Name	Typ	Description
200 OK	UsageListResult	OKEJ.
Other Status Codes	ErrorResponse	Felsvar som beskriver varför åtgärden misslyckades.

Exempel

Get Usages

Exempelbegäran

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/WestUS/usages?api-version=2024-10-01


/**
 * Samples for Usages List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/
     * ListUsages.json
     */
    /**
     * Sample code: Get Usages.
     * 
     * @param manager Entry point to CognitiveServicesManager.
     */
    public static void getUsages(com.azure.resourcemanager.cognitiveservices.CognitiveServicesManager manager) {
        manager.usages().list("WestUS", 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

from azure.identity import DefaultAzureCredential

from azure.mgmt.cognitiveservices import CognitiveServicesManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-cognitiveservices
# USAGE
    python list_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="00000000-0000-0000-0000-000000000000",
    )

    response = client.usages.list(
        location="WestUS",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListUsages.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 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/069a65e8a6d1a6c0c58d9a9d97610b7103b6e8a5/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListUsages.json
func ExampleUsagesClient_NewListPager() {
	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)
	}
	pager := clientFactory.NewUsagesClient().NewListPager("WestUS", &armcognitiveservices.UsagesClientListOptions{Filter: 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.UsageListResult = armcognitiveservices.UsageListResult{
		// 	Value: []*armcognitiveservices.Usage{
		// 		{
		// 			Name: &armcognitiveservices.MetricName{
		// 				LocalizedValue: to.Ptr("Cognitive Services total account limit"),
		// 				Value: to.Ptr("AccountCount"),
		// 			},
		// 			CurrentValue: to.Ptr[float64](3),
		// 			Limit: to.Ptr[float64](200),
		// 			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

const { CognitiveServicesManagementClient } = require("@azure/arm-cognitiveservices");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Get usages for the requested subscription
 *
 * @summary Get usages for the requested subscription
 * x-ms-original-file: specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListUsages.json
 */
async function getUsages() {
  const subscriptionId =
    process.env["COGNITIVESERVICES_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const location = "WestUS";
  const credential = new DefaultAzureCredential();
  const client = new CognitiveServicesManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.usages.list(location)) {
    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

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

// Generated from example definition: specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListUsages.json
// this example is just showing the usage of "Usages_List" 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 SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation and iterate over the result
AzureLocation location = new AzureLocation("WestUS");
await foreach (ServiceAccountUsage item in subscriptionResource.GetUsagesAsync(location))
{
    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

Exempelsvar

Statuskod:: 200

{
  "value": [
    {
      "name": {
        "value": "AccountCount",
        "localizedValue": "Cognitive Services total account limit"
      },
      "currentValue": 3,
      "limit": 200,
      "unit": "Count"
    }
  ]
}

Definitioner

Name	Description
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar
MetricName	Ett måttnamn.
QuotaUsageStatus	Användningsstatus för Cognitive Services-kontokvot.
UnitType	Måttenheten.
Usage	Användningsdata för en användningsbegäran.
UsageListResult	Svaret på en begäran om listanvändning.

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Ytterligare informationstyp.

ErrorDetail

Objekt

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponse

Objekt

Felsvar

Name	Typ	Description
error	ErrorDetail	Felobjektet.

MetricName

Objekt

Ett måttnamn.

Name	Typ	Description
localizedValue	string	Måttets eget namn.
value	string	Namnet på måttet.

QuotaUsageStatus

Uppräkning

Användningsstatus för Cognitive Services-kontokvot.

Värde	Description
Blocked
InOverage
Included
Unknown

UnitType

Uppräkning

Måttenheten.

Värde	Description
Bytes
BytesPerSecond
Count
CountPerSecond
Milliseconds
Percent
Seconds

Usage

Objekt

Användningsdata för en användningsbegäran.

Name	Typ	Description
currentValue	number (double)	Aktuellt värde för det här måttet.
limit	number (double)	Maximalt värde för det här måttet.
name	MetricName	Namninformationen för måttet.
nextResetTime	string	Nästa återställningstid för den aktuella kvoten.
quotaPeriod	string	Den kvotperiod som används för att sammanfatta användningsvärdena.
status	QuotaUsageStatus	Användningsstatus för Cognitive Services-kontokvot.
unit	UnitType	Måttenheten.

UsageListResult

Objekt

Svaret på en begäran om listanvändning.

Name	Typ	Description
nextLink	string	Länken som används för att hämta nästa sida i Användning.
value	Usage[]	Listan över användningar för Cognitive Service-kontot.