ApiManagementServiceResource.GetQuotaByCounterKeys Method

  • Reference

Definition

Namespace:
Azure.ResourceManager.ApiManagement
Assembly:
Azure.ResourceManager.ApiManagement.dll
Package:
Azure.ResourceManager.ApiManagement v1.2.0
Package:
Azure.ResourceManager.ApiManagement v1.3.0-beta.1
Source:
ApiManagementServiceResource.cs
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: 2023-03-01-preview
public virtual Azure.Pageable<Azure.ResourceManager.ApiManagement.Models.QuotaCounterContract> GetQuotaByCounterKeys (string quotaCounterKey, System.Threading.CancellationToken cancellationToken = default);
abstract member GetQuotaByCounterKeys : string * System.Threading.CancellationToken -> Azure.Pageable<Azure.ResourceManager.ApiManagement.Models.QuotaCounterContract>
override this.GetQuotaByCounterKeys : string * System.Threading.CancellationToken -> Azure.Pageable<Azure.ResourceManager.ApiManagement.Models.QuotaCounterContract>
Public Overridable Function GetQuotaByCounterKeys (quotaCounterKey As String, Optional cancellationToken As CancellationToken = Nothing) As Pageable(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

Pageable<QuotaCounterContract>

A 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.

Applies to