Obtención de usos para la suscripción solicitada
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/locations/{location}/usages?api-version=2023-05-01
With optional parameters:
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/locations/{location}/usages?api-version=2023-05-01&$filter={$filter}
Parámetros de identificador URI
| Nombre |
En |
Requerido |
Tipo |
Description |
|
location
|
path |
True
|
string
|
Ubicación del recurso
|
|
subscriptionId
|
path |
True
|
string
|
Identificador de la suscripción de destino.
|
|
api-version
|
query |
True
|
string
|
Versión de API que se usará para la operación.
|
|
$filter
|
query |
|
string
|
Expresión de filtro de OData que describe un subconjunto de usos que se van a devolver. El parámetro admitido es name.value (nombre de la métrica, puede tener o varios nombres).
|
Respuestas
| Nombre |
Tipo |
Description |
|
200 OK
|
UsageListResult
|
Aceptar.
|
|
Other Status Codes
|
ErrorResponse
|
Respuesta de error que describe el motivo del error de la operación.
|
Ejemplos
Get Usages
Sample Request
GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/WestUS/usages?api-version=2023-05-01
/** Samples for Usages List. */
public final class Main {
/*
* x-ms-original-file: specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2023-05-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/2023-05-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/310a0100f5b020c1900c527a6aa70d21992f078a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2023-05-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/2023-05-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 System;
using System.Threading.Tasks;
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/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
Sample Response
{
"value": [
{
"name": {
"value": "AccountCount",
"localizedValue": "Cognitive Services total account limit"
},
"currentValue": 3,
"limit": 200,
"unit": "Count"
}
]
}
Definiciones
ErrorAdditionalInfo
Información adicional sobre el error de administración de recursos.
| Nombre |
Tipo |
Description |
|
info
|
object
|
Información adicional.
|
|
type
|
string
|
Tipo de información adicional.
|
ErrorDetail
Detalle del error.
| Nombre |
Tipo |
Description |
|
additionalInfo
|
ErrorAdditionalInfo[]
|
Información adicional del error.
|
|
code
|
string
|
Código de error.
|
|
details
|
ErrorDetail[]
|
Los detalles del error.
|
|
message
|
string
|
El mensaje de error.
|
|
target
|
string
|
Destino del error.
|
ErrorResponse
Respuesta de error
| Nombre |
Tipo |
Description |
|
error
|
ErrorDetail
|
Objeto de error.
|
MetricName
Un nombre para la métrica.
| Nombre |
Tipo |
Description |
|
localizedValue
|
string
|
Nombre descriptivo de la métrica.
|
|
value
|
string
|
El nombre de la métrica.
|
QuotaUsageStatus
Estado de uso de la cuota de la cuenta de Cognitive Services.
| Nombre |
Tipo |
Description |
|
Blocked
|
string
|
|
|
InOverage
|
string
|
|
|
Included
|
string
|
|
|
Unknown
|
string
|
|
UnitType
Unidad de la métrica.
| Nombre |
Tipo |
Description |
|
Bytes
|
string
|
|
|
BytesPerSecond
|
string
|
|
|
Count
|
string
|
|
|
CountPerSecond
|
string
|
|
|
Milliseconds
|
string
|
|
|
Percent
|
string
|
|
|
Seconds
|
string
|
|
Usage
Los datos de uso de una solicitud de uso.
| Nombre |
Tipo |
Description |
|
currentValue
|
number
|
Valor actual de esta métrica.
|
|
limit
|
number
|
Valor máximo de esta métrica.
|
|
name
|
MetricName
|
Información de nombre de la métrica.
|
|
nextResetTime
|
string
|
Siguiente hora de restablecimiento de la cuota actual.
|
|
quotaPeriod
|
string
|
Período de cuota usado para resumir los valores de uso.
|
|
status
|
QuotaUsageStatus
|
Estado de uso de la cuota de la cuenta de Cognitive Services.
|
|
unit
|
UnitType
|
Unidad de la métrica.
|
UsageListResult
Respuesta a una solicitud de uso de lista.
| Nombre |
Tipo |
Description |
|
nextLink
|
string
|
Vínculo que se usa para obtener la página siguiente de Usos.
|
|
value
|
Usage[]
|
Lista de usos de la cuenta de Cognitive Services.
|