Options
All
  • Public
  • Public/Protected
  • All
Menu

Class QuotaByPeriodKeysImpl

Package version

Class containing QuotaByPeriodKeys operations.

Hierarchy

  • QuotaByPeriodKeysImpl

Implements

Index

Constructors

Methods

Constructors

constructor

Methods

get

  • Gets the value of the quota counter associated with the counter-key in the policy for the specific period in service instance.

    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

    • quotaPeriodKey: string

      Quota period key identifier.

    • Optional options: QuotaByPeriodKeysGetOptionalParams

      The options parameters.

    Returns Promise<QuotaByPeriodKeysGetResponse>

update

  • Updates an existing quota counter value in the specified service instance.

    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

    • quotaPeriodKey: string

      Quota period key identifier.

    • parameters: QuotaCounterValueUpdateContract

      The value of the Quota counter to be applied on the specified period.

    • Optional options: QuotaByPeriodKeysUpdateOptionalParams

      The options parameters.

    Returns Promise<QuotaByPeriodKeysUpdateResponse>

Generated using TypeDoc