class Azure::BotService::Mgmt::V2018_07_12_preview::BotConnection

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

Attributes

client[R]

@return [AzureBotService] reference to the AzureBotService

Private Class Methods

new(client) click to toggle source

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

# File lib/2018-07-12-preview/generated/azure_mgmt_bot_service/bot_connection.rb, line 17
def initialize(client)
  @client = client
end

Private Instance Methods

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

Register a new Auth Connection 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 connection_name [String] The name of the Bot Service Connection Setting resource @param parameters [ConnectionSetting] The parameters to provide for creating the Connection Setting. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [ConnectionSetting] operation results.

# File lib/2018-07-12-preview/generated/azure_mgmt_bot_service/bot_connection.rb, line 238
def create(resource_group_name, resource_name, connection_name, parameters, custom_headers:nil)
  response = create_async(resource_group_name, resource_name, connection_name, parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end
create_async(resource_group_name, resource_name, connection_name, parameters, custom_headers:nil) click to toggle source

Register a new Auth Connection 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 connection_name [String] The name of the Bot Service Connection Setting resource @param parameters [ConnectionSetting] The parameters to provide for creating the Connection Setting. @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/2018-07-12-preview/generated/azure_mgmt_bot_service/bot_connection.rb, line 277
def create_async(resource_group_name, resource_name, connection_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, 'connection_name is nil' if connection_name.nil?
  fail ArgumentError, "'connection_name' should satisfy the constraint - 'MaxLength': '64'" if !connection_name.nil? && connection_name.length > 64
  fail ArgumentError, "'connection_name' should satisfy the constraint - 'MinLength': '2'" if !connection_name.nil? && connection_name.length < 2
  fail ArgumentError, "'connection_name' should satisfy the constraint - 'Pattern': '^[a-zA-Z0-9][a-zA-Z0-9_.-]*$'" if !connection_name.nil? && connection_name.match(Regexp.new('^^[a-zA-Z0-9][a-zA-Z0-9_.-]*$$')).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::ConnectionSetting.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}/Connections/{connectionName}'

  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,'connectionName' => connection_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::ConnectionSetting.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::ConnectionSetting.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, connection_name, parameters, custom_headers:nil) click to toggle source

Register a new Auth Connection 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 connection_name [String] The name of the Bot Service Connection Setting resource @param parameters [ConnectionSetting] The parameters to provide for creating the Connection Setting. @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/2018-07-12-preview/generated/azure_mgmt_bot_service/bot_connection.rb, line 258
def create_with_http_info(resource_group_name, resource_name, connection_name, parameters, custom_headers:nil)
  create_async(resource_group_name, resource_name, connection_name, parameters, custom_headers:custom_headers).value!
end
delete(resource_group_name, resource_name, connection_name, custom_headers:nil) click to toggle source

Deletes a Connection Setting 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 connection_name [String] The name of the Bot Service Connection Setting resource @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

# File lib/2018-07-12-preview/generated/azure_mgmt_bot_service/bot_connection.rb, line 622
def delete(resource_group_name, resource_name, connection_name, custom_headers:nil)
  response = delete_async(resource_group_name, resource_name, connection_name, custom_headers:custom_headers).value!
  nil
end
delete_async(resource_group_name, resource_name, connection_name, custom_headers:nil) click to toggle source

Deletes a Connection Setting 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 connection_name [String] The name of the Bot Service Connection Setting 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/2018-07-12-preview/generated/azure_mgmt_bot_service/bot_connection.rb, line 657
def delete_async(resource_group_name, resource_name, connection_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, 'connection_name is nil' if connection_name.nil?
  fail ArgumentError, "'connection_name' should satisfy the constraint - 'MaxLength': '64'" if !connection_name.nil? && connection_name.length > 64
  fail ArgumentError, "'connection_name' should satisfy the constraint - 'MinLength': '2'" if !connection_name.nil? && connection_name.length < 2
  fail ArgumentError, "'connection_name' should satisfy the constraint - 'Pattern': '^[a-zA-Z0-9][a-zA-Z0-9_.-]*$'" if !connection_name.nil? && connection_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}/Connections/{connectionName}'

  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,'connectionName' => connection_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, connection_name, custom_headers:nil) click to toggle source

Deletes a Connection Setting 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 connection_name [String] The name of the Bot Service Connection Setting 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/2018-07-12-preview/generated/azure_mgmt_bot_service/bot_connection.rb, line 640
def delete_with_http_info(resource_group_name, resource_name, connection_name, custom_headers:nil)
  delete_async(resource_group_name, resource_name, connection_name, custom_headers:custom_headers).value!
end
get(resource_group_name, resource_name, connection_name, custom_headers:nil) click to toggle source

Get a Connection Setting 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 connection_name [String] The name of the Bot Service Connection Setting resource @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [ConnectionSetting] operation results.

