Class: Azure::ARM::Search::AdminKeys

Inherits:
Object
  • Object
show all
Includes:
Models, MsRestAzure
Defined in:
lib/generated/azure_mgmt_search/admin_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) ⇒ AdminKeys

Creates and initializes a new instance of the AdminKeys class.

Parameters:

  • client —

    service class for accessing basic functionality.



18
19
20
 
# File 'lib/generated/azure_mgmt_search/admin_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/admin_keys.rb', line 23

def client
  @client
end

Instance Method Details

#get(resource_group_name, search_service_name, search_management_request_options = nil, custom_headers = nil) ⇒ AdminKeyResult

Gets the primary and secondary admin API keys for the specified 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:



41
42
43
44
 
# File 'lib/generated/azure_mgmt_search/admin_keys.rb', line 41

def get(resource_group_name, search_service_name, search_management_request_options = nil, custom_headers = nil)
  response = get_async(resource_group_name, search_service_name, search_management_request_options, custom_headers).value!
  response.body unless response.nil?
end

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

Gets the primary and secondary admin API keys for the specified 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.



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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/generated/azure_mgmt_search/admin_keys.rb', line 82

def get_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}/listAdminKeys'

  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(: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 = AdminKeyResult.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

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

Gets the primary and secondary admin API keys for the specified 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.



62
63
64
 
# File 'lib/generated/azure_mgmt_search/admin_keys.rb', line 62

def get_with_http_info(resource_group_name, search_service_name, search_management_request_options = nil, custom_headers = nil)
  get_async(resource_group_name, search_service_name, search_management_request_options, custom_headers).value!
end

#regenerate(resource_group_name, search_service_name, key_kind, search_management_request_options = nil, custom_headers = nil) ⇒ AdminKeyResult

Regenerates either the primary or secondary admin API key. You can only regenerate one key at a time.

current subscription. You can obtain this value from the Azure Resource Manager API or the portal. associated with the specified resource group. values include ‘primary’ and ‘secondary’. Possible values include: ‘primary’, ‘secondary’ 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_kind (AdminKeyKind) —

    Specifies which key to regenerate. Valid

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

    A hash of custom headers that

Returns:



158
159
160
161
 
# File 'lib/generated/azure_mgmt_search/admin_keys.rb', line 158

def regenerate(resource_group_name, search_service_name, key_kind, search_management_request_options = nil, custom_headers = nil)
  response = regenerate_async(resource_group_name, search_service_name, key_kind, search_management_request_options, custom_headers).value!
  response.body unless response.nil?
end

#regenerate_async(resource_group_name, search_service_name, key_kind, search_management_request_options = nil, custom_headers = nil) ⇒ Concurrent::Promise

Regenerates either the primary or secondary admin API key. You can only regenerate one key at a time.

current subscription. You can obtain this value from the Azure Resource Manager API or the portal. associated with the specified resource group. values include ‘primary’ and ‘secondary’. Possible values include: ‘primary’, ‘secondary’ 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_kind (AdminKeyKind) —

    Specifies which key to regenerate. Valid

  • 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.



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
253
254
255
256
257
258
259
260
261
 
# File 'lib/generated/azure_mgmt_search/admin_keys.rb', line 205

def regenerate_async(resource_group_name, search_service_name, key_kind, 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_kind is nil' if key_kind.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}/regenerateAdminKey/{keyKind}'

  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,'keyKind' => key_kind,'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 = AdminKeyResult.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

#regenerate_with_http_info(resource_group_name, search_service_name, key_kind, search_management_request_options = nil, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Regenerates either the primary or secondary admin API key. You can only regenerate one key at a time.

current subscription. You can obtain this value from the Azure Resource Manager API or the portal. associated with the specified resource group. values include ‘primary’ and ‘secondary’. Possible values include: ‘primary’, ‘secondary’ 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_kind (AdminKeyKind) —

    Specifies which key to regenerate. Valid

  • 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.



182
183
184
 
# File 'lib/generated/azure_mgmt_search/admin_keys.rb', line 182

def regenerate_with_http_info(resource_group_name, search_service_name, key_kind, search_management_request_options = nil, custom_headers = nil)
  regenerate_async(resource_group_name, search_service_name, key_kind, search_management_request_options, custom_headers).value!
end