Quota By Counter Keys - List By Service

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.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/quotas/{quotaCounterKey}?api-version=2021-08-01

URI Parameters

Name In Required Type Description
quotaCounterKey
path True
  • 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

resourceGroupName
path True
  • string

The name of the resource group.

serviceName
path True
  • string

The name of the API Management service.

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True
  • string

Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

api-version
query True
  • string

Version of the API to be used with the client request.

Responses

Name Type Description
200 OK

Lists a collection of the quota counter values.

Other Status Codes

Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

ApiManagementGetQuotaCounterKeys

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/quotas/ba?api-version=2021-08-01

Sample Response

{
  "value": [
    {
      "counterKey": "ba",
      "periodKey": "0_P3Y6M4DT12H30M5S",
      "periodStartTime": "2014-08-04T04:24:35Z",
      "periodEndTime": "2018-02-08T16:54:40Z",
      "value": {
        "callsCount": 5,
        "kbTransferred": 2.5830078125
      }
    }
  ],
  "nextLink": ""
}

Definitions

ErrorFieldContract

Error Field contract.

ErrorResponse

Error Response.

QuotaCounterCollection

Paged Quota Counter list representation.

QuotaCounterContract

Quota counter details.

QuotaCounterValueContractProperties

Quota counter value details.

ErrorFieldContract

Error Field contract.

Name Type Description
code
  • string

Property level error code.

message
  • string

Human-readable representation of property-level error.

target
  • string

Property name.

ErrorResponse

Error Response.

Name Type Description
error.code
  • string

Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response.

error.details

The list of invalid fields send in request, in case of validation error.

error.message
  • string

Human-readable representation of the error.

QuotaCounterCollection

Paged Quota Counter list representation.

Name Type Description
count
  • integer

Total record count number across all pages.

nextLink
  • string

Next page link if any.

value

Quota counter values.

QuotaCounterContract

Quota counter details.

Name Type Description
counterKey
  • string

The Key value of the Counter. Must not be empty.

periodEndTime
  • string

The date of the end of Counter Period. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

periodKey
  • string

Identifier of the Period for which the counter was collected. Must not be empty.

periodStartTime
  • string

The date of the start of Counter Period. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

value

Quota Value Properties

QuotaCounterValueContractProperties

Quota counter value details.

Name Type Description
callsCount
  • integer

Number of times Counter was called.

kbTransferred
  • number

Data Transferred in KiloBytes.