Class: Azure::ApiManagement::Mgmt::V2018_06_01_preview::ApiOperation

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

Overview

ApiManagement Client

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ ApiOperation

Creates and initializes a new instance of the ApiOperation class.

Parameters:

  • client —

    service class for accessing basic functionality.



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

def client
  @client
end

Instance Method Details

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

Creates a new operation in the API or updates an existing one.

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

  • operation_id (String) —

    Operation identifier within an API. Must be

  • parameters (OperationContract) —

    Create 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:

  • (OperationContract) —

    operation results.



437
438
439
440
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_api_management/api_operation.rb', line 437

def create_or_update(resource_group_name, service_name, api_id, operation_id, parameters, if_match:nil, custom_headers:nil)
  response = create_or_update_async(resource_group_name, service_name, api_id, operation_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, operation_id, parameters, if_match: nil, custom_headers: nil) ⇒ Concurrent::Promise

Creates a new operation in the API or updates an existing one.

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

  • operation_id (String) —

    Operation identifier within an API. Must be

  • parameters (OperationContract) —

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



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
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_api_management/api_operation.rb', line 482

def create_or_update_async(resource_group_name, service_name, api_id, operation_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, 'operation_id is nil' if operation_id.nil?
  fail ArgumentError, "'operation_id' should satisfy the constraint - 'MaxLength': '80'" if !operation_id.nil? && operation_id.length > 80
  fail ArgumentError, "'operation_id' should satisfy the constraint - 'MinLength': '1'" if !operation_id.nil? && operation_id.length < 1
  fail ArgumentError, "'operation_id' should satisfy the constraint - 'Pattern': '^[^*#&+:<>?]+$'" if !operation_id.nil? && operation_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_06_01_preview::Models::OperationContract.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}/operations/{operationId}'

  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,'operationId' => operation_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_06_01_preview::Models::OperationContract.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_06_01_preview::Models::OperationContract.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, operation_id, parameters, if_match: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Creates a new operation in the API or updates an existing one.

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

  • operation_id (String) —

    Operation identifier within an API. Must be

  • parameters (OperationContract) —

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



460
461
462
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_api_management/api_operation.rb', line 460

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

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

Deletes the specified operation in the API.

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

  • operation_id (String) —

    Operation identifier within an API. Must be

  • 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



715
716
717
718
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_api_management/api_operation.rb', line 715

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

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

Deletes the specified operation in the API.

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

  • operation_id (String) —

    Operation identifier within an API. Must be

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



760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_api_management/api_operation.rb', line 760

def delete_async(resource_group_name, service_name, api_id, operation_id, 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, 'operation_id is nil' if operation_id.nil?
  fail ArgumentError, "'operation_id' should satisfy the constraint - 'MaxLength': '80'" if !operation_id.nil? && operation_id.length > 80
  fail ArgumentError, "'operation_id' should satisfy the constraint - 'MinLength': '1'" if !operation_id.nil? && operation_id.length < 1
  fail ArgumentError, "'operation_id' should satisfy the constraint - 'Pattern': '^[^*#&+:<>?]+$'" if !operation_id.nil? && operation_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}/operations/{operationId}'

  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,'operationId' => operation_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(: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, operation_id, if_match, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Deletes the specified operation in the API.

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

  • operation_id (String) —

    Operation identifier within an API. Must be

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



738
739
740
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_api_management/api_operation.rb', line 738

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

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

Gets the details of the API Operation specified by its identifier.

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

  • operation_id (String) —

    Operation identifier within an API. Must be

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

    A hash of custom headers that

Returns:

  • (OperationContract) —

    operation results.



314
315
316
317
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_api_management/api_operation.rb', line 314

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

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

Gets the details of the API Operation specified by its identifier.

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

  • operation_id (String) —

    Operation identifier within an API. Must be

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_api_management/api_operation.rb', line 353

def get_async(resource_group_name, service_name, api_id, operation_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, 'operation_id is nil' if operation_id.nil?
  fail ArgumentError, "'operation_id' should satisfy the constraint - 'MaxLength': '80'" if !operation_id.nil? && operation_id.length > 80
  fail ArgumentError, "'operation_id' should satisfy the constraint - 'MinLength': '1'" if !operation_id.nil? && operation_id.length < 1
  fail ArgumentError, "'operation_id' should satisfy the constraint - 'Pattern': '^[^*#&+:<>?]+$'" if !operation_id.nil? && operation_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}/operations/{operationId}'

  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,'operationId' => operation_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_06_01_preview::Models::OperationContract.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, operation_id, custom_headers: nil) ⇒ Object

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

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

  • operation_id (String) —

    Operation identifier within an API. Must be

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

    A hash of custom headers that



