Package com.azure.resourcemanager.apimanagement.fluent

Interface QuotaByCounterKeysClient

public interface QuotaByCounterKeysClient

An instance of this class provides access to all the operations defined in QuotaByCounterKeysClient.

Method Summary

Modifier and Type	Method	Description
QuotaCounterCollectionInner	listByService(String resourceGroupName, String serviceName, String quotaCounterKey)	Lists a collection of current quota counter periods associated with the counter-key configured in the policy on the specified service instance.
com.azure.core.http.rest.Response<QuotaCounterCollectionInner>	listByServiceWithResponse(String resourceGroupName, String serviceName, String quotaCounterKey, com.azure.core.util.Context context)	Lists a collection of current quota counter periods associated with the counter-key configured in the policy on the specified service instance.
QuotaCounterCollectionInner	update(String resourceGroupName, String serviceName, String quotaCounterKey, QuotaCounterValueUpdateContract parameters)	Updates all the quota counter values specified with the existing quota counter key to a value in the specified service instance.
com.azure.core.http.rest.Response<QuotaCounterCollectionInner>	updateWithResponse(String resourceGroupName, String serviceName, String quotaCounterKey, QuotaCounterValueUpdateContract parameters, com.azure.core.util.Context context)	Updates all the quota counter values specified with the existing quota counter key to a value in the specified service instance.

Method Detail

listByService

QuotaCounterCollectionInner listByService(String resourceGroupName,
                                          String serviceName,
                                          String quotaCounterKey)

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.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

quotaCounterKey - 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.

Returns:

paged Quota Counter list representation.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

listByServiceWithResponse

com.azure.core.http.rest.Response<QuotaCounterCollectionInner> listByServiceWithResponse(String resourceGroupName,
                                                                                         String serviceName,
                                                                                         String quotaCounterKey,
                                                                                         com.azure.core.util.Context context)

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.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

quotaCounterKey - 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.

context - The context to associate with this operation.

Returns:

paged Quota Counter list representation along with Response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

update

QuotaCounterCollectionInner update(String resourceGroupName,
                                   String serviceName,
                                   String quotaCounterKey,
                                   QuotaCounterValueUpdateContract parameters)

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.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

quotaCounterKey - 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 - The value of the quota counter to be applied to all quota counter periods.

Returns:

paged Quota Counter list representation.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

updateWithResponse

com.azure.core.http.rest.Response<QuotaCounterCollectionInner> updateWithResponse(String resourceGroupName,
                                                                                  String serviceName,
                                                                                  String quotaCounterKey,
                                                                                  QuotaCounterValueUpdateContract parameters,
                                                                                  com.azure.core.util.Context context)

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.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

quotaCounterKey - 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 - The value of the quota counter to be applied to all quota counter periods.

context - The context to associate with this operation.

Returns:

paged Quota Counter list representation along with Response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.