Class QuotaByCounterKeysImpl

Package version

Class containing QuotaByCounterKeys operations.

Hierarchy

QuotaByCounterKeysImpl

Implements

QuotaByCounterKeys

Index

Constructors

constructor

Methods

Constructors

constructor

new QuotaByCounterKeysImpl(client: ApiManagementClientContext): QuotaByCounterKeysImpl

- Defined in operations/quotaByCounterKeys.ts:24
Initialize a new instance of the class QuotaByCounterKeys class.

Parameters
- client: ApiManagementClientContext
  
  Reference to the service client
Returns QuotaByCounterKeysImpl

Methods

listByService

listByService(resourceGroupName: string, serviceName: string, quotaCounterKey: string, options?: QuotaByCounterKeysListByServiceOptionalParams): Promise<QuotaByCounterKeysListByServiceResponse>

Implementation of QuotaByCounterKeys.listByService
- Defined in operations/quotaByCounterKeys.ts:45
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.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- 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
- Optional options: QuotaByCounterKeysListByServiceOptionalParams
  
  The options parameters.
Returns Promise<QuotaByCounterKeysListByServiceResponse>

update

update(resourceGroupName: string, serviceName: string, quotaCounterKey: string, parameters: QuotaCounterValueUpdateContract, options?: QuotaByCounterKeysUpdateOptionalParams): Promise<QuotaByCounterKeysUpdateResponse>

Implementation of QuotaByCounterKeys.update
- Defined in operations/quotaByCounterKeys.ts:69
Updates all the quota counter values specified with the existing quota counter key to a value in the specified service instance. This should be used for reset of the quota counter values.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- 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
- parameters: QuotaCounterValueUpdateContract
  
  The value of the quota counter to be applied to all quota counter periods.
- Optional options: QuotaByCounterKeysUpdateOptionalParams
  
  The options parameters.
Returns Promise<QuotaByCounterKeysUpdateResponse>

Generated using TypeDoc