202
203
204
205
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_api_management/api_operation.rb', line 202

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

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

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

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

  • operation_id (String) —

    Operation identifier within an API. Must be

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_api_management/api_operation.rb', line 243

def get_entity_tag_async(resource_group_name, service_name, api_id, operation_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, 'operation_id is nil' if operation_id.nil?
  fail ArgumentError, "'operation_id' should satisfy the constraint - 'MaxLength': '80'" if !operation_id.nil? && operation_id.length > 80
  fail ArgumentError, "'operation_id' should satisfy the constraint - 'MinLength': '1'" if !operation_id.nil? && operation_id.length < 1
  fail ArgumentError, "'operation_id' should satisfy the constraint - 'Pattern': '^[^*#&+:<>?]+$'" if !operation_id.nil? && operation_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}/operations/{operationId}'

  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,'operationId' => operation_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, operation_id, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

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

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

  • operation_id (String) —

    Operation identifier within an API. Must be

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



223
224
225
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_api_management/api_operation.rb', line 223

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

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

Gets the details of the API Operation specified by its identifier.

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

  • operation_id (String) —

    Operation identifier within an API. Must be

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



334
335
336
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_api_management/api_operation.rb', line 334

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

#list_by_api(resource_group_name, service_name, api_id, filter: nil, top: nil, skip: nil, tags: nil, custom_headers: nil) ⇒ Array<OperationContract>

Lists a collection of the operations for the specified API.

API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. functions | |————-|————————|———————————–|

|name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith| |displayName | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith| |method | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith| |description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith| |urlTemplate | ge, le, eq, ne, gt, lt | 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.

  • api_id (String) —

    API revision identifier. Must be unique in the current

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

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

    A hash of custom headers that

Returns:

  • (Array<OperationContract>) —

    operation results.



54
55
56
57
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_api_management/api_operation.rb', line 54

