QuotaByCounterKeys Interface

  • Reference
Package:
com.azure.resourcemanager.apimanagement.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-apimanagement:1.0.0-beta.4

public interface QuotaByCounterKeys

Resource collection API of QuotaByCounterKeys.

Method Summary

Modifier and Type Method and Description
abstract QuotaCounterCollection 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.
abstract Response<QuotaCounterCollection> listByServiceWithResponse(String resourceGroupName, String serviceName, String quotaCounterKey, Context context)

Lists a collection of current quota counter periods associated with the counter-key configured in the policy on the specified service instance.
abstract QuotaCounterCollection 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.
abstract Response<QuotaCounterCollection> updateWithResponse(String resourceGroupName, String serviceName, String quotaCounterKey, QuotaCounterValueUpdateContract parameters, Context context)

Updates all the quota counter values specified with the existing quota counter key to a value in the specified service instance.

Method Details

listByService

public abstract QuotaCounterCollection 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. The name is case insensitive.
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\u2019s accessible by "boo" counter key. But if it\u2019s defined as counter-key="@("b"+"a")" then it will be accessible by "ba" key.

Returns:

paged Quota Counter list representation.

listByServiceWithResponse

public abstract Response listByServiceWithResponse(String resourceGroupName, String serviceName, String quotaCounterKey, 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. The name is case insensitive.
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\u2019s accessible by "boo" counter key. But if it\u2019s 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<T>.

update

public abstract QuotaCounterCollection 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. The name is case insensitive.
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\u2019s accessible by "boo" counter key. But if it\u2019s 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.

updateWithResponse

public abstract Response updateWithResponse(String resourceGroupName, String serviceName, String quotaCounterKey, QuotaCounterValueUpdateContract parameters, 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. The name is case insensitive.
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\u2019s accessible by "boo" counter key. But if it\u2019s 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<T>.

Applies to