Class: Azure::ApiManagement::Mgmt::V2018_01_01::Api

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2018-01-01/generated/azure_mgmt_api_management/api.rb

Overview

ApiManagement Client

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Api

Creates and initializes a new instance of the Api class.

Parameters:

  • client —

    service class for accessing basic functionality.



17
18
19
 
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/api.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/2018-01-01/generated/azure_mgmt_api_management/api.rb', line 22

def client
  @client
end

Instance Method Details

#create_or_update(resource_group_name, service_name, api_id, parameters, if_match: nil, custom_headers: nil) ⇒ ApiContract

Creates new or updates existing specified API of the API Management service instance.

API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. entity, but required when updating an entity. 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.

  • api_id (String) —

    API revision identifier. Must be unique in the current

  • parameters (ApiCreateOrUpdateParameter) —

    Create or update parameters.

  • if_match (String) (defaults to: nil) —

    ETag of the Entity. Not required when creating an

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

    A hash of custom headers that

Returns:

  • (ApiContract) —

    operation results.



385
386
387
388
 
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/api.rb', line 385

def create_or_update(resource_group_name, service_name, api_id, parameters, if_match:nil, custom_headers:nil)
  response = create_or_update_async(resource_group_name, service_name, api_id, parameters, if_match:if_match, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#create_or_update_async(resource_group_name, service_name, api_id, parameters, if_match: nil, custom_headers: nil) ⇒ Concurrent::Promise

Creates new or updates existing specified API of the API Management service instance.

API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. entity, but required when updating an entity. 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.

  • api_id (String) —

    API revision identifier. Must be unique in the current

  • parameters (ApiCreateOrUpdateParameter) —

    Create or update parameters.

  • if_match (String) (defaults to: nil) —

    ETag of the Entity. Not required when creating an

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
 
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/api.rb', line 428

def create_or_update_async(resource_group_name, service_name, api_id, parameters, if_match:nil, 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, 'api_id is nil' if api_id.nil?
  fail ArgumentError, "'api_id' should satisfy the constraint - 'MaxLength': '256'" if !api_id.nil? && api_id.length > 256
  fail ArgumentError, "'api_id' should satisfy the constraint - 'MinLength': '1'" if !api_id.nil? && api_id.length < 1
  fail ArgumentError, "'api_id' should satisfy the constraint - 'Pattern': '^[^*#&+:<>?]+$'" if !api_id.nil? && api_id.match(Regexp.new('^^[^*#&+:<>?]+$$')).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['If-Match'] = if_match unless if_match.nil?
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?

  # Serialize Request
  request_mapper = Azure::ApiManagement::Mgmt::V2018_01_01::Models::ApiCreateOrUpdateParameter.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}/apis/{apiId}'

  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,'apiId' => api_id,'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(:put, 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 == 201 || 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 == 201
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::ApiManagement::Mgmt::V2018_01_01::Models::ApiContract.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
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::ApiManagement::Mgmt::V2018_01_01::Models::ApiContract.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

#create_or_update_with_http_info(resource_group_name, service_name, api_id, parameters, if_match: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Creates new or updates existing specified API of the API Management service instance.

API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. entity, but required when updating an entity. 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.

  • api_id (String) —

    API revision identifier. Must be unique in the current

  • parameters (ApiCreateOrUpdateParameter) —

    Create or update parameters.

  • if_match (String) (defaults to: nil) —

    ETag of the Entity. Not required when creating an

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



407
408
409
 
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/api.rb', line 407

def create_or_update_with_http_info(resource_group_name, service_name, api_id, parameters, if_match:nil, custom_headers:nil)
  create_or_update_async(resource_group_name, service_name, api_id, parameters, if_match:if_match, custom_headers:custom_headers).value!
end

#delete(resource_group_name, service_name, api_id, if_match, delete_revisions: nil, custom_headers: nil) ⇒ Object

Deletes the specified API of the API Management service instance.

API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. entity state from the header response of the GET request or it should be * for unconditional update. 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.

  • api_id (String) —

    API revision identifier. Must be unique in the current

  • if_match (String) —

    ETag of the Entity. ETag should match the current

  • delete_revisions (Boolean) (defaults to: nil) —

    Delete all revisions of the Api.

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

    A hash of custom headers that



646
647
648
649
 
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/api.rb', line 646

def delete(resource_group_name, service_name, api_id, if_match, delete_revisions:nil, custom_headers:nil)
  response = delete_async(resource_group_name, service_name, api_id, if_match, delete_revisions:delete_revisions, custom_headers:custom_headers).value!
  nil
end

#delete_async(resource_group_name, service_name, api_id, if_match, delete_revisions: nil, custom_headers: nil) ⇒ Concurrent::Promise

Deletes the specified API of the API Management service instance.

API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. entity state from the header response of the GET request or it should be * for unconditional update. 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.

  • api_id (String) —

    API revision identifier. Must be unique in the current

  • if_match (String) —

    ETag of the Entity. ETag should match the current

  • delete_revisions (Boolean) (defaults to: nil) —

    Delete all revisions of the Api.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
 
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/api.rb', line 689

def delete_async(resource_group_name, service_name, api_id, if_match, delete_revisions:nil, 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, 'api_id is nil' if api_id.nil?
  fail ArgumentError, "'api_id' should satisfy the constraint - 'MaxLength': '256'" if !api_id.nil? && api_id.length > 256
  fail ArgumentError, "'api_id' should satisfy the constraint - 'MinLength': '1'" if !api_id.nil? && api_id.length < 1
  fail ArgumentError, "'api_id' should satisfy the constraint - 'Pattern': '^[^*#&+:<>?]+$'" if !api_id.nil? && api_id.match(Regexp.new('^^[^*#&+:<>?]+$$')).nil?
  fail ArgumentError, 'if_match is nil' if if_match.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['If-Match'] = if_match unless if_match.nil?
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}'

  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,'apiId' => api_id,'subscriptionId' => @client.subscription_id},
      query_params: {'deleteRevisions' => delete_revisions,'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:delete, 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 || 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

#delete_with_http_info(resource_group_name, service_name, api_id, if_match, delete_revisions: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Deletes the specified API of the API Management service instance.

API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. entity state from the header response of the GET request or it should be * for unconditional update. 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.

  • api_id (String) —

    API revision identifier. Must be unique in the current

  • if_match (String) —

    ETag of the Entity. ETag should match the current

  • delete_revisions (Boolean) (defaults to: nil) —

    Delete all revisions of the Api.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



668
669
670
 
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/api.rb', line 668

def delete_with_http_info(resource_group_name, service_name, api_id, if_match, delete_revisions:nil, custom_headers:nil)
  delete_async(resource_group_name, service_name, api_id, if_match, delete_revisions:delete_revisions, custom_headers:custom_headers).value!
end

#get(resource_group_name, service_name, api_id, custom_headers: nil) ⇒ ApiContract

Gets the details of the API specified by its identifier.

API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. 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.

  • api_id (String) —

    API revision identifier. Must be unique in the current

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

    A hash of custom headers that

Returns:

  • (ApiContract) —

    operation results.



271
272
273
274
 
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/api.rb', line 271

def get(resource_group_name, service_name, api_id, custom_headers:nil)
  response = get_async(resource_group_name, service_name, api_id, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_async(resource_group_name, service_name, api_id, custom_headers: nil) ⇒ Concurrent::Promise

Gets the details of the API specified by its identifier.

API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. 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.

  • api_id (String) —

    API revision identifier. Must be unique in the current

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/api.rb', line 306

def get_async(resource_group_name, service_name, api_id, 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, 'api_id is nil' if api_id.nil?
  fail ArgumentError, "'api_id' should satisfy the constraint - 'MaxLength': '256'" if !api_id.nil? && api_id.length > 256
  fail ArgumentError, "'api_id' should satisfy the constraint - 'MinLength': '1'" if !api_id.nil? && api_id.length < 1
  fail ArgumentError, "'api_id' should satisfy the constraint - 'Pattern': '^[^*#&+:<>?]+$'" if !api_id.nil? && api_id.match(Regexp.new('^^[^*#&+:<>?]+$$')).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}/apis/{apiId}'

  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,'apiId' => api_id,'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::V2018_01_01::Models::ApiContract.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

#get_entity_tag(resource_group_name, service_name, api_id, custom_headers: nil) ⇒ Object

Gets the entity state (Etag) version of the API specified by its identifier.

API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. 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.

  • api_id (String) —

    API revision identifier. Must be unique in the current

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

    A hash of custom headers that



171
172
173
174
 
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/api.rb', line 171

def get_entity_tag(resource_group_name, service_name, api_id, custom_headers:nil)
  response = get_entity_tag_async(resource_group_name, service_name, api_id, custom_headers:custom_headers).value!
  nil
end

#get_entity_tag_async(resource_group_name, service_name, api_id, custom_headers: nil) ⇒ Concurrent::Promise

Gets the entity state (Etag) version of the API specified by its identifier.

API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. 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.

  • api_id (String) —

    API revision identifier. Must be unique in the current

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



206
207
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
 
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/api.rb', line 206

def get_entity_tag_async(resource_group_name, service_name, api_id, 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, 'api_id is nil' if api_id.nil?
  fail ArgumentError, "'api_id' should satisfy the constraint - 'MaxLength': '256'" if !api_id.nil? && api_id.length > 256
  fail ArgumentError, "'api_id' should satisfy the constraint - 'MinLength': '1'" if !api_id.nil? && api_id.length < 1
  fail ArgumentError, "'api_id' should satisfy the constraint - 'Pattern': '^[^*#&+:<>?]+$'" if !api_id.nil? && api_id.match(Regexp.new('^^[^*#&+:<>?]+$$')).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}/apis/{apiId}'

  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,'apiId' => api_id,'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(:head, 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?

    result
  end

  promise.execute
end

#get_entity_tag_with_http_info(resource_group_name, service_name, api_id, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets the entity state (Etag) version of the API specified by its identifier.

API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. 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.

  • api_id (String) —

    API revision identifier. Must be unique in the current

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



189
190
191
 
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/api.rb', line 189

def get_entity_tag_with_http_info(resource_group_name, service_name, api_id, custom_headers:nil)
  get_entity_tag_async(resource_group_name, service_name, api_id, custom_headers:custom_headers).value!
end

#get_with_http_info(resource_group_name, service_name, api_id, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets the details of the API specified by its identifier.

API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. 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.

  • api_id (String) —

    API revision identifier. Must be unique in the current

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



289
290
291
 
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/api.rb', line 289

def get_with_http_info(resource_group_name, service_name, api_id, custom_headers:nil)
  get_async(resource_group_name, service_name, api_id, custom_headers:custom_headers).value!
end

#list_by_service(resource_group_name, service_name, filter: nil, top: nil, skip: nil, expand_api_version_set: false, custom_headers: nil) ⇒ Array<ApiContract>

Lists all APIs of the API Management service instance.

functions | |————-|————————|———————————–| | id | ge, le, eq, ne, gt, lt | substringof, startswith, endswith | | name | ge, le, eq, ne, gt, lt | substringof, startswith, endswith | | description | ge, le, eq, ne, gt, lt | substringof, startswith, endswith | | serviceUrl | ge, le, eq, ne, gt, lt | substringof, startswith, endswith | | path | ge, le, eq, ne, gt, lt | substringof, startswith, endswith | in response 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.

  • filter (String) (defaults to: nil) —

    | Field | Supported operators | Supported

  • top (Integer) (defaults to: nil) —

    Number of records to return.

  • skip (Integer) (defaults to: nil) —

    Number of records to skip.

  • expand_api_version_set (Boolean) (defaults to: false) —

    Include full ApiVersionSet resource

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

    A hash of custom headers that

Returns:

  • (Array<ApiContract>) —

    operation results.



46
47
48
49
 
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/api.rb', line 46

def list_by_service(resource_group_name, service_name, filter:nil, top:nil, skip:nil, expand_api_version_set:false, custom_headers:nil)
  first_page = list_by_service_as_lazy(resource_group_name, service_name, filter:filter, top:top, skip:skip, expand_api_version_set:expand_api_version_set, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_by_service_as_lazy(resource_group_name, service_name, filter: nil, top: nil, skip: nil, expand_api_version_set: false, custom_headers: nil) ⇒ ApiCollection

Lists all APIs of the API Management service instance.

functions | |————-|————————|———————————–| | id | ge, le, eq, ne, gt, lt | substringof, startswith, endswith | | name | ge, le, eq, ne, gt, lt | substringof, startswith, endswith | | description | ge, le, eq, ne, gt, lt | substringof, startswith, endswith | | serviceUrl | ge, le, eq, ne, gt, lt | substringof, startswith, endswith | | path | ge, le, eq, ne, gt, lt | substringof, startswith, endswith | in response 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.

  • filter (String) (defaults to: nil) —

    | Field | Supported operators | Supported

  • top (Integer) (defaults to: nil) —

    Number of records to return.

  • skip (Integer) (defaults to: nil) —

    Number of records to skip.

  • expand_api_version_set (Boolean) (defaults to: false) —

    Include full ApiVersionSet resource

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

    A hash of custom headers that

Returns:

  • (ApiCollection) —

    which provide lazy access to pages of the response.



1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
 
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/api.rb', line 1107

def list_by_service_as_lazy(resource_group_name, service_name, filter:nil, top:nil, skip:nil, expand_api_version_set:false, custom_headers:nil)
  response = list_by_service_async(resource_group_name, service_name, filter:filter, top:top, skip:skip, expand_api_version_set:expand_api_version_set, custom_headers:custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_by_service_next_async(next_page_link, custom_headers:custom_headers)
    end
    page
  end
end

#list_by_service_async(resource_group_name, service_name, filter: nil, top: nil, skip: nil, expand_api_version_set: false, custom_headers: nil) ⇒ Concurrent::Promise

Lists all APIs of the API Management service instance.

functions | |————-|————————|———————————–| | id | ge, le, eq, ne, gt, lt | substringof, startswith, endswith | | name | ge, le, eq, ne, gt, lt | substringof, startswith, endswith | | description | ge, le, eq, ne, gt, lt | substringof, startswith, endswith | | serviceUrl | ge, le, eq, ne, gt, lt | substringof, startswith, endswith | | path | ge, le, eq, ne, gt, lt | substringof, startswith, endswith | in response 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.

  • filter (String) (defaults to: nil) —

    | Field | Supported operators | Supported

  • top (Integer) (defaults to: nil) —

    Number of records to return.

  • skip (Integer) (defaults to: nil) —

    Number of records to skip.

  • expand_api_version_set (Boolean) (defaults to: false) —

    Include full ApiVersionSet resource

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/api.rb', line 99

def list_by_service_async(resource_group_name, service_name, filter:nil, top:nil, skip:nil, expand_api_version_set:false, 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, "'top' should satisfy the constraint - 'InclusiveMinimum': '1'" if !top.nil? && top < 1
  fail ArgumentError, "'skip' should satisfy the constraint - 'InclusiveMinimum': '0'" if !skip.nil? && skip < 0
  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}/apis'

  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,'subscriptionId' => @client.subscription_id},
      query_params: {'$filter' => filter,'$top' => top,'$skip' => skip,'api-version' => @client.api_version,'expandApiVersionSet' => expand_api_version_set},
      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::V2018_01_01::Models::ApiCollection.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_next(next_page_link, custom_headers: nil) ⇒ ApiCollection

Lists all APIs of the API Management service instance.

to List operation. will be added to the HTTP request.

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful call

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

    A hash of custom headers that

Returns:

  • (ApiCollection) —

    operation results.



915
916
917
918
 
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/api.rb', line 915

def list_by_service_next(next_page_link, custom_headers:nil)
  response = list_by_service_next_async(next_page_link, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#list_by_service_next_async(next_page_link, custom_headers: nil) ⇒ Concurrent::Promise

Lists all APIs of the API Management service instance.

to List operation. to the HTTP request.

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful call

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
 
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/api.rb', line 944

def list_by_service_next_async(next_page_link, custom_headers:nil)
  fail ArgumentError, 'next_page_link is nil' if next_page_link.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 = '{nextLink}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      skip_encoding_path_params: {'nextLink' => next_page_link},
      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::V2018_01_01::Models::ApiCollection.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_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists all APIs of the API Management service instance.

to List operation. will be added to the HTTP request.

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful call

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



930
931
932
 
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/api.rb', line 930

def list_by_service_next_with_http_info(next_page_link, custom_headers:nil)
  list_by_service_next_async(next_page_link, custom_headers:custom_headers).value!
end

#list_by_service_with_http_info(resource_group_name, service_name, filter: nil, top: nil, skip: nil, expand_api_version_set: false, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists all APIs of the API Management service instance.

functions | |————-|————————|———————————–| | id | ge, le, eq, ne, gt, lt | substringof, startswith, endswith | | name | ge, le, eq, ne, gt, lt | substringof, startswith, endswith | | description | ge, le, eq, ne, gt, lt | substringof, startswith, endswith | | serviceUrl | ge, le, eq, ne, gt, lt | substringof, startswith, endswith | | path | ge, le, eq, ne, gt, lt | substringof, startswith, endswith | in response 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.

  • filter (String) (defaults to: nil) —

    | Field | Supported operators | Supported

  • top (Integer) (defaults to: nil) —

    Number of records to return.

  • skip (Integer) (defaults to: nil) —

    Number of records to skip.

  • expand_api_version_set (Boolean) (defaults to: false) —

    Include full ApiVersionSet resource

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



73
74
75
 
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/api.rb', line 73

def list_by_service_with_http_info(resource_group_name, service_name, filter:nil, top:nil, skip:nil, expand_api_version_set:false, custom_headers:nil)
  list_by_service_async(resource_group_name, service_name, filter:filter, top:top, skip:skip, expand_api_version_set:expand_api_version_set, custom_headers:custom_headers).value!
end

#list_by_tags(resource_group_name, service_name, filter: nil, top: nil, skip: nil, custom_headers: nil) ⇒ Array<TagResourceContract>

Lists a collection of apis associated with tags.

functions | |————-|————————|———————————————| | id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | aid | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | apiRevision | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | path | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | serviceUrl | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | isCurrent | eq | substringof, contains, startswith, endswith | 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.

  • filter (String) (defaults to: nil) —

    | Field | Supported operators | Supported

  • top (Integer) (defaults to: nil) —

    Number of records to return.

  • skip (Integer) (defaults to: nil) —

    Number of records to skip.

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

    A hash of custom headers that

Returns:

  • (Array<TagResourceContract>) —

    operation results.



774
775
776
777
 
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/api.rb', line 774

def list_by_tags(resource_group_name, service_name, filter:nil, top:nil, skip:nil, custom_headers:nil)
  first_page = list_by_tags_as_lazy(resource_group_name, service_name, filter:filter, top:top, skip:skip, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_by_tags_as_lazy(resource_group_name, service_name, filter: nil, top: nil, skip: nil, custom_headers: nil) ⇒ TagResourceCollection

Lists a collection of apis associated with tags.

functions | |————-|————————|———————————————| | id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | aid | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | apiRevision | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | path | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | serviceUrl | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | isCurrent | eq | substringof, contains, startswith, endswith | will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • service_name (String) —

    The name of the API Management service.

  • filter (String) (defaults to: nil) —

    | Field | Supported operators | Supported

  • top (Integer) (defaults to: nil) —

    Number of records to return.

  • skip (Integer) (defaults to: nil) —

    Number of records to skip.

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

    A hash of custom headers that

Returns:

  • (TagResourceCollection) —

    which provide lazy access to pages of the



1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
 
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/api.rb', line 1150

def list_by_tags_as_lazy(resource_group_name, service_name, filter:nil, top:nil, skip:nil, custom_headers:nil)
  response = list_by_tags_async(resource_group_name, service_name, filter:filter, top:top, skip:skip, custom_headers:custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_by_tags_next_async(next_page_link, custom_headers:custom_headers)
    end
    page
  end
end

#list_by_tags_async(resource_group_name, service_name, filter: nil, top: nil, skip: nil, custom_headers: nil) ⇒ Concurrent::Promise

Lists a collection of apis associated with tags.

functions | |————-|————————|———————————————| | id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | aid | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | apiRevision | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | path | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | serviceUrl | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | isCurrent | eq | substringof, contains, startswith, endswith | 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.

  • filter (String) (defaults to: nil) —

    | Field | Supported operators | Supported

  • top (Integer) (defaults to: nil) —

    Number of records to return.

  • skip (Integer) (defaults to: nil) —

    Number of records to skip.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
 
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/api.rb', line 845

def list_by_tags_async(resource_group_name, service_name, filter:nil, top:nil, skip:nil, 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, "'top' should satisfy the constraint - 'InclusiveMinimum': '1'" if !top.nil? && top < 1
  fail ArgumentError, "'skip' should satisfy the constraint - 'InclusiveMinimum': '0'" if !skip.nil? && skip < 0
  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}/apisByTags'

  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,'subscriptionId' => @client.subscription_id},
      query_params: {'$filter' => filter,'$top' => top,'$skip' => skip,'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 MsRestAzure::AzureOperationError.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::V2018_01_01::Models::TagResourceCollection.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_tags_next(next_page_link, custom_headers: nil) ⇒ TagResourceCollection

Lists a collection of apis associated with tags.

to List operation. will be added to the HTTP request.

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful call

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

    A hash of custom headers that

Returns:

  • (TagResourceCollection) —

    operation results.



1005
1006
1007
1008
 
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/api.rb', line 1005

def list_by_tags_next(next_page_link, custom_headers:nil)
  response = list_by_tags_next_async(next_page_link, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#list_by_tags_next_async(next_page_link, custom_headers: nil) ⇒ Concurrent::Promise

Lists a collection of apis associated with tags.

to List operation. to the HTTP request.

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful call

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
 
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/api.rb', line 1034

def list_by_tags_next_async(next_page_link, custom_headers:nil)
  fail ArgumentError, 'next_page_link is nil' if next_page_link.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 = '{nextLink}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      skip_encoding_path_params: {'nextLink' => next_page_link},
      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 MsRestAzure::AzureOperationError.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::V2018_01_01::Models::TagResourceCollection.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_tags_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists a collection of apis associated with tags.

to List operation. will be added to the HTTP request.

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful call

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



1020
1021
1022
 
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/api.rb', line 1020

def list_by_tags_next_with_http_info(next_page_link, custom_headers:nil)
  list_by_tags_next_async(next_page_link, custom_headers:custom_headers).value!
end

#list_by_tags_with_http_info(resource_group_name, service_name, filter: nil, top: nil, skip: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists a collection of apis associated with tags.

functions | |————-|————————|———————————————| | id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | aid | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | apiRevision | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | path | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | serviceUrl | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | isCurrent | eq | substringof, contains, startswith, endswith | 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.

  • filter (String) (defaults to: nil) —

    | Field | Supported operators | Supported

  • top (Integer) (defaults to: nil) —

    Number of records to return.

  • skip (Integer) (defaults to: nil) —

    Number of records to skip.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



810
811
812
 
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/api.rb', line 810

def list_by_tags_with_http_info(resource_group_name, service_name, filter:nil, top:nil, skip:nil, custom_headers:nil)
  list_by_tags_async(resource_group_name, service_name, filter:filter, top:top, skip:skip, custom_headers:custom_headers).value!
end

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

Updates the specified API of the API Management service instance.

API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. entity state from the header response of the GET request or it should be * for unconditional update. 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.

  • api_id (String) —

    API revision identifier. Must be unique in the current

  • parameters (ApiUpdateContract) —

    API Update Contract parameters.

  • if_match (String) —

    ETag of the Entity. ETag should match the current

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

    A hash of custom headers that



525
526
527
528
 
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/api.rb', line 525

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

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

Updates the specified API of the API Management service instance.

API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. entity state from the header response of the GET request or it should be * for unconditional update. 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.

  • api_id (String) —

    API revision identifier. Must be unique in the current

  • parameters (ApiUpdateContract) —

    API Update Contract parameters.

  • if_match (String) —

    ETag of the Entity. ETag should match the current

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
 
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/api.rb', line 568

def update_async(resource_group_name, service_name, api_id, parameters, if_match, 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, 'api_id is nil' if api_id.nil?
  fail ArgumentError, "'api_id' should satisfy the constraint - 'MaxLength': '256'" if !api_id.nil? && api_id.length > 256
  fail ArgumentError, "'api_id' should satisfy the constraint - 'MinLength': '1'" if !api_id.nil? && api_id.length < 1
  fail ArgumentError, "'api_id' should satisfy the constraint - 'Pattern': '^[^*#&+:<>?]+$'" if !api_id.nil? && api_id.match(Regexp.new('^^[^*#&+:<>?]+$$')).nil?
  fail ArgumentError, 'parameters is nil' if parameters.nil?
  fail ArgumentError, 'if_match is nil' if if_match.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['If-Match'] = if_match unless if_match.nil?
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?

  # Serialize Request
  request_mapper = Azure::ApiManagement::Mgmt::V2018_01_01::Models::ApiUpdateContract.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}/apis/{apiId}'

  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,'apiId' => api_id,'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, api_id, parameters, if_match, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Updates the specified API of the API Management service instance.

API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. entity state from the header response of the GET request or it should be * for unconditional update. 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.

  • api_id (String) —

    API revision identifier. Must be unique in the current

  • parameters (ApiUpdateContract) —

    API Update Contract parameters.

  • if_match (String) —

    ETag of the Entity. ETag should match the current

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



547
548
549
 
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/api.rb', line 547

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