Class: Azure::BotService::Mgmt::V2018_07_12_preview::Channels

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2018-07-12-preview/generated/azure_mgmt_bot_service/channels.rb

Overview

Azure Bot Service is a platform for creating smart conversational agents.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Channels

Creates and initializes a new instance of the Channels class.

Parameters:

  • client —

    service class for accessing basic functionality.



17
18
19
 
# File 'lib/2018-07-12-preview/generated/azure_mgmt_bot_service/channels.rb', line 17

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ AzureBotService (readonly)

Returns reference to the AzureBotService.

Returns:



22
23
24
 
# File 'lib/2018-07-12-preview/generated/azure_mgmt_bot_service/channels.rb', line 22

def client
  @client
end

Instance Method Details

#create(resource_group_name, resource_name, channel_name, parameters, custom_headers: nil) ⇒ BotChannel

Creates a Channel registration for a Bot Service

user subscription. values include: ‘FacebookChannel’, ‘EmailChannel’, ‘KikChannel’, ‘TelegramChannel’, ‘SlackChannel’, ‘MsTeamsChannel’, ‘SkypeChannel’, ‘WebChatChannel’, ‘DirectLineChannel’, ‘SmsChannel’ will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the Bot resource group in the

  • resource_name (String) —

    The name of the Bot resource.

  • channel_name (ChannelName) —

    The name of the Channel resource. Possible

  • parameters (BotChannel) —

    The parameters to provide for the created bot.

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

    A hash of custom headers that

Returns:

  • (BotChannel) —

    operation results.



40
41
42
43
 
# File 'lib/2018-07-12-preview/generated/azure_mgmt_bot_service/channels.rb', line 40

