Quota By Counter Keys - List By Service

Service:

API Management

Version d'API:

2021-08-01

Répertorie une collection de périodes de compteur de quota actuelles associées à la clé de compteur configurée dans la stratégie sur le instance de service spécifié. L’API ne prend pas encore en charge la pagination.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/quotas/{quotaCounterKey}?api-version=2021-08-01

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
quotaCounterKey	path	True	string	Identificateur de clé du compteur de quota. Il s’agit du résultat de l’expression définie dans l’attribut de clé de contre-clé de la stratégie quota par clé. Par exemple, si vous spécifiez counter-key="boo » dans la stratégie, elle est accessible par la clé de compteur « boo ». Mais s’il est défini comme counter-key="@(« b"+"a »)" » alors il sera accessible par la clé « ba »
resourceGroupName	path	True	string	Nom du groupe de ressources.
serviceName	path	True	string	Nom du service Gestion des API. Modèle d’expression régulière: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId	path	True	string	Informations d’identification d’abonnement qui identifient de manière unique l’abonnement Microsoft Azure. L’ID d’abonnement fait partie de l’URI pour chaque appel de service.
api-version	query	True	string	Version de l’API à utiliser avec la demande cliente.

Réponses

Nom	Type	Description
200 OK	QuotaCounterCollection	Répertorie une collection de valeurs de compteur de quota.
Other Status Codes	ErrorResponse	Réponse d’erreur décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Exemples

ApiManagementGetQuotaCounterKeys

Exemple de requête

HTTP

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/quotas/ba?api-version=2021-08-01

Java

import com.azure.core.util.Context;

/** Samples for QuotaByCounterKeys ListByService. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementGetQuotaCounterKeys.json
     */
    /**
     * Sample code: ApiManagementGetQuotaCounterKeys.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementGetQuotaCounterKeys(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager.quotaByCounterKeys().listByServiceWithResponse("rg1", "apimService1", "ba", 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.apimanagement import ApiManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-apimanagement
# USAGE
    python api_management_get_quota_counter_keys.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 = ApiManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.quota_by_counter_keys.list_by_service(
        resource_group_name="rg1",
        service_name="apimService1",
        quota_counter_key="ba",
    )
    print(response)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementGetQuotaCounterKeys.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 armapimanagement_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/apimanagement/armapimanagement"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c767823fdfd9d5e96bad245e3ea4d14d94a716bb/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementGetQuotaCounterKeys.json
func ExampleQuotaByCounterKeysClient_ListByService() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armapimanagement.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewQuotaByCounterKeysClient().ListByService(ctx, "rg1", "apimService1", "ba", 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.QuotaCounterCollection = armapimanagement.QuotaCounterCollection{
	// 	Value: []*armapimanagement.QuotaCounterContract{
	// 		{
	// 			CounterKey: to.Ptr("ba"),
	// 			PeriodEndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-02-08T16:54:40Z"); return t}()),
	// 			PeriodKey: to.Ptr("0_P3Y6M4DT12H30M5S"),
	// 			PeriodStartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2014-08-04T04:24:35Z"); return t}()),
	// 			Value: &armapimanagement.QuotaCounterValueContractProperties{
	// 				CallsCount: to.Ptr[int32](5),
	// 				KbTransferred: to.Ptr[float64](2.5830078125),
	// 			},
	// 	}},
	// }
}

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

/**
 * This sample demonstrates how to Lists a collection of current quota counter periods associated with the counter-key configured in the policy on the specified service instance. The api does not support paging yet.
 *
 * @summary Lists a collection of current quota counter periods associated with the counter-key configured in the policy on the specified service instance. The api does not support paging yet.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementGetQuotaCounterKeys.json
 */
async function apiManagementGetQuotaCounterKeys() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const quotaCounterKey = "ba";
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.quotaByCounterKeys.listByService(
    resourceGroupName,
    serviceName,
    quotaCounterKey
  );
  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 System.Xml;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.ApiManagement;
using Azure.ResourceManager.ApiManagement.Models;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementGetQuotaCounterKeys.json
// this example is just showing the usage of "QuotaByCounterKeys_ListByService" 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 ApiManagementServiceResource created on azure
// for more information of creating ApiManagementServiceResource, please refer to the document of ApiManagementServiceResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string serviceName = "apimService1";
ResourceIdentifier apiManagementServiceResourceId = ApiManagementServiceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serviceName);
ApiManagementServiceResource apiManagementService = client.GetApiManagementServiceResource(apiManagementServiceResourceId);

// invoke the operation and iterate over the result
string quotaCounterKey = "ba";
await foreach (QuotaCounterContract item in apiManagementService.GetQuotaByCounterKeysAsync(quotaCounterKey))
{
    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

Exemple de réponse

Code d’état:

200

{
  "value": [
    {
      "counterKey": "ba",
      "periodKey": "0_P3Y6M4DT12H30M5S",
      "periodStartTime": "2014-08-04T04:24:35Z",
      "periodEndTime": "2018-02-08T16:54:40Z",
      "value": {
        "callsCount": 5,
        "kbTransferred": 2.5830078125
      }
    }
  ],
  "nextLink": ""
}

Définitions

Nom	Description
ErrorFieldContract	Contrat champ d’erreur.
ErrorResponse	Réponse d’erreur.
QuotaCounterCollection	Représentation de la liste compteur de quota paginée.
QuotaCounterContract	Détails du compteur de quota.
QuotaCounterValueContractProperties	Détails de la valeur du compteur de quota.

ErrorFieldContract

Contrat champ d’erreur.

Nom	Type	Description
code	string	Code d'erreur de niveau propriété.
message	string	Représentation lisible par l’homme de l’erreur au niveau de la propriété.
target	string	Nom de propriété.

ErrorResponse

Réponse d’erreur.

Nom	Type	Description
error.code	string	Code d'erreur défini par le service. Ce code sert de sous-état pour le code d'erreur HTTP spécifié dans la réponse.
error.details	ErrorFieldContract[]	Liste des champs non valides envoyés dans la demande, en cas d’erreur de validation.
error.message	string	Représentation contrôlable de visu de l’erreur.

QuotaCounterCollection

Représentation de la liste compteur de quota paginée.

Nom	Type	Description
count	integer	Nombre total d’enregistrements sur toutes les pages.
nextLink	string	Lien de page suivante, le cas échéant.
value	QuotaCounterContract[]	Valeurs de compteur de quota.

QuotaCounterContract

Détails du compteur de quota.

Nom	Type	Description
counterKey	string	Valeur clé du compteur. Ne doit pas être vide.
periodEndTime	string	Date de fin de la période de compteur. La date est conforme au format suivant : yyyy-MM-ddTHH:mm:ssZ tel que spécifié par la norme ISO 8601.
periodKey	string	Identificateur de la période pour laquelle le compteur a été collecté. Ne doit pas être vide.
periodStartTime	string	Date de début de la période de compteur. La date est conforme au format suivant : yyyy-MM-ddTHH:mm:ssZ tel que spécifié par la norme ISO 8601.
value	QuotaCounterValueContractProperties	Propriétés de valeur de quota

QuotaCounterValueContractProperties

Détails de la valeur du compteur de quota.

Nom	Type	Description
callsCount	integer	Nombre de fois où Counter a été appelé.
kbTransferred	number	Données transférées en kilo-octets.