class Azure::Search::Mgmt::V2015_08_19::QueryKeys

Client that can be used to manage Azure Search services and API keys.

Attributes

client[R]

@return [SearchManagementClient] reference to the SearchManagementClient

Private Class Methods

new(client) click to toggle source

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

# File lib/2015-08-19/generated/azure_mgmt_search/query_keys.rb, line 17
def initialize(client)
  @client = client
end

Private Instance Methods

create(resource_group_name, search_service_name, name, search_management_request_options:nil, custom_headers:nil) click to toggle source

Generates a new query key for the specified Search service. You can create up to 50 query keys per service.

@param resource_group_name [String] The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal. @param search_service_name [String] The name of the Azure Search service associated with the specified resource group. @param name [String] The name of the new query API key. @param search_management_request_options [SearchManagementRequestOptions] Additional parameters for the operation @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [QueryKey] operation results.

# File lib/2015-08-19/generated/azure_mgmt_search/query_keys.rb, line 41
def create(resource_group_name, search_service_name, name, search_management_request_options:nil, custom_headers:nil)
  response = create_async(resource_group_name, search_service_name, name, search_management_request_options:search_management_request_options, custom_headers:custom_headers).value!
  response.body unless response.nil?
end
create_async(resource_group_name, search_service_name, name, search_management_request_options:nil, custom_headers:nil) click to toggle source

Generates a new query key for the specified Search service. You can create up to 50 query keys per service.

@param resource_group_name [String] The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal. @param search_service_name [String] The name of the Azure Search service associated with the specified resource group. @param name [String] The name of the new query API key. @param search_management_request_options [SearchManagementRequestOptions] Additional parameters for the 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/2015-08-19/generated/azure_mgmt_search/query_keys.rb, line 84
def create_async(resource_group_name, search_service_name, name, search_management_request_options:nil, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'search_service_name is nil' if search_service_name.nil?
  fail ArgumentError, 'name is nil' if 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?

  client_request_id = nil
  unless search_management_request_options.nil?
    client_request_id = search_management_request_options.clientRequestId
  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?
  request_headers['x-ms-client-request-id'] = client_request_id.to_s unless client_request_id.to_s.nil?
  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/createQueryKey/{name}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'searchServiceName' => search_service_name,'name' => 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 MsRestAzure::AzureOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Search::Mgmt::V2015_08_19::Models::QueryKey.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, search_service_name, name, search_management_request_options:nil, custom_headers:nil) click to toggle source

Generates a new query key for the specified Search service. You can create up to 50 query keys per service.

@param resource_group_name [String] The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal. @param search_service_name [String] The name of the Azure Search service associated with the specified resource group. @param name [String] The name of the new query API key. @param search_management_request_options [SearchManagementRequestOptions] Additional parameters for the 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/2015-08-19/generated/azure_mgmt_search/query_keys.rb, line 63
def create_with_http_info(resource_group_name, search_service_name, name, search_management_request_options:nil, custom_headers:nil)
  create_async(resource_group_name, search_service_name, name, search_management_request_options:search_management_request_options, custom_headers:custom_headers).value!
end
delete(resource_group_name, search_service_name, key, search_management_request_options:nil, custom_headers:nil) click to toggle source

Deletes the specified query key. Unlike admin keys, query keys are not regenerated. The process for regenerating a query key is to delete and then recreate it.

@param resource_group_name [String] The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal. @param search_service_name [String] The name of the Azure Search service associated with the specified resource group. @param key [String] The query key to be deleted. Query keys are identified by value, not by name. @param search_management_request_options [SearchManagementRequestOptions] Additional parameters for the operation @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

# File lib/2015-08-19/generated/azure_mgmt_search/query_keys.rb, line 273
def delete(resource_group_name, search_service_name, key, search_management_request_options:nil, custom_headers:nil)
  response = delete_async(resource_group_name, search_service_name, key, search_management_request_options:search_management_request_options, custom_headers:custom_headers).value!
  nil
end
delete_async(resource_group_name, search_service_name, key, search_management_request_options:nil, custom_headers:nil) click to toggle source

Deletes the specified query key. Unlike admin keys, query keys are not regenerated. The process for regenerating a query key is to delete and then recreate it.

