QuotaByPeriodKeys interface
Interface representing a QuotaByPeriodKeys.
Methods
| get(string, string, string, string, Quota |
Gets the value of the quota counter associated with the counter-key in the policy for the specific period in service instance. |
| update(string, string, string, string, Quota |
Updates an existing quota counter value in the specified service instance. |
Method Details
get(string, string, string, string, QuotaByPeriodKeysGetOptionalParams)
Gets the value of the quota counter associated with the counter-key in the policy for the specific period in service instance.
function get(resourceGroupName: string, serviceName: string, quotaCounterKey: string, quotaPeriodKey: string, options?: QuotaByPeriodKeysGetOptionalParams): Promise<QuotaCounterContract>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
- quotaPeriodKey
-
string
Quota period key identifier.
The options parameters.
Returns
Promise<QuotaCounterContract>
update(string, string, string, string, QuotaCounterValueUpdateContract, QuotaByPeriodKeysUpdateOptionalParams)
Updates an existing quota counter value in the specified service instance.
function update(resourceGroupName: string, serviceName: string, quotaCounterKey: string, quotaPeriodKey: string, parameters: QuotaCounterValueUpdateContract, options?: QuotaByPeriodKeysUpdateOptionalParams): Promise<QuotaCounterContract>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
- quotaPeriodKey
-
string
Quota period key identifier.
- parameters
- QuotaCounterValueUpdateContract
The value of the Quota counter to be applied on the specified period.
The options parameters.
Returns
Promise<QuotaCounterContract>