def list_by_api(resource_group_name, service_name, api_id, filter:nil, top:nil, skip:nil, tags:nil, custom_headers:nil)
  first_page = list_by_api_as_lazy(resource_group_name, service_name, api_id, filter:filter, top:top, skip:skip, tags:tags, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_by_api_as_lazy(resource_group_name, service_name, api_id, filter: nil, top: nil, skip: nil, tags: nil, custom_headers: nil) ⇒ OperationCollection

Lists a collection of the operations for the specified API.

API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. functions | |————-|————————|———————————–|

|name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith| |displayName | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith| |method | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith| |description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith| |urlTemplate | ge, le, eq, ne, gt, lt | 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.

  • api_id (String) —

    API revision identifier. Must be unique in the current

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

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

    A hash of custom headers that

Returns:

  • (OperationCollection) —

    which provide lazy access to pages of the



939
940
941
942
943
944
945
946
947
948
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_api_management/api_operation.rb', line 939

def list_by_api_as_lazy(resource_group_name, service_name, api_id, filter:nil, top:nil, skip:nil, tags:nil, custom_headers:nil)
  response = list_by_api_async(resource_group_name, service_name, api_id, filter:filter, top:top, skip:skip, tags:tags, custom_headers:custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_by_api_next_async(next_page_link, custom_headers:custom_headers)
    end
    page
  end
end

#list_by_api_async(resource_group_name, service_name, api_id, filter: nil, top: nil, skip: nil, tags: nil, custom_headers: nil) ⇒ Concurrent::Promise

Lists a collection of the operations for the specified API.

API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. functions | |————-|————————|———————————–|

|name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith| |displayName | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith| |method | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith| |description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith| |urlTemplate | ge, le, eq, ne, gt, lt | 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.

  • api_id (String) —

    API revision identifier. Must be unique in the current

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

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_api_management/api_operation.rb', line 123

def list_by_api_async(resource_group_name, service_name, api_id, filter:nil, top:nil, skip:nil, tags: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, "'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/{apiId}/operations'

  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: {'$filter' => filter,'$top' => top,'$skip' => skip,'tags' => tags,'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_06_01_preview::Models::OperationCollection.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_api_next(next_page_link, custom_headers: nil) ⇒ OperationCollection

Lists a collection of the operations for the specified API.

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:

  • (OperationCollection) —

    operation results.



828
829
830
831
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_api_management/api_operation.rb', line 828

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

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

Lists a collection of the operations for the specified API.

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.



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
904
905
906
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_api_management/api_operation.rb', line 857

def list_by_api_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_06_01_preview::Models::OperationCollection.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_api_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists a collection of the operations for the specified API.

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.



843
844
845
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_api_management/api_operation.rb', line 843

def list_by_api_next_with_http_info(next_page_link, custom_headers:nil)
  list_by_api_next_async(next_page_link, custom_headers:custom_headers).value!
end

#list_by_api_with_http_info(resource_group_name, service_name, api_id, filter: nil, top: nil, skip: nil, tags: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists a collection of the operations for the specified API.

API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. functions | |————-|————————|———————————–|

|name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith| |displayName | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith| |method | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith| |description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith| |urlTemplate | ge, le, eq, ne, gt, lt | 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.

  • api_id (String) —

    API revision identifier. Must be unique in the current

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

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



89
90
91
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_api_management/api_operation.rb', line 89

def list_by_api_with_http_info(resource_group_name, service_name, api_id, filter:nil, top:nil, skip:nil, tags:nil, custom_headers:nil)
  list_by_api_async(resource_group_name, service_name, api_id, filter:filter, top:top, skip:skip, tags:tags, custom_headers:custom_headers).value!
end

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

Updates the details of the operation in 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. unique in the current API Management service instance. 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

  • operation_id (String) —

    Operation identifier within an API. Must be

  • parameters (OperationUpdateContract) —

    API Operation Update 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



585
586
587
588
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_api_management/api_operation.rb', line 585

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

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

Updates the details of the operation in 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. unique in the current API Management service instance. 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

  • operation_id (String) —

    Operation identifier within an API. Must be

  • parameters (OperationUpdateContract) —

    API Operation Update 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.



632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_api_management/api_operation.rb', line 632

def update_async(resource_group_name, service_name, api_id, operation_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, 'operation_id is nil' if operation_id.nil?
  fail ArgumentError, "'operation_id' should satisfy the constraint - 'MaxLength': '80'" if !operation_id.nil? && operation_id.length > 80
  fail ArgumentError, "'operation_id' should satisfy the constraint - 'MinLength': '1'" if !operation_id.nil? && operation_id.length < 1
  fail ArgumentError, "'operation_id' should satisfy the constraint - 'Pattern': '^[^*#&+:<>?]+$'" if !operation_id.nil? && operation_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_06_01_preview::Models::OperationUpdateContract.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}/operations/{operationId}'

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

Updates the details of the operation in 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. unique in the current API Management service instance. 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

  • operation_id (String) —

    Operation identifier within an API. Must be

  • parameters (OperationUpdateContract) —

    API Operation Update 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.



609
610
611
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_api_management/api_operation.rb', line 609

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