@param resource_group_name [String] The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal. @param search_service_name [String] The name of the Azure Search service associated with the specified resource group. @param key [String] The query key to be deleted. Query keys are identified by value, not by name. @param search_management_request_options [SearchManagementRequestOptions] Additional parameters for the 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/2015-08-19/generated/azure_mgmt_search/query_keys.rb, line 320
def delete_async(resource_group_name, search_service_name, key, search_management_request_options:nil, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'search_service_name is nil' if search_service_name.nil?
  fail ArgumentError, 'key is nil' if key.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?

  client_request_id = nil
  unless search_management_request_options.nil?
    client_request_id = search_management_request_options.clientRequestId
  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?
  request_headers['x-ms-client-request-id'] = client_request_id.to_s unless client_request_id.to_s.nil?
  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/deleteQueryKey/{key}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'searchServiceName' => search_service_name,'key' => key,'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 || status_code == 404
      error_model = JSON.load(response_content)
      fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?

    result
  end

  promise.execute
end
delete_with_http_info(resource_group_name, search_service_name, key, search_management_request_options:nil, custom_headers:nil) click to toggle source

Deletes the specified query key. Unlike admin keys, query keys are not regenerated. The process for regenerating a query key is to delete and then recreate it.

@param resource_group_name [String] The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal. @param search_service_name [String] The name of the Azure Search service associated with the specified resource group. @param key [String] The query key to be deleted. Query keys are identified by value, not by name. @param search_management_request_options [SearchManagementRequestOptions] Additional parameters for the 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/2015-08-19/generated/azure_mgmt_search/query_keys.rb, line 297
def delete_with_http_info(resource_group_name, search_service_name, key, search_management_request_options:nil, custom_headers:nil)
  delete_async(resource_group_name, search_service_name, key, search_management_request_options:search_management_request_options, custom_headers:custom_headers).value!
end
list_by_search_service(resource_group_name, search_service_name, search_management_request_options:nil, custom_headers:nil) click to toggle source

Returns the list of query API keys for the given Azure Search service.

@param resource_group_name [String] The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal. @param search_service_name [String] The name of the Azure Search service associated with the specified resource group. @param search_management_request_options [SearchManagementRequestOptions] Additional parameters for the operation @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [ListQueryKeysResult] operation results.

# File lib/2015-08-19/generated/azure_mgmt_search/query_keys.rb, line 158
def list_by_search_service(resource_group_name, search_service_name, search_management_request_options:nil, custom_headers:nil)
  response = list_by_search_service_async(resource_group_name, search_service_name, search_management_request_options:search_management_request_options, custom_headers:custom_headers).value!
  response.body unless response.nil?
end
list_by_search_service_async(resource_group_name, search_service_name, search_management_request_options:nil, custom_headers:nil) click to toggle source

Returns the list of query API keys for the given Azure Search service.

@param resource_group_name [String] The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal. @param search_service_name [String] The name of the Azure Search service associated with the specified resource group. @param search_management_request_options [SearchManagementRequestOptions] Additional parameters for the 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/2015-08-19/generated/azure_mgmt_search/query_keys.rb, line 197
def list_by_search_service_async(resource_group_name, search_service_name, search_management_request_options:nil, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'search_service_name is nil' if search_service_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?

  client_request_id = nil
  unless search_management_request_options.nil?
    client_request_id = search_management_request_options.clientRequestId
  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?
  request_headers['x-ms-client-request-id'] = client_request_id.to_s unless client_request_id.to_s.nil?
  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/listQueryKeys'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'searchServiceName' => search_service_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 MsRestAzure::AzureOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Search::Mgmt::V2015_08_19::Models::ListQueryKeysResult.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_search_service_with_http_info(resource_group_name, search_service_name, search_management_request_options:nil, custom_headers:nil) click to toggle source

Returns the list of query API keys for the given Azure Search service.

@param resource_group_name [String] The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal. @param search_service_name [String] The name of the Azure Search service associated with the specified resource group. @param search_management_request_options [SearchManagementRequestOptions] Additional parameters for the 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/2015-08-19/generated/azure_mgmt_search/query_keys.rb, line 178
def list_by_search_service_with_http_info(resource_group_name, search_service_name, search_management_request_options:nil, custom_headers:nil)
  list_by_search_service_async(resource_group_name, search_service_name, search_management_request_options:search_management_request_options, custom_headers:custom_headers).value!
end