IQuotaByPeriodKeysOperations.GetWithHttpMessagesAsync(String, String, String, String, Dictionary<String,List<String>>, CancellationToken) Method

Definition

Gets the value of the quota counter associated with the counter-key in the policy for the specific period in service instance. https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-product-with-rules#a-namepolicies-ato-configure-call-rate-limit-and-quota-policies

public System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Azure.Management.ApiManagement.Models.QuotaCounterContract>> GetWithHttpMessagesAsync (string resourceGroupName, string serviceName, string quotaCounterKey, string quotaPeriodKey, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);
abstract member GetWithHttpMessagesAsync : string * string * string * string * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Azure.Management.ApiManagement.Models.QuotaCounterContract>>
Public Function GetWithHttpMessagesAsync (resourceGroupName As String, serviceName As String, quotaCounterKey As String, quotaPeriodKey As String, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AzureOperationResponse(Of QuotaCounterContract))

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.

customHeaders
Dictionary<String,List<String>>

The headers that will be added to request.

cancellationToken
CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse<QuotaCounterContract>>

Exceptions

Thrown when the operation returned an invalid status code

Thrown when unable to deserialize the response

Thrown when a required parameter is null

Applies to