def create(resource_group_name, resource_name, channel_name, parameters, custom_headers:nil)
  response = create_async(resource_group_name, resource_name, channel_name, parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#create_async(resource_group_name, resource_name, channel_name, parameters, custom_headers: nil) ⇒ Concurrent::Promise

Creates a Channel registration for a Bot Service

user subscription. values include: ‘FacebookChannel’, ‘EmailChannel’, ‘KikChannel’, ‘TelegramChannel’, ‘SlackChannel’, ‘MsTeamsChannel’, ‘SkypeChannel’, ‘WebChatChannel’, ‘DirectLineChannel’, ‘SmsChannel’ to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the Bot resource group in the

  • resource_name (String) —

    The name of the Bot resource.

  • channel_name (ChannelName) —

    The name of the Channel resource. Possible

  • parameters (BotChannel) —

    The parameters to provide for the created bot.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/2018-07-12-preview/generated/azure_mgmt_bot_service/channels.rb', line 81

def create_async(resource_group_name, resource_name, channel_name, parameters, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MaxLength': '64'" if !resource_group_name.nil? && resource_group_name.length > 64
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MinLength': '2'" if !resource_group_name.nil? && resource_group_name.length < 2
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'Pattern': '^[a-zA-Z0-9][a-zA-Z0-9_.-]*$'" if !resource_group_name.nil? && resource_group_name.match(Regexp.new('^^[a-zA-Z0-9][a-zA-Z0-9_.-]*$$')).nil?
  fail ArgumentError, 'resource_name is nil' if resource_name.nil?
  fail ArgumentError, "'resource_name' should satisfy the constraint - 'MaxLength': '64'" if !resource_name.nil? && resource_name.length > 64
  fail ArgumentError, "'resource_name' should satisfy the constraint - 'MinLength': '2'" if !resource_name.nil? && resource_name.length < 2
  fail ArgumentError, "'resource_name' should satisfy the constraint - 'Pattern': '^[a-zA-Z0-9][a-zA-Z0-9_.-]*$'" if !resource_name.nil? && resource_name.match(Regexp.new('^^[a-zA-Z0-9][a-zA-Z0-9_.-]*$$')).nil?
  fail ArgumentError, 'channel_name is nil' if channel_name.nil?
  fail ArgumentError, 'parameters is nil' if parameters.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?


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

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

  # Serialize Request
  request_mapper = Azure::BotService::Mgmt::V2018_07_12_preview::Models::BotChannel.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.BotService/botServices/{resourceName}/channels/{channelName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'resourceName' => resource_name,'channelName' => channel_name,'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 == 200 || status_code == 201
      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::BotService::Mgmt::V2018_07_12_preview::Models::BotChannel.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 == 201
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::BotService::Mgmt::V2018_07_12_preview::Models::BotChannel.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_with_http_info(resource_group_name, resource_name, channel_name, parameters, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Creates a Channel registration for a Bot Service

user subscription. values include: ‘FacebookChannel’, ‘EmailChannel’, ‘KikChannel’, ‘TelegramChannel’, ‘SlackChannel’, ‘MsTeamsChannel’, ‘SkypeChannel’, ‘WebChatChannel’, ‘DirectLineChannel’, ‘SmsChannel’ will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the Bot resource group in the

  • resource_name (String) —

    The name of the Bot resource.

  • channel_name (ChannelName) —

    The name of the Channel resource. Possible

  • parameters (BotChannel) —

    The parameters to provide for the created bot.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



61
62
63
 
# File 'lib/2018-07-12-preview/generated/azure_mgmt_bot_service/channels.rb', line 61

def create_with_http_info(resource_group_name, resource_name, channel_name, parameters, custom_headers:nil)
  create_async(resource_group_name, resource_name, channel_name, parameters, custom_headers:custom_headers).value!
end

#delete(resource_group_name, resource_name, channel_name, custom_headers: nil) ⇒ Object

Deletes a Channel registration from a Bot Service

user subscription. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the Bot resource group in the

  • resource_name (String) —

    The name of the Bot resource.

  • channel_name (String) —

    The name of the Bot resource.

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

    A hash of custom headers that



341
342
343
344
 
# File 'lib/2018-07-12-preview/generated/azure_mgmt_bot_service/channels.rb', line 341

def delete(resource_group_name, resource_name, channel_name, custom_headers:nil)
  response = delete_async(resource_group_name, resource_name, channel_name, custom_headers:custom_headers).value!
  nil
end

#delete_async(resource_group_name, resource_name, channel_name, custom_headers: nil) ⇒ Concurrent::Promise

Deletes a Channel registration from a Bot Service

user subscription. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the Bot resource group in the

  • resource_name (String) —

    The name of the Bot resource.

  • channel_name (String) —

    The name of the Bot resource.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
418
419
420
421
422
423
424
425
426
427
 
# File 'lib/2018-07-12-preview/generated/azure_mgmt_bot_service/channels.rb', line 374

def delete_async(resource_group_name, resource_name, channel_name, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MaxLength': '64'" if !resource_group_name.nil? && resource_group_name.length > 64
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MinLength': '2'" if !resource_group_name.nil? && resource_group_name.length < 2
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'Pattern': '^[a-zA-Z0-9][a-zA-Z0-9_.-]*$'" if !resource_group_name.nil? && resource_group_name.match(Regexp.new('^^[a-zA-Z0-9][a-zA-Z0-9_.-]*$$')).nil?
  fail ArgumentError, 'resource_name is nil' if resource_name.nil?
  fail ArgumentError, "'resource_name' should satisfy the constraint - 'MaxLength': '64'" if !resource_name.nil? && resource_name.length > 64
  fail ArgumentError, "'resource_name' should satisfy the constraint - 'MinLength': '2'" if !resource_name.nil? && resource_name.length < 2
  fail ArgumentError, "'resource_name' should satisfy the constraint - 'Pattern': '^[a-zA-Z0-9][a-zA-Z0-9_.-]*$'" if !resource_name.nil? && resource_name.match(Regexp.new('^^[a-zA-Z0-9][a-zA-Z0-9_.-]*$$')).nil?
  fail ArgumentError, 'channel_name is nil' if channel_name.nil?
  fail ArgumentError, "'channel_name' should satisfy the constraint - 'MaxLength': '64'" if !channel_name.nil? && channel_name.length > 64
  fail ArgumentError, "'channel_name' should satisfy the constraint - 'MinLength': '2'" if !channel_name.nil? && channel_name.length < 2
  fail ArgumentError, "'channel_name' should satisfy the constraint - 'Pattern': '^[a-zA-Z0-9][a-zA-Z0-9_.-]*$'" if !channel_name.nil? && channel_name.match(Regexp.new('^^[a-zA-Z0-9][a-zA-Z0-9_.-]*$$')).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.BotService/botServices/{resourceName}/channels/{channelName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'resourceName' => resource_name,'channelName' => channel_name,'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, resource_name, channel_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Deletes a Channel registration from a Bot Service

user subscription. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the Bot resource group in the

  • resource_name (String) —

    The name of the Bot resource.

  • channel_name (String) —

    The name of the Bot resource.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



358
359
360
 
# File 'lib/2018-07-12-preview/generated/azure_mgmt_bot_service/channels.rb', line 358

def delete_with_http_info(resource_group_name, resource_name, channel_name, custom_headers:nil)
  delete_async(resource_group_name, resource_name, channel_name, custom_headers:custom_headers).value!
end

#get(resource_group_name, resource_name, channel_name, custom_headers: nil) ⇒ BotChannel

Returns a BotService Channel registration specified by the parameters.

user subscription. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the Bot resource group in the

  • resource_name (String) —

    The name of the Bot resource.

  • channel_name (String) —

    The name of the Bot resource.

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

    A hash of custom headers that

Returns:

  • (BotChannel) —

    operation results.



441
442
443
444
 
# File 'lib/2018-07-12-preview/generated/azure_mgmt_bot_service/channels.rb', line 441

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

#get_async(resource_group_name, resource_name, channel_name, custom_headers: nil) ⇒ Concurrent::Promise

Returns a BotService Channel registration specified by the parameters.

user subscription. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the Bot resource group in the

  • resource_name (String) —

    The name of the Bot resource.

  • channel_name (String) —

    The name of the Bot resource.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
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
 
# File 'lib/2018-07-12-preview/generated/azure_mgmt_bot_service/channels.rb', line 474

def get_async(resource_group_name, resource_name, channel_name, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MaxLength': '64'" if !resource_group_name.nil? && resource_group_name.length > 64
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MinLength': '2'" if !resource_group_name.nil? && resource_group_name.length < 2
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'Pattern': '^[a-zA-Z0-9][a-zA-Z0-9_.-]*$'" if !resource_group_name.nil? && resource_group_name.match(Regexp.new('^^[a-zA-Z0-9][a-zA-Z0-9_.-]*$$')).nil?
  fail ArgumentError, 'resource_name is nil' if resource_name.nil?
  fail ArgumentError, "'resource_name' should satisfy the constraint - 'MaxLength': '64'" if !resource_name.nil? && resource_name.length > 64
  fail ArgumentError, "'resource_name' should satisfy the constraint - 'MinLength': '2'" if !resource_name.nil? && resource_name.length < 2
  fail ArgumentError, "'resource_name' should satisfy the constraint - 'Pattern': '^[a-zA-Z0-9][a-zA-Z0-9_.-]*$'" if !resource_name.nil? && resource_name.match(Regexp.new('^^[a-zA-Z0-9][a-zA-Z0-9_.-]*$$')).nil?
  fail ArgumentError, 'channel_name is nil' if channel_name.nil?
  fail ArgumentError, "'channel_name' should satisfy the constraint - 'MaxLength': '64'" if !channel_name.nil? && channel_name.length > 64
  fail ArgumentError, "'channel_name' should satisfy the constraint - 'MinLength': '2'" if !channel_name.nil? && channel_name.length < 2
  fail ArgumentError, "'channel_name' should satisfy the constraint - 'Pattern': '^[a-zA-Z0-9][a-zA-Z0-9_.-]*$'" if !channel_name.nil? && channel_name.match(Regexp.new('^^[a-zA-Z0-9][a-zA-Z0-9_.-]*$$')).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.BotService/botServices/{resourceName}/channels/{channelName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'resourceName' => resource_name,'channelName' => channel_name,'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::BotService::Mgmt::V2018_07_12_preview::Models::BotChannel.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_with_http_info(resource_group_name, resource_name, channel_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Returns a BotService Channel registration specified by the parameters.

user subscription. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the Bot resource group in the

  • resource_name (String) —

    The name of the Bot resource.

  • channel_name (String) —

    The name of the Bot resource.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



458
459
460
 
# File 'lib/2018-07-12-preview/generated/azure_mgmt_bot_service/channels.rb', line 458

def get_with_http_info(resource_group_name, resource_name, channel_name, custom_headers:nil)
  get_async(resource_group_name, resource_name, channel_name, custom_headers:custom_headers).value!
end

#list_by_resource_group(resource_group_name, resource_name, custom_headers: nil) ⇒ Array<BotChannel>

Returns all the Channel registrations of a particular BotService resource

user subscription. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the Bot resource group in the

  • resource_name (String) —

    The name of the Bot resource.

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

    A hash of custom headers that

Returns:

  • (Array<BotChannel>) —

    operation results.



666
667
668
669
 
# File 'lib/2018-07-12-preview/generated/azure_mgmt_bot_service/channels.rb', line 666

def list_by_resource_group(resource_group_name, resource_name, custom_headers:nil)
  first_page = list_by_resource_group_as_lazy(resource_group_name, resource_name, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_by_resource_group_as_lazy(resource_group_name, resource_name, custom_headers: nil) ⇒ ChannelResponseList

Returns all the Channel registrations of a particular BotService resource

user subscription. will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    The name of the Bot resource group in the

  • resource_name (String) —

    The name of the Bot resource.

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

    A hash of custom headers that

Returns:

  • (ChannelResponseList) —

    which provide lazy access to pages of the



860
861
862
863
864
865
866
867
868
869
 
# File 'lib/2018-07-12-preview/generated/azure_mgmt_bot_service/channels.rb', line 860

def list_by_resource_group_as_lazy(resource_group_name, resource_name, custom_headers:nil)
  response = list_by_resource_group_async(resource_group_name, resource_name, custom_headers:custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_by_resource_group_next_async(next_page_link, custom_headers:custom_headers)
    end
    page
  end
end

#list_by_resource_group_async(resource_group_name, resource_name, custom_headers: nil) ⇒ Concurrent::Promise

Returns all the Channel registrations of a particular BotService resource

user subscription. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the Bot resource group in the

  • resource_name (String) —

    The name of the Bot resource.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
 
# File 'lib/2018-07-12-preview/generated/azure_mgmt_bot_service/channels.rb', line 697

def list_by_resource_group_async(resource_group_name, resource_name, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MaxLength': '64'" if !resource_group_name.nil? && resource_group_name.length > 64
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MinLength': '2'" if !resource_group_name.nil? && resource_group_name.length < 2
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'Pattern': '^[a-zA-Z0-9][a-zA-Z0-9_.-]*$'" if !resource_group_name.nil? && resource_group_name.match(Regexp.new('^^[a-zA-Z0-9][a-zA-Z0-9_.-]*$$')).nil?
  fail ArgumentError, 'resource_name is nil' if resource_name.nil?
  fail ArgumentError, "'resource_name' should satisfy the constraint - 'MaxLength': '64'" if !resource_name.nil? && resource_name.length > 64
  fail ArgumentError, "'resource_name' should satisfy the constraint - 'MinLength': '2'" if !resource_name.nil? && resource_name.length < 2
  fail ArgumentError, "'resource_name' should satisfy the constraint - 'Pattern': '^[a-zA-Z0-9][a-zA-Z0-9_.-]*$'" if !resource_name.nil? && resource_name.match(Regexp.new('^^[a-zA-Z0-9][a-zA-Z0-9_.-]*$$')).nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.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.BotService/botServices/{resourceName}/channels'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'resourceName' => resource_name,'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::BotService::Mgmt::V2018_07_12_preview::Models::ChannelResponseList.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_resource_group_next(next_page_link, custom_headers: nil) ⇒ ChannelResponseList

Returns all the Channel registrations of a particular BotService resource

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:

  • (ChannelResponseList) —

    operation results.



768
769
770
771
 
# File 'lib/2018-07-12-preview/generated/azure_mgmt_bot_service/channels.rb', line 768

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

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

Returns all the Channel registrations of a particular BotService resource

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.



797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
 
# File 'lib/2018-07-12-preview/generated/azure_mgmt_bot_service/channels.rb', line 797

def list_by_resource_group_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::BotService::Mgmt::V2018_07_12_preview::Models::ChannelResponseList.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_resource_group_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Returns all the Channel registrations of a particular BotService resource

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.



783
784
785
 
# File 'lib/2018-07-12-preview/generated/azure_mgmt_bot_service/channels.rb', line 783

def list_by_resource_group_next_with_http_info(next_page_link, custom_headers:nil)
  list_by_resource_group_next_async(next_page_link, custom_headers:custom_headers).value!
end

#list_by_resource_group_with_http_info(resource_group_name, resource_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Returns all the Channel registrations of a particular BotService resource

user subscription. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the Bot resource group in the

  • resource_name (String) —

    The name of the Bot resource.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



682
683
684
 
# File 'lib/2018-07-12-preview/generated/azure_mgmt_bot_service/channels.rb', line 682

def list_by_resource_group_with_http_info(resource_group_name, resource_name, custom_headers:nil)
  list_by_resource_group_async(resource_group_name, resource_name, custom_headers:custom_headers).value!
end

#list_with_keys(resource_group_name, resource_name, channel_name, custom_headers: nil) ⇒ BotChannel

Lists a Channel registration for a Bot Service including secrets

user subscription. values include: ‘FacebookChannel’, ‘EmailChannel’, ‘KikChannel’, ‘TelegramChannel’, ‘SlackChannel’, ‘MsTeamsChannel’, ‘SkypeChannel’, ‘WebChatChannel’, ‘DirectLineChannel’, ‘SmsChannel’ will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the Bot resource group in the

  • resource_name (String) —

    The name of the Bot resource.

  • channel_name (ChannelName) —

    The name of the Channel resource. Possible

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

    A hash of custom headers that

Returns:

  • (BotChannel) —

    operation results.



554
555
556
557
 
# File 'lib/2018-07-12-preview/generated/azure_mgmt_bot_service/channels.rb', line 554

def list_with_keys(resource_group_name, resource_name, channel_name, custom_headers:nil)
  response = list_with_keys_async(resource_group_name, resource_name, channel_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#list_with_keys_async(resource_group_name, resource_name, channel_name, custom_headers: nil) ⇒ Concurrent::Promise

Lists a Channel registration for a Bot Service including secrets

user subscription. values include: ‘FacebookChannel’, ‘EmailChannel’, ‘KikChannel’, ‘TelegramChannel’, ‘SlackChannel’, ‘MsTeamsChannel’, ‘SkypeChannel’, ‘WebChatChannel’, ‘DirectLineChannel’, ‘SmsChannel’ to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the Bot resource group in the

  • resource_name (String) —

    The name of the Bot resource.

  • channel_name (ChannelName) —

    The name of the Channel resource. Possible

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
 
# File 'lib/2018-07-12-preview/generated/azure_mgmt_bot_service/channels.rb', line 593

def list_with_keys_async(resource_group_name, resource_name, channel_name, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MaxLength': '64'" if !resource_group_name.nil? && resource_group_name.length > 64
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MinLength': '2'" if !resource_group_name.nil? && resource_group_name.length < 2
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'Pattern': '^[a-zA-Z0-9][a-zA-Z0-9_.-]*$'" if !resource_group_name.nil? && resource_group_name.match(Regexp.new('^^[a-zA-Z0-9][a-zA-Z0-9_.-]*$$')).nil?
  fail ArgumentError, 'resource_name is nil' if resource_name.nil?
  fail ArgumentError, "'resource_name' should satisfy the constraint - 'MaxLength': '64'" if !resource_name.nil? && resource_name.length > 64
  fail ArgumentError, "'resource_name' should satisfy the constraint - 'MinLength': '2'" if !resource_name.nil? && resource_name.length < 2
  fail ArgumentError, "'resource_name' should satisfy the constraint - 'Pattern': '^[a-zA-Z0-9][a-zA-Z0-9_.-]*$'" if !resource_name.nil? && resource_name.match(Regexp.new('^^[a-zA-Z0-9][a-zA-Z0-9_.-]*$$')).nil?
  fail ArgumentError, 'channel_name is nil' if channel_name.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.BotService/botServices/{resourceName}/channels/{channelName}/listChannelWithKeys'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'resourceName' => resource_name,'channelName' => channel_name,'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(:post, 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::BotService::Mgmt::V2018_07_12_preview::Models::BotChannel.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_with_keys_with_http_info(resource_group_name, resource_name, channel_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists a Channel registration for a Bot Service including secrets

user subscription. values include: ‘FacebookChannel’, ‘EmailChannel’, ‘KikChannel’, ‘TelegramChannel’, ‘SlackChannel’, ‘MsTeamsChannel’, ‘SkypeChannel’, ‘WebChatChannel’, ‘DirectLineChannel’, ‘SmsChannel’ will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the Bot resource group in the

  • resource_name (String) —

    The name of the Bot resource.

  • channel_name (ChannelName) —

    The name of the Channel resource. Possible

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



574
575
576
 
# File 'lib/2018-07-12-preview/generated/azure_mgmt_bot_service/channels.rb', line 574

def list_with_keys_with_http_info(resource_group_name, resource_name, channel_name, custom_headers:nil)
  list_with_keys_async(resource_group_name, resource_name, channel_name, custom_headers:custom_headers).value!
end

#update(resource_group_name, resource_name, channel_name, location: nil, tags: nil, sku: nil, kind: nil, etag: nil, properties: nil, custom_headers: nil) ⇒ BotChannel

Updates a Channel registration for a Bot Service

user subscription. values include: ‘FacebookChannel’, ‘EmailChannel’, ‘KikChannel’, ‘TelegramChannel’, ‘SlackChannel’, ‘MsTeamsChannel’, ‘SkypeChannel’, ‘WebChatChannel’, ‘DirectLineChannel’, ‘SmsChannel’ key/value pairs. values include: ‘sdk’, ‘designer’, ‘bot’, ‘function’ resource will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the Bot resource group in the

  • resource_name (String) —

    The name of the Bot resource.

  • channel_name (ChannelName) —

    The name of the Channel resource. Possible

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

    Specifies the location of the resource.

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

    Contains resource tags defined as

  • sku (Sku) (defaults to: nil) —

    Gets or sets the SKU of the resource.

  • kind (Kind) (defaults to: nil) —

    Required. Gets or sets the Kind of the resource. Possible

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

    Entity Tag

  • properties (Channel) (defaults to: nil) —

    The set of properties specific to bot channel

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

    A hash of custom headers that

Returns:

  • (BotChannel) —

    operation results.



185
186
187
188
 
# File 'lib/2018-07-12-preview/generated/azure_mgmt_bot_service/channels.rb', line 185

def update(resource_group_name, resource_name, channel_name, location:nil, tags:nil, sku:nil, kind:nil, etag:nil, properties:nil, custom_headers:nil)
  response = update_async(resource_group_name, resource_name, channel_name, location:location, tags:tags, sku:sku, kind:kind, etag:etag, properties:properties, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#update_async(resource_group_name, resource_name, channel_name, location: nil, tags: nil, sku: nil, kind: nil, etag: nil, properties: nil, custom_headers: nil) ⇒ Concurrent::Promise

Updates a Channel registration for a Bot Service

user subscription. values include: ‘FacebookChannel’, ‘EmailChannel’, ‘KikChannel’, ‘TelegramChannel’, ‘SlackChannel’, ‘MsTeamsChannel’, ‘SkypeChannel’, ‘WebChatChannel’, ‘DirectLineChannel’, ‘SmsChannel’ key/value pairs. values include: ‘sdk’, ‘designer’, ‘bot’, ‘function’ resource to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the Bot resource group in the

  • resource_name (String) —

    The name of the Bot resource.

  • channel_name (ChannelName) —

    The name of the Channel resource. Possible

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

    Specifies the location of the resource.

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

    Contains resource tags defined as

  • sku (Sku) (defaults to: nil) —

    Gets or sets the SKU of the resource.

  • kind (Kind) (defaults to: nil) —

    Required. Gets or sets the Kind of the resource. Possible

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

    Entity Tag

  • properties (Channel) (defaults to: nil) —

    The set of properties specific to bot channel

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



242
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
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/2018-07-12-preview/generated/azure_mgmt_bot_service/channels.rb', line 242

def update_async(resource_group_name, resource_name, channel_name, location:nil, tags:nil, sku:nil, kind:nil, etag:nil, properties:nil, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MaxLength': '64'" if !resource_group_name.nil? && resource_group_name.length > 64
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MinLength': '2'" if !resource_group_name.nil? && resource_group_name.length < 2
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'Pattern': '^[a-zA-Z0-9][a-zA-Z0-9_.-]*$'" if !resource_group_name.nil? && resource_group_name.match(Regexp.new('^^[a-zA-Z0-9][a-zA-Z0-9_.-]*$$')).nil?
  fail ArgumentError, 'resource_name is nil' if resource_name.nil?
  fail ArgumentError, "'resource_name' should satisfy the constraint - 'MaxLength': '64'" if !resource_name.nil? && resource_name.length > 64
  fail ArgumentError, "'resource_name' should satisfy the constraint - 'MinLength': '2'" if !resource_name.nil? && resource_name.length < 2
  fail ArgumentError, "'resource_name' should satisfy the constraint - 'Pattern': '^[a-zA-Z0-9][a-zA-Z0-9_.-]*$'" if !resource_name.nil? && resource_name.match(Regexp.new('^^[a-zA-Z0-9][a-zA-Z0-9_.-]*$$')).nil?
  fail ArgumentError, 'channel_name is nil' if channel_name.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?

  parameters = Azure::BotService::Mgmt::V2018_07_12_preview::Models::BotChannel.new
  unless location.nil? && tags.nil? && sku.nil? && kind.nil? && etag.nil? && properties.nil?
    parameters.location = location
    parameters.tags = tags
    parameters.sku = sku
    parameters.kind = kind
    parameters.etag = etag
    parameters.properties = properties
  end

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

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

  # Serialize Request
  request_mapper = Azure::BotService::Mgmt::V2018_07_12_preview::Models::BotChannel.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.BotService/botServices/{resourceName}/channels/{channelName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'resourceName' => resource_name,'channelName' => channel_name,'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 == 200 || status_code == 201
      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::BotService::Mgmt::V2018_07_12_preview::Models::BotChannel.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 == 201
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::BotService::Mgmt::V2018_07_12_preview::Models::BotChannel.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

#update_with_http_info(resource_group_name, resource_name, channel_name, location: nil, tags: nil, sku: nil, kind: nil, etag: nil, properties: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Updates a Channel registration for a Bot Service

user subscription. values include: ‘FacebookChannel’, ‘EmailChannel’, ‘KikChannel’, ‘TelegramChannel’, ‘SlackChannel’, ‘MsTeamsChannel’, ‘SkypeChannel’, ‘WebChatChannel’, ‘DirectLineChannel’, ‘SmsChannel’ key/value pairs. values include: ‘sdk’, ‘designer’, ‘bot’, ‘function’ resource will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the Bot resource group in the

  • resource_name (String) —

    The name of the Bot resource.

  • channel_name (ChannelName) —

    The name of the Channel resource. Possible

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

    Specifies the location of the resource.

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

    Contains resource tags defined as

  • sku (Sku) (defaults to: nil) —

    Gets or sets the SKU of the resource.

  • kind (Kind) (defaults to: nil) —

    Required. Gets or sets the Kind of the resource. Possible

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

    Entity Tag

  • properties (Channel) (defaults to: nil) —

    The set of properties specific to bot channel

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



214
215
216
 
# File 'lib/2018-07-12-preview/generated/azure_mgmt_bot_service/channels.rb', line 214

def update_with_http_info(resource_group_name, resource_name, channel_name, location:nil, tags:nil, sku:nil, kind:nil, etag:nil, properties:nil, custom_headers:nil)
  update_async(resource_group_name, resource_name, channel_name, location:location, tags:tags, sku:sku, kind:kind, etag:etag, properties:properties, custom_headers:custom_headers).value!
end