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

#create(resource_group_name, search_service_name, name, search_management_request_options = nil, custom_headers = nil) ⇒ QueryKey

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

current subscription. You can obtain this value from the Azure Resource Manager API or the portal. associated with the specified resource group. Additional parameters for the operation will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group within the

  • search_service_name (String) —

    The name of the Azure Search service

  • name (String) —

    The name of the new query API key.

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

    A hash of custom headers that

Returns:



42
43
44
45
 
# File 'lib/generated/azure_mgmt_search/query_keys.rb', line 42

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, 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) ⇒ Concurrent::Promise

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

current subscription. You can obtain this value from the Azure Resource Manager API or the portal. associated with the specified resource group. Additional parameters for the operation to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group within the

  • search_service_name (String) —

    The name of the Azure Search service

  • name (String) —

    The name of the new query API key.

  • search_management_request_options (SearchManagementRequestOptions) (defaults to: nil)
  • A (Hash{String => String}) —

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/generated/azure_mgmt_search/query_keys.rb', line 85

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 = {}

  # 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 = QueryKey.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

#create_with_http_info(resource_group_name, search_service_name, name, search_management_request_options = nil, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

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

current subscription. You can obtain this value from the Azure Resource Manager API or the portal. associated with the specified resource group. Additional parameters for the operation will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group within the

  • search_service_name (String) —

    The name of the Azure Search service

  • name (String) —

    The name of the new query API key.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



64
65
66
 
# File 'lib/generated/azure_mgmt_search/query_keys.rb', line 64

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, custom_headers).value!
end

#delete(resource_group_name, search_service_name, key, search_management_request_options = nil, custom_headers = nil) ⇒ Object

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.

current subscription. You can obtain this value from the Azure Resource Manager API or the portal. associated with the specified resource group. value, not by name. Additional parameters for the operation will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group within the

  • search_service_name (String) —

    The name of the Azure Search service

  • key (String) —

    The query key to be deleted. Query keys are identified by

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

    A hash of custom headers that



272
273
274
275
 
# File 'lib/generated/azure_mgmt_search/query_keys.rb', line 272

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, custom_headers).value!
  nil
end

#delete_async(resource_group_name, search_service_name, key, search_management_request_options = nil, custom_headers = nil) ⇒ Concurrent::Promise

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.

current subscription. You can obtain this value from the Azure Resource Manager API or the portal. associated with the specified resource group. value, not by name. Additional parameters for the operation to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group within the

  • search_service_name (String) —

    The name of the Azure Search service

  • key (String) —

    The query key to be deleted. Query keys are identified by

  • search_management_request_options (SearchManagementRequestOptions) (defaults to: nil)
  • A (Hash{String => String}) —

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
 
# File 'lib/generated/azure_mgmt_search/query_keys.rb', line 319

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 = {}

  # 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) ⇒ MsRestAzure::AzureOperationResponse

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.

current subscription. You can obtain this value from the Azure Resource Manager API or the portal. associated with the specified resource group. value, not by name. Additional parameters for the operation will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group within the

  • search_service_name (String) —

    The name of the Azure Search service

  • key (String) —

    The query key to be deleted. Query keys are identified by

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



296
297
298
 
# File 'lib/generated/azure_mgmt_search/query_keys.rb', line 296

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, custom_headers).value!
end

#list_by_search_service(resource_group_name, search_service_name, search_management_request_options = nil, custom_headers = nil) ⇒ ListQueryKeysResult

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

current subscription. You can obtain this value from the Azure Resource Manager API or the portal. associated with the specified resource group. Additional parameters for the operation will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group within the

  • search_service_name (String) —

    The name of the Azure Search service

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

    A hash of custom headers that

Returns:

  • (ListQueryKeysResult) —

    operation results.



158
159
160
161
 
# File 'lib/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, 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) ⇒ Concurrent::Promise

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

current subscription. You can obtain this value from the Azure Resource Manager API or the portal. associated with the specified resource group. Additional parameters for the operation to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group within the

  • search_service_name (String) —

    The name of the Azure Search service

  • search_management_request_options (SearchManagementRequestOptions) (defaults to: nil)
  • A (Hash{String => String}) —

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/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 = {}

  # 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 = 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_by_search_service_with_http_info(resource_group_name, search_service_name, search_management_request_options = nil, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

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

current subscription. You can obtain this value from the Azure Resource Manager API or the portal. associated with the specified resource group. Additional parameters for the operation will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group within the

  • search_service_name (String) —

    The name of the Azure Search service

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



178
179
180
 
# File 'lib/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, custom_headers).value!
end