Package com.azure.resourcemanager.apimanagement.fluent

Interface QuotaByPeriodKeysClient

public interface QuotaByPeriodKeysClient
An instance of this class provides access to all the operations defined in QuotaByPeriodKeysClient.

  • Method Details

    • getWithResponse

      com.azure.core.http.rest.Response<QuotaCounterContractInner> getWithResponse(String resourceGroupName, String serviceName, String quotaCounterKey, String quotaPeriodKey, com.azure.core.util.Context context)
      Gets the value of the quota counter associated with the counter-key in the policy for the specific period in service instance.
      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’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 - Quota period key identifier.
      context - The context to associate with this operation.
      Returns:
      the value of the quota counter associated with the counter-key in the policy for the specific period in service instance 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.

    • get

      QuotaCounterContractInner get(String resourceGroupName, String serviceName, String quotaCounterKey, String quotaPeriodKey)
      Gets the value of the quota counter associated with the counter-key in the policy for the specific period in service instance.
      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’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 - Quota period key identifier.
      Returns:
      the value of the quota counter associated with the counter-key in the policy for the specific period in service instance.
      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<QuotaCounterContractInner> updateWithResponse(String resourceGroupName, String serviceName, String quotaCounterKey, String quotaPeriodKey, QuotaCounterValueUpdateContract parameters, com.azure.core.util.Context context)
      Updates an existing quota counter value in the specified service instance.
      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’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 - Quota period key identifier.
      parameters - The value of the Quota counter to be applied on the specified period.
      context - The context to associate with this operation.
      Returns:
      quota counter details 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

      QuotaCounterContractInner update(String resourceGroupName, String serviceName, String quotaCounterKey, String quotaPeriodKey, QuotaCounterValueUpdateContract parameters)
      Updates an existing quota counter value in the specified service instance.
      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’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 - Quota period key identifier.
      parameters - The value of the Quota counter to be applied on the specified period.
      Returns:
      quota counter details.
      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.