# File lib/2018-07-12-preview/generated/azure_mgmt_bot_service/bot_connection.rb, line 510
def get(resource_group_name, resource_name, connection_name, custom_headers:nil)
  response = get_async(resource_group_name, resource_name, connection_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end
get_async(resource_group_name, resource_name, connection_name, custom_headers:nil) click to toggle source

Get a Connection Setting 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 connection_name [String] The name of the Bot Service Connection Setting 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/2018-07-12-preview/generated/azure_mgmt_bot_service/bot_connection.rb, line 545
def get_async(resource_group_name, resource_name, connection_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, 'connection_name is nil' if connection_name.nil?
  fail ArgumentError, "'connection_name' should satisfy the constraint - 'MaxLength': '64'" if !connection_name.nil? && connection_name.length > 64
  fail ArgumentError, "'connection_name' should satisfy the constraint - 'MinLength': '2'" if !connection_name.nil? && connection_name.length < 2
  fail ArgumentError, "'connection_name' should satisfy the constraint - 'Pattern': '^[a-zA-Z0-9][a-zA-Z0-9_.-]*$'" if !connection_name.nil? && connection_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}/Connections/{connectionName}'

  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,'connectionName' => connection_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::ConnectionSetting.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, connection_name, custom_headers:nil) click to toggle source

Get a Connection Setting 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 connection_name [String] The name of the Bot Service Connection Setting 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/2018-07-12-preview/generated/azure_mgmt_bot_service/bot_connection.rb, line 528
def get_with_http_info(resource_group_name, resource_name, connection_name, custom_headers:nil)
  get_async(resource_group_name, resource_name, connection_name, custom_headers:custom_headers).value!
end
list_by_bot_service(resource_group_name, resource_name, custom_headers:nil) click to toggle source

Returns all the Connection Settings registered to 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<ConnectionSetting>] operation results.

# File lib/2018-07-12-preview/generated/azure_mgmt_bot_service/bot_connection.rb, line 724
def list_by_bot_service(resource_group_name, resource_name, custom_headers:nil)
  first_page = list_by_bot_service_as_lazy(resource_group_name, resource_name, custom_headers:custom_headers)
  first_page.get_all_items
end
list_by_bot_service_as_lazy(resource_group_name, resource_name, custom_headers:nil) click to toggle source

Returns all the Connection Settings registered to 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 [ConnectionSettingResponseList] which provide lazy access to pages of the response.

# File lib/2018-07-12-preview/generated/azure_mgmt_bot_service/bot_connection.rb, line 924
def list_by_bot_service_as_lazy(resource_group_name, resource_name, custom_headers:nil)
  response = list_by_bot_service_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_bot_service_next_async(next_page_link, custom_headers:custom_headers)
    end
    page
  end
end
list_by_bot_service_async(resource_group_name, resource_name, custom_headers:nil) click to toggle source

Returns all the Connection Settings registered to 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/2018-07-12-preview/generated/azure_mgmt_bot_service/bot_connection.rb, line 757
def list_by_bot_service_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}/connections'

  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::ConnectionSettingResponseList.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_bot_service_next(next_page_link, custom_headers:nil) click to toggle source

Returns all the Connection Settings registered to 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 [ConnectionSettingResponseList] operation results.

# File lib/2018-07-12-preview/generated/azure_mgmt_bot_service/bot_connection.rb, line 829
def list_by_bot_service_next(next_page_link, custom_headers:nil)
  response = list_by_bot_service_next_async(next_page_link, custom_headers:custom_headers).value!
  response.body unless response.nil?
end
list_by_bot_service_next_async(next_page_link, custom_headers:nil) click to toggle source

Returns all the Connection Settings registered to 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/2018-07-12-preview/generated/azure_mgmt_bot_service/bot_connection.rb, line 860
def list_by_bot_service_next_async(next_page_link, custom_headers:nil)
  fail ArgumentError, 'next_page_link is nil' if next_page_link.nil?


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

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

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      skip_encoding_path_params: {'nextLink' => next_page_link},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:get, path_template, options)

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

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::BotService::Mgmt::V2018_07_12_preview::Models::ConnectionSettingResponseList.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_bot_service_next_with_http_info(next_page_link, custom_headers:nil) click to toggle source

Returns all the Connection Settings registered to 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/2018-07-12-preview/generated/azure_mgmt_bot_service/bot_connection.rb, line 845
def list_by_bot_service_next_with_http_info(next_page_link, custom_headers:nil)
  list_by_bot_service_next_async(next_page_link, custom_headers:custom_headers).value!
end
list_by_bot_service_with_http_info(resource_group_name, resource_name, custom_headers:nil) click to toggle source

Returns all the Connection Settings registered to 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/2018-07-12-preview/generated/azure_mgmt_bot_service/bot_connection.rb, line 741
def list_by_bot_service_with_http_info(resource_group_name, resource_name, custom_headers:nil)
  list_by_bot_service_async(resource_group_name, resource_name, custom_headers:custom_headers).value!
end
list_service_providers(custom_headers:nil) click to toggle source

Lists the available Service Providers for creating Connection Settings

@param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [ServiceProviderResponseList] operation results.

# File lib/2018-07-12-preview/generated/azure_mgmt_bot_service/bot_connection.rb, line 32
def list_service_providers(custom_headers:nil)
  response = list_service_providers_async(custom_headers:custom_headers).value!
  response.body unless response.nil?
end
list_service_providers_async(custom_headers:nil) click to toggle source

