Class: Azure::ARM::Search::QueryKeys

Inherits:
Object
  • Object
show all
Includes:
Models, MsRestAzure
Defined in:
lib/generated/azure_mgmt_search/query_keys.rb

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ QueryKeys

Creates and initializes a new instance of the QueryKeys class.

Parameters:

  • client —

    service class for accessing basic functionality.



18
19
20
 
# File 'lib/generated/azure_mgmt_search/query_keys.rb', line 18

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ SearchManagementClient (readonly)

Returns reference to the SearchManagementClient.

Returns:



23
24
25
 
# File 'lib/generated/azure_mgmt_search/query_keys.rb', line 23

def client
  @client
end

Instance Method Details

#list(resource_group_name, service_name, custom_headers = nil) ⇒ ListQueryKeysResult

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

the current subscription. list query keys. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group within

  • service_name (String) —

    The name of the Search service for which to

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

    A hash of custom headers that

Returns:



37
38
39
40
 
# File 'lib/generated/azure_mgmt_search/query_keys.rb', line 37

def list(resource_group_name, service_name, custom_headers = nil)
  response = list_async(resource_group_name, service_name, custom_headers).value!
  response.body unless response.nil?
end

#list_async(resource_group_name, service_name, custom_headers = nil) ⇒ Concurrent::Promise

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

the current subscription. list query keys. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group within

  • service_name (String) —

    The name of the Search service for which to

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/generated/azure_mgmt_search/query_keys.rb', line 70

def list_async(resource_group_name, service_name, custom_headers = nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'service_name is nil' if service_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?


  request_headers = {}

  # 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.Search/searchServices/{serviceName}/listQueryKeys'
  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'serviceName' => service_name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {})
  }

  request_url = @base_url || @client.base_url

  request = MsRest::HttpOperationRequest.new(request_url, path_template, :get, options)
  promise = request.run_promise do |req|
    @client.credentials.sign_request(req) unless @client.credentials.nil?
  end

  promise = promise.then do |http_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(request, http_response, error_model)
    end

    # Create Result
    result = MsRestAzure::AzureOperationResponse.new(request, http_response)
    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 = ListQueryKeysResult.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response, 'result.body')
      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_http_info(resource_group_name, service_name, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

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

the current subscription. list query keys. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group within

  • service_name (String) —

    The name of the Search service for which to

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



54
55
56
 
# File 'lib/generated/azure_mgmt_search/query_keys.rb', line 54

def list_with_http_info(resource_group_name, service_name, custom_headers = nil)
  list_async(resource_group_name, service_name, custom_headers).value!
end