class Azure::BotService::Mgmt::V2017_12_01_preview::Channels

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

Attributes

client[R]

@return [AzureBotService] reference to the AzureBotService

Public Class Methods

new(client) click to toggle source

Creates and initializes a new instance of the Channels class. @param client service class for accessing basic functionality.

# File lib/2017-12-01-preview/generated/azure_mgmt_bot_service/channels.rb, line 17
def initialize(client)
  @client = client
end

Public Instance Methods

create(resource_group_name, resource_name, channel_name, parameters, custom_headers:nil) click to toggle source

Creates a Channel registration for a Bot Service

@param resource_group_name [String] The name of the Bot resource group in the user subscription. @param resource_name [String] The name of the Bot resource. @param channel_name [ChannelName] The name of the Channel resource. Possible values include: 'FacebookChannel', 'EmailChannel', 'KikChannel', 'TelegramChannel', 'SlackChannel', 'MsTeamsChannel', 'SkypeChannel', 'WebChatChannel', 'DirectLineChannel', 'SmsChannel' @param parameters [BotChannel] The parameters to provide for the created bot. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [BotChannel] operation results.

# File lib/2017-12-01-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) click to toggle source

Creates a Channel registration for a Bot Service

@param resource_group_name [String] The name of the Bot resource group in the user subscription. @param resource_name [String] The name of the Bot resource. @param channel_name [ChannelName] The name of the Channel resource. Possible values include: 'FacebookChannel', 'EmailChannel', 'KikChannel', 'TelegramChannel', 'SlackChannel', 'MsTeamsChannel', 'SkypeChannel', 'WebChatChannel', 'DirectLineChannel', 'SmsChannel' @param parameters [BotChannel] The parameters to provide for the created bot. @param [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [Concurrent::Promise] Promise object which holds the HTTP response.

# File lib/2017-12-01-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::V2017_12_01_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::V2017_12_01_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::V2017_12_01_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) click to toggle source

Creates a Channel registration for a Bot Service

@param resource_group_name [String] The name of the Bot resource group in the user subscription. @param resource_name [String] The name of the Bot resource. @param channel_name [ChannelName] The name of the Channel resource. Possible values include: 'FacebookChannel', 'EmailChannel', 'KikChannel', 'TelegramChannel', 'SlackChannel', 'MsTeamsChannel', 'SkypeChannel', 'WebChatChannel', 'DirectLineChannel', 'SmsChannel' @param parameters [BotChannel] The parameters to provide for the created bot. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [MsRestAzure::AzureOperationResponse] HTTP response information.

# File lib/2017-12-01-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) click to toggle source

Deletes a Channel registration from a Bot Service

@param resource_group_name [String] The name of the Bot resource group in the user subscription. @param resource_name [String] The name of the Bot resource. @param channel_name [String] The name of the Bot resource. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

# File lib/2017-12-01-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) click to toggle source

Deletes a Channel registration from a Bot Service

@param resource_group_name [String] The name of the Bot resource group in the user subscription. @param resource_name [String] The name of the Bot resource. @param channel_name [String] The name of the Bot resource. @param [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [Concurrent::Promise] Promise object which holds the HTTP response.

# File lib/2017-12-01-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) click to toggle source

Deletes a Channel registration from a Bot Service

@param resource_group_name [String] The name of the Bot resource group in the user subscription. @param resource_name [String] The name of the Bot resource. @param channel_name [String] The name of the Bot resource. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [MsRestAzure::AzureOperationResponse] HTTP response information.

# File lib/2017-12-01-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) click to toggle source

Returns a BotService Channel registration specified by the parameters.

@param resource_group_name [String] The name of the Bot resource group in the user subscription. @param resource_name [String] The name of the Bot resource. @param channel_name [String] The name of the Bot resource. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [BotChannel] operation results.

# File lib/2017-12-01-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) click to toggle source

Returns a BotService Channel registration specified by the parameters.

@param resource_group_name [String] The name of the Bot resource group in the user subscription. @param resource_name [String] The name of the Bot resource. @param channel_name [String] The name of the Bot resource. @param [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [Concurrent::Promise] Promise object which holds the HTTP response.

# File lib/2017-12-01-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::V2017_12_01_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) click to toggle source

Returns a BotService Channel registration specified by the parameters.

@param resource_group_name [String] The name of the Bot resource group in the user subscription. @param resource_name [String] The name of the Bot resource. @param channel_name [String] The name of the Bot resource. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [MsRestAzure::AzureOperationResponse] HTTP response information.

# File lib/2017-12-01-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) click to toggle source

Returns all the Channel registrations of a particular BotService resource

@param resource_group_name [String] The name of the Bot resource group in the user subscription. @param resource_name [String] The name of the Bot resource. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [Array<BotChannel>] operation results.

# File lib/2017-12-01-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) click to toggle source

Returns all the Channel registrations of a particular BotService resource

@param resource_group_name [String] The name of the Bot resource group in the user subscription. @param resource_name [String] The name of the Bot resource. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [ChannelResponseList] which provide lazy access to pages of the response.

# File lib/2017-12-01-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) click to toggle source

Returns all the Channel registrations of a particular BotService resource

@param resource_group_name [String] The name of the Bot resource group in the user subscription. @param resource_name [String] The name of the Bot resource. @param [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [Concurrent::Promise] Promise object which holds the HTTP response.

# File lib/2017-12-01-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::V2017_12_01_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) click to toggle source

Returns all the Channel registrations of a particular BotService resource

@param next_page_link [String] The NextLink from the previous successful call to List operation. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [ChannelResponseList] operation results.

# File lib/2017-12-01-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) click to toggle source

Returns all the Channel registrations of a particular BotService resource

@param next_page_link [String] The NextLink from the previous successful call to List operation. @param [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [Concurrent::Promise] Promise object which holds the HTTP response.

# File lib/2017-12-01-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::V2017_12_01_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) click to toggle source

Returns all the Channel registrations of a particular BotService resource

@param next_page_link [String] The NextLink from the previous successful call to List operation. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [MsRestAzure::AzureOperationResponse] HTTP response information.

# File lib/2017-12-01-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) click to toggle source

Returns all the Channel registrations of a particular BotService resource

@param resource_group_name [String] The name of the Bot resource group in the user subscription. @param resource_name [String] The name of the Bot resource. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [MsRestAzure::AzureOperationResponse] HTTP response information.

# File lib/2017-12-01-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) click to toggle source

Lists a Channel registration for a Bot Service including secrets

@param resource_group_name [String] The name of the Bot resource group in the user subscription. @param resource_name [String] The name of the Bot resource. @param channel_name [ChannelName] The name of the Channel resource. Possible values include: 'FacebookChannel', 'EmailChannel', 'KikChannel', 'TelegramChannel', 'SlackChannel', 'MsTeamsChannel', 'SkypeChannel', 'WebChatChannel', 'DirectLineChannel', 'SmsChannel' @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [BotChannel] operation results.

# File lib/2017-12-01-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) click to toggle source

Lists a Channel registration for a Bot Service including secrets

@param resource_group_name [String] The name of the Bot resource group in the user subscription. @param resource_name [String] The name of the Bot resource. @param channel_name [ChannelName] The name of the Channel resource. Possible values include: 'FacebookChannel', 'EmailChannel', 'KikChannel', 'TelegramChannel', 'SlackChannel', 'MsTeamsChannel', 'SkypeChannel', 'WebChatChannel', 'DirectLineChannel', 'SmsChannel' @param [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [Concurrent::Promise] Promise object which holds the HTTP response.

# File lib/2017-12-01-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::V2017_12_01_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) click to toggle source

Lists a Channel registration for a Bot Service including secrets

@param resource_group_name [String] The name of the Bot resource group in the user subscription. @param resource_name [String] The name of the Bot resource. @param channel_name [ChannelName] The name of the Channel resource. Possible values include: 'FacebookChannel', 'EmailChannel', 'KikChannel', 'TelegramChannel', 'SlackChannel', 'MsTeamsChannel', 'SkypeChannel', 'WebChatChannel', 'DirectLineChannel', 'SmsChannel' @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [MsRestAzure::AzureOperationResponse] HTTP response information.

# File lib/2017-12-01-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) click to toggle source

Updates a Channel registration for a Bot Service

@param resource_group_name [String] The name of the Bot resource group in the user subscription. @param resource_name [String] The name of the Bot resource. @param channel_name [ChannelName] The name of the Channel resource. Possible values include: 'FacebookChannel', 'EmailChannel', 'KikChannel', 'TelegramChannel', 'SlackChannel', 'MsTeamsChannel', 'SkypeChannel', 'WebChatChannel', 'DirectLineChannel', 'SmsChannel' @param location [String] Specifies the location of the resource. @param tags [Hash{String => String}] Contains resource tags defined as key/value pairs. @param sku [Sku] Gets or sets the SKU of the resource. @param kind [Kind] Required. Gets or sets the Kind of the resource. Possible values include: 'sdk', 'designer', 'bot', 'function' @param etag [String] Entity Tag @param properties [Channel] The set of properties specific to bot channel resource @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [BotChannel] operation results.

# File lib/2017-12-01-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) click to toggle source

Updates a Channel registration for a Bot Service

@param resource_group_name [String] The name of the Bot resource group in the user subscription. @param resource_name [String] The name of the Bot resource. @param channel_name [ChannelName] The name of the Channel resource. Possible values include: 'FacebookChannel', 'EmailChannel', 'KikChannel', 'TelegramChannel', 'SlackChannel', 'MsTeamsChannel', 'SkypeChannel', 'WebChatChannel', 'DirectLineChannel', 'SmsChannel' @param location [String] Specifies the location of the resource. @param tags [Hash{String => String}] Contains resource tags defined as key/value pairs. @param sku [Sku] Gets or sets the SKU of the resource. @param kind [Kind] Required. Gets or sets the Kind of the resource. Possible values include: 'sdk', 'designer', 'bot', 'function' @param etag [String] Entity Tag @param properties [Channel] The set of properties specific to bot channel resource @param [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [Concurrent::Promise] Promise object which holds the HTTP response.

# File lib/2017-12-01-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::V2017_12_01_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::V2017_12_01_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::V2017_12_01_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::V2017_12_01_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) click to toggle source

Updates a Channel registration for a Bot Service

@param resource_group_name [String] The name of the Bot resource group in the user subscription. @param resource_name [String] The name of the Bot resource. @param channel_name [ChannelName] The name of the Channel resource. Possible values include: 'FacebookChannel', 'EmailChannel', 'KikChannel', 'TelegramChannel', 'SlackChannel', 'MsTeamsChannel', 'SkypeChannel', 'WebChatChannel', 'DirectLineChannel', 'SmsChannel' @param location [String] Specifies the location of the resource. @param tags [Hash{String => String}] Contains resource tags defined as key/value pairs. @param sku [Sku] Gets or sets the SKU of the resource. @param kind [Kind] Required. Gets or sets the Kind of the resource. Possible values include: 'sdk', 'designer', 'bot', 'function' @param etag [String] Entity Tag @param properties [Channel] The set of properties specific to bot channel resource @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [MsRestAzure::AzureOperationResponse] HTTP response information.

# File lib/2017-12-01-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