Class: Azure::ApiManagement::Mgmt::V2019_12_01::QuotaByCounterKeys

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2019-12-01/generated/azure_mgmt_api_management/quota_by_counter_keys.rb

Overview

ApiManagement Client

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ QuotaByCounterKeys

Creates and initializes a new instance of the QuotaByCounterKeys class.

Parameters:

  • client —

    service class for accessing basic functionality.



17
18
19
 
# File 'lib/2019-12-01/generated/azure_mgmt_api_management/quota_by_counter_keys.rb', line 17

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ ApiManagementClient (readonly)

Returns reference to the ApiManagementClient.

Returns:



22
23
24
 
# File 'lib/2019-12-01/generated/azure_mgmt_api_management/quota_by_counter_keys.rb', line 22

def client
  @client
end

Instance Method Details

#list_by_service(resource_group_name, service_name, quota_counter_key, custom_headers: nil) ⇒ QuotaCounterCollection

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.

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 will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • service_name (String) —

    The name of the API Management service.

  • quota_counter_key (String) —

    Quota counter key identifier.This is the

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (QuotaCounterCollection) —

    operation results.



41
42
43
44
 
# File 'lib/2019-12-01/generated/azure_mgmt_api_management/quota_by_counter_keys.rb', line 41

def list_by_service(resource_group_name, service_name, quota_counter_key, custom_headers:nil)
  response = list_by_service_async(resource_group_name, service_name, quota_counter_key, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#list_by_service_async(resource_group_name, service_name, quota_counter_key, custom_headers: nil) ⇒ Concurrent::Promise

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.

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 to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • service_name (String) —

    The name of the API Management service.

  • quota_counter_key (String) —

    Quota counter key identifier.This is the

  • A (Hash{String => String}) —

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/2019-12-01/generated/azure_mgmt_api_management/quota_by_counter_keys.rb', line 84

def list_by_service_async(resource_group_name, service_name, quota_counter_key, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'service_name is nil' if service_name.nil?
  fail ArgumentError, "'service_name' should satisfy the constraint - 'MaxLength': '50'" if !service_name.nil? && service_name.length > 50
  fail ArgumentError, "'service_name' should satisfy the constraint - 'MinLength': '1'" if !service_name.nil? && service_name.length < 1
  fail ArgumentError, "'service_name' should satisfy the constraint - 'Pattern': '^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$'" if !service_name.nil? && service_name.match(Regexp.new('^^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$$')).nil?
  fail ArgumentError, 'quota_counter_key is nil' if quota_counter_key.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/quotas/{quotaCounterKey}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'serviceName' => service_name,'quotaCounterKey' => quota_counter_key,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:get, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail MsRest::HttpOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::ApiManagement::Mgmt::V2019_12_01::Models::QuotaCounterCollection.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#list_by_service_with_http_info(resource_group_name, service_name, quota_counter_key, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

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.

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 will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • service_name (String) —

    The name of the API Management service.

  • quota_counter_key (String) —

    Quota counter key identifier.This is the

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



63
64
65
 
# File 'lib/2019-12-01/generated/azure_mgmt_api_management/quota_by_counter_keys.rb', line 63

def list_by_service_with_http_info(resource_group_name, service_name, quota_counter_key, custom_headers:nil)
  list_by_service_async(resource_group_name, service_name, quota_counter_key, custom_headers:custom_headers).value!
end

#update(resource_group_name, service_name, quota_counter_key, parameters, custom_headers: nil) ⇒ Object

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.

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 quota counter to be applied to all quota counter periods. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • service_name (String) —

    The name of the API Management service.

  • quota_counter_key (String) —

    Quota counter key identifier.This is the

  • parameters (QuotaCounterValueContractProperties) —

    The value of the

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that



161
162
163
164
 
# File 'lib/2019-12-01/generated/azure_mgmt_api_management/quota_by_counter_keys.rb', line 161

def update(resource_group_name, service_name, quota_counter_key, parameters, custom_headers:nil)
  response = update_async(resource_group_name, service_name, quota_counter_key, parameters, custom_headers:custom_headers).value!
  nil
end

#update_async(resource_group_name, service_name, quota_counter_key, parameters, custom_headers: nil) ⇒ Concurrent::Promise

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.

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 quota counter to be applied to all quota counter periods. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • service_name (String) —

    The name of the API Management service.

  • quota_counter_key (String) —

    Quota counter key identifier.This is the

  • parameters (QuotaCounterValueContractProperties) —

    The value of the

  • A (Hash{String => String}) —

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/2019-12-01/generated/azure_mgmt_api_management/quota_by_counter_keys.rb', line 208

def update_async(resource_group_name, service_name, quota_counter_key, parameters, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'service_name is nil' if service_name.nil?
  fail ArgumentError, "'service_name' should satisfy the constraint - 'MaxLength': '50'" if !service_name.nil? && service_name.length > 50
  fail ArgumentError, "'service_name' should satisfy the constraint - 'MinLength': '1'" if !service_name.nil? && service_name.length < 1
  fail ArgumentError, "'service_name' should satisfy the constraint - 'Pattern': '^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$'" if !service_name.nil? && service_name.match(Regexp.new('^^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$$')).nil?
  fail ArgumentError, 'quota_counter_key is nil' if quota_counter_key.nil?
  fail ArgumentError, 'parameters is nil' if parameters.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?

  # Serialize Request
  request_mapper = Azure::ApiManagement::Mgmt::V2019_12_01::Models::QuotaCounterValueContractProperties.mapper()
  request_content = @client.serialize(request_mapper,  parameters)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/quotas/{quotaCounterKey}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'serviceName' => service_name,'quotaCounterKey' => quota_counter_key,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:patch, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 204
      error_model = JSON.load(response_content)
      fail MsRest::HttpOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?

    result
  end

  promise.execute
end

#update_with_http_info(resource_group_name, service_name, quota_counter_key, parameters, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

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.

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 quota counter to be applied to all quota counter periods. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • service_name (String) —

    The name of the API Management service.

  • quota_counter_key (String) —

    Quota counter key identifier.This is the

  • parameters (QuotaCounterValueContractProperties) —

    The value of the

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



185
186
187
 
# File 'lib/2019-12-01/generated/azure_mgmt_api_management/quota_by_counter_keys.rb', line 185

def update_with_http_info(resource_group_name, service_name, quota_counter_key, parameters, custom_headers:nil)
  update_async(resource_group_name, service_name, quota_counter_key, parameters, custom_headers:custom_headers).value!
end