Share via

QuotaByCounterKeys interface

  • Reference
Package:
@azure/arm-apimanagement

Interface representing a QuotaByCounterKeys.

Methods

listByService(string, string, string, QuotaByCounterKeysListByServiceOptionalParams)

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.
update(string, string, string, QuotaCounterValueUpdateContract, QuotaByCounterKeysUpdateOptionalParams)

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.

Method Details

listByService(string, string, string, QuotaByCounterKeysListByServiceOptionalParams)

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.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

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

options
QuotaByCounterKeysListByServiceOptionalParams

The options parameters.

Returns

Promise<QuotaCounterCollection>

update(string, string, string, QuotaCounterValueUpdateContract, QuotaByCounterKeysUpdateOptionalParams)

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.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

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.

options
QuotaByCounterKeysUpdateOptionalParams

The options parameters.

Returns

Promise<QuotaCounterCollection>