ApiManagementServiceResource.GetQuotaByCounterKeysAsync Method

Definition

Namespace:

Azure.ResourceManager.ApiManagement

Assembly:

Azure.ResourceManager.ApiManagement.dll

Package:

Azure.ResourceManager.ApiManagement v1.1.0

Source:

ApiManagementServiceResource.cs

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: 2021-08-01

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

AsyncPageable<QuotaCounterContract>

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

Exceptions

ArgumentException

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

ArgumentNullException

quotaCounterKey is null.