Share via


ApiManagementServiceResource.GetQuotaByCounterKeysAsync Method

Definition

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.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/quotas/{quotaCounterKey}
  • Operation Id: QuotaByCounterKeys_ListByService
  • Default Api Version: 2023-03-01-preview
public virtual Azure.AsyncPageable<Azure.ResourceManager.ApiManagement.Models.QuotaCounterContract> GetQuotaByCounterKeysAsync (string quotaCounterKey, System.Threading.CancellationToken cancellationToken = default);
abstract member GetQuotaByCounterKeysAsync : string * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.ResourceManager.ApiManagement.Models.QuotaCounterContract>
override this.GetQuotaByCounterKeysAsync : string * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.ResourceManager.ApiManagement.Models.QuotaCounterContract>
Public Overridable Function GetQuotaByCounterKeysAsync (quotaCounterKey As String, Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of QuotaCounterContract)

Parameters

quotaCounterKey
String

Quota counter key identifier.This is the result of expression defined in counter-key attribute of the quota-by-key policy.For Example, if you specify counter-key="boo" in the policy, then it’s accessible by "boo" counter key. But if it’s defined as counter-key="@("b"+"a")" then it will be accessible by "ba" key.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

An async collection of QuotaCounterContract that may take multiple service requests to iterate over.

Exceptions

quotaCounterKey is an empty string, and was expected to be non-empty.

quotaCounterKey is null.

Applies to