Lists the available Service Providers for creating Connection Settings

@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/2018-07-12-preview/generated/azure_mgmt_bot_service/bot_connection.rb, line 57
def list_service_providers_async(custom_headers: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}/providers/Microsoft.BotService/listAuthServiceProviders'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'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::ServiceProviderResponseList.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_service_providers_with_http_info(custom_headers:nil) click to toggle source

Lists the available Service Providers for creating Connection Settings

@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/2018-07-12-preview/generated/azure_mgmt_bot_service/bot_connection.rb, line 45
def list_service_providers_with_http_info(custom_headers:nil)
  list_service_providers_async(custom_headers:custom_headers).value!
end
list_with_secrets(resource_group_name, resource_name, connection_name, custom_headers:nil) click to toggle source

Get a Connection Setting 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 connection_name [String] The name of the Bot Service Connection Setting resource @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [ConnectionSetting] operation results.

# File lib/2018-07-12-preview/generated/azure_mgmt_bot_service/bot_connection.rb, line 123
def list_with_secrets(resource_group_name, resource_name, connection_name, custom_headers:nil)
  response = list_with_secrets_async(resource_group_name, resource_name, connection_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end
list_with_secrets_async(resource_group_name, resource_name, connection_name, custom_headers:nil) click to toggle source

Get a Connection Setting 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 connection_name [String] The name of the Bot Service Connection Setting 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/2018-07-12-preview/generated/azure_mgmt_bot_service/bot_connection.rb, line 158
def list_with_secrets_async(resource_group_name, resource_name, connection_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, 'connection_name is nil' if connection_name.nil?
  fail ArgumentError, "'connection_name' should satisfy the constraint - 'MaxLength': '64'" if !connection_name.nil? && connection_name.length > 64
  fail ArgumentError, "'connection_name' should satisfy the constraint - 'MinLength': '2'" if !connection_name.nil? && connection_name.length < 2
  fail ArgumentError, "'connection_name' should satisfy the constraint - 'Pattern': '^[a-zA-Z0-9][a-zA-Z0-9_.-]*$'" if !connection_name.nil? && connection_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}/Connections/{connectionName}/listWithSecrets'

  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,'connectionName' => connection_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::ConnectionSetting.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_secrets_with_http_info(resource_group_name, resource_name, connection_name, custom_headers:nil) click to toggle source

Get a Connection Setting 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 connection_name [String] The name of the Bot Service Connection Setting 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/2018-07-12-preview/generated/azure_mgmt_bot_service/bot_connection.rb, line 141
def list_with_secrets_with_http_info(resource_group_name, resource_name, connection_name, custom_headers:nil)
  list_with_secrets_async(resource_group_name, resource_name, connection_name, custom_headers:custom_headers).value!
end
update(resource_group_name, resource_name, connection_name, parameters, custom_headers:nil) click to toggle source

Updates a Connection Setting 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 connection_name [String] The name of the Bot Service Connection Setting resource @param parameters [ConnectionSetting] The parameters to provide for updating the Connection Setting. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [ConnectionSetting] operation results.

# File lib/2018-07-12-preview/generated/azure_mgmt_bot_service/bot_connection.rb, line 375
def update(resource_group_name, resource_name, connection_name, parameters, custom_headers:nil)
  response = update_async(resource_group_name, resource_name, connection_name, parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end
update_async(resource_group_name, resource_name, connection_name, parameters, custom_headers:nil) click to toggle source

Updates a Connection Setting 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 connection_name [String] The name of the Bot Service Connection Setting resource @param parameters [ConnectionSetting] The parameters to provide for updating the Connection Setting. @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/2018-07-12-preview/generated/azure_mgmt_bot_service/bot_connection.rb, line 414
def update_async(resource_group_name, resource_name, connection_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, 'connection_name is nil' if connection_name.nil?
  fail ArgumentError, "'connection_name' should satisfy the constraint - 'MaxLength': '64'" if !connection_name.nil? && connection_name.length > 64
  fail ArgumentError, "'connection_name' should satisfy the constraint - 'MinLength': '2'" if !connection_name.nil? && connection_name.length < 2
  fail ArgumentError, "'connection_name' should satisfy the constraint - 'Pattern': '^[a-zA-Z0-9][a-zA-Z0-9_.-]*$'" if !connection_name.nil? && connection_name.match(Regexp.new('^^[a-zA-Z0-9][a-zA-Z0-9_.-]*$$')).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::ConnectionSetting.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}/Connections/{connectionName}'

  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,'connectionName' => connection_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::ConnectionSetting.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::ConnectionSetting.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, connection_name, parameters, custom_headers:nil) click to toggle source

Updates a Connection Setting 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 connection_name [String] The name of the Bot Service Connection Setting resource @param parameters [ConnectionSetting] The parameters to provide for updating the Connection Setting. @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/2018-07-12-preview/generated/azure_mgmt_bot_service/bot_connection.rb, line 395
def update_with_http_info(resource_group_name, resource_name, connection_name, parameters, custom_headers:nil)
  update_async(resource_group_name, resource_name, connection_name, parameters, custom_headers:custom_headers).value!
end