Class: Azure::Mysql::Mgmt::V2018_06_01::RecommendedActions

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2018-06-01/generated/azure_mgmt_mysql/recommended_actions.rb

Overview

The Microsoft Azure management API provides create, read, update, and delete functionality for Azure MySQL resources including servers, databases, firewall rules, VNET rules, security alert policies, log files and configurations with new business model.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ RecommendedActions

Creates and initializes a new instance of the RecommendedActions class.

Parameters:

  • client —

    service class for accessing basic functionality.



20
21
22
 
# File 'lib/2018-06-01/generated/azure_mgmt_mysql/recommended_actions.rb', line 20

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ MySQLManagementClient (readonly)

Returns reference to the MySQLManagementClient.

Returns:



25
26
27
 
# File 'lib/2018-06-01/generated/azure_mgmt_mysql/recommended_actions.rb', line 25

def client
  @client
end

Instance Method Details

#get(resource_group_name, server_name, advisor_name, recommended_action_name, custom_headers: nil) ⇒ RecommendationAction

Retrieve recommended actions from the advisor.

is case insensitive. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group. The name

  • server_name (String) —

    The name of the server.

  • advisor_name (String) —

    The advisor name for recommendation action.

  • recommended_action_name (String) —

    The recommended action name.

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

    A hash of custom headers that

Returns:

  • (RecommendationAction) —

    operation results.



40
41
42
43
 
# File 'lib/2018-06-01/generated/azure_mgmt_mysql/recommended_actions.rb', line 40

def get(resource_group_name, server_name, advisor_name, recommended_action_name, custom_headers:nil)
  response = get_async(resource_group_name, server_name, advisor_name, recommended_action_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_async(resource_group_name, server_name, advisor_name, recommended_action_name, custom_headers: nil) ⇒ Concurrent::Promise

Retrieve recommended actions from the advisor.

is case insensitive. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group. The name

  • server_name (String) —

    The name of the server.

  • advisor_name (String) —

    The advisor name for recommendation action.

  • recommended_action_name (String) —

    The recommended action name.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/2018-06-01/generated/azure_mgmt_mysql/recommended_actions.rb', line 75

def get_async(resource_group_name, server_name, advisor_name, recommended_action_name, custom_headers:nil)
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, "'@client.api_version' should satisfy the constraint - 'MinLength': '1'" if !@client.api_version.nil? && @client.api_version.length < 1
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, "'@client.subscription_id' should satisfy the constraint - 'MinLength': '1'" if !@client.subscription_id.nil? && @client.subscription_id.length < 1
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MaxLength': '90'" if !resource_group_name.nil? && resource_group_name.length > 90
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MinLength': '1'" if !resource_group_name.nil? && resource_group_name.length < 1
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'Pattern': '^[-\w\._\(\)]+$'" if !resource_group_name.nil? && resource_group_name.match(Regexp.new('^^[-\w\._\(\)]+$$')).nil?
  fail ArgumentError, 'server_name is nil' if server_name.nil?
  fail ArgumentError, 'advisor_name is nil' if advisor_name.nil?
  fail ArgumentError, 'recommended_action_name is nil' if recommended_action_name.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.DBforMySQL/servers/{serverName}/advisors/{advisorName}/recommendedActions/{recommendedActionName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'serverName' => server_name,'advisorName' => advisor_name,'recommendedActionName' => recommended_action_name},
      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?
    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::Mysql::Mgmt::V2018_06_01::Models::RecommendationAction.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, server_name, advisor_name, recommended_action_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Retrieve recommended actions from the advisor.

is case insensitive. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group. The name

  • server_name (String) —

    The name of the server.

  • advisor_name (String) —

    The advisor name for recommendation action.

  • recommended_action_name (String) —

    The recommended action name.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



58
59
60
 
# File 'lib/2018-06-01/generated/azure_mgmt_mysql/recommended_actions.rb', line 58

def get_with_http_info(resource_group_name, server_name, advisor_name, recommended_action_name, custom_headers:nil)
  get_async(resource_group_name, server_name, advisor_name, recommended_action_name, custom_headers:custom_headers).value!
end

#list_by_server(resource_group_name, server_name, advisor_name, session_id: nil, custom_headers: nil) ⇒ Array<RecommendationAction>

Retrieve recommended actions from the advisor.

is case insensitive. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group. The name

  • server_name (String) —

    The name of the server.

  • advisor_name (String) —

    The advisor name for recommendation action.

  • session_id (String) (defaults to: nil) —

    The recommendation action session identifier.

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

    A hash of custom headers that

Returns:

  • (Array<RecommendationAction>) —

    operation results.



150
151
152
153
 
# File 'lib/2018-06-01/generated/azure_mgmt_mysql/recommended_actions.rb', line 150

def list_by_server(resource_group_name, server_name, advisor_name, session_id:nil, custom_headers:nil)
  first_page = list_by_server_as_lazy(resource_group_name, server_name, advisor_name, session_id:session_id, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_by_server_as_lazy(resource_group_name, server_name, advisor_name, session_id: nil, custom_headers: nil) ⇒ RecommendationActionsResultList

Retrieve recommended actions from the advisor.

is case insensitive. will be added to the HTTP request.

of the response.

Parameters:

  • resource_group_name (String) —

    The name of the resource group. The name

  • server_name (String) —

    The name of the server.

  • advisor_name (String) —

    The advisor name for recommendation action.

  • session_id (String) (defaults to: nil) —

    The recommendation action session identifier.

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

    A hash of custom headers that

Returns:

  • (RecommendationActionsResultList) —

    which provide lazy access to pages



350
351
352
353
354
355
356
357
358
359
 
# File 'lib/2018-06-01/generated/azure_mgmt_mysql/recommended_actions.rb', line 350

def list_by_server_as_lazy(resource_group_name, server_name, advisor_name, session_id:nil, custom_headers:nil)
  response = list_by_server_async(resource_group_name, server_name, advisor_name, session_id:session_id, custom_headers:custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_by_server_next_async(next_page_link, custom_headers:custom_headers)
    end
    page
  end
end

#list_by_server_async(resource_group_name, server_name, advisor_name, session_id: nil, custom_headers: nil) ⇒ Concurrent::Promise

Retrieve recommended actions from the advisor.

is case insensitive. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group. The name

  • server_name (String) —

    The name of the server.

  • advisor_name (String) —

    The advisor name for recommendation action.

  • session_id (String) (defaults to: nil) —

    The recommendation action session identifier.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



185
186
187
188
189
190
191
192
193
194
195
196
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
 
# File 'lib/2018-06-01/generated/azure_mgmt_mysql/recommended_actions.rb', line 185

def list_by_server_async(resource_group_name, server_name, advisor_name, session_id:nil, custom_headers:nil)
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, "'@client.api_version' should satisfy the constraint - 'MinLength': '1'" if !@client.api_version.nil? && @client.api_version.length < 1
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, "'@client.subscription_id' should satisfy the constraint - 'MinLength': '1'" if !@client.subscription_id.nil? && @client.subscription_id.length < 1
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MaxLength': '90'" if !resource_group_name.nil? && resource_group_name.length > 90
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MinLength': '1'" if !resource_group_name.nil? && resource_group_name.length < 1
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'Pattern': '^[-\w\._\(\)]+$'" if !resource_group_name.nil? && resource_group_name.match(Regexp.new('^^[-\w\._\(\)]+$$')).nil?
  fail ArgumentError, 'server_name is nil' if server_name.nil?
  fail ArgumentError, 'advisor_name is nil' if advisor_name.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.DBforMySQL/servers/{serverName}/advisors/{advisorName}/recommendedActions'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'serverName' => server_name,'advisorName' => advisor_name},
      query_params: {'api-version' => @client.api_version,'sessionId' => session_id},
      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?
    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::Mysql::Mgmt::V2018_06_01::Models::RecommendationActionsResultList.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_server_next(next_page_link, custom_headers: nil) ⇒ RecommendationActionsResultList

Retrieve recommended actions from the advisor.

to List operation. will be added to the HTTP request.

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful call

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

    A hash of custom headers that

Returns:

  • (RecommendationActionsResultList) —

    operation results.



256
257
258
259
 
# File 'lib/2018-06-01/generated/azure_mgmt_mysql/recommended_actions.rb', line 256

def list_by_server_next(next_page_link, custom_headers:nil)
  response = list_by_server_next_async(next_page_link, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#list_by_server_next_async(next_page_link, custom_headers: nil) ⇒ Concurrent::Promise

Retrieve recommended actions from the advisor.

to List operation. to the HTTP request.

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful call

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/2018-06-01/generated/azure_mgmt_mysql/recommended_actions.rb', line 285

def list_by_server_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 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.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::Mysql::Mgmt::V2018_06_01::Models::RecommendationActionsResultList.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_server_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Retrieve recommended actions from the advisor.

to List operation. will be added to the HTTP request.

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful call

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



271
272
273
 
# File 'lib/2018-06-01/generated/azure_mgmt_mysql/recommended_actions.rb', line 271

def list_by_server_next_with_http_info(next_page_link, custom_headers:nil)
  list_by_server_next_async(next_page_link, custom_headers:custom_headers).value!
end

#list_by_server_with_http_info(resource_group_name, server_name, advisor_name, session_id: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Retrieve recommended actions from the advisor.

is case insensitive. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group. The name

  • server_name (String) —

    The name of the server.

  • advisor_name (String) —

    The advisor name for recommendation action.

  • session_id (String) (defaults to: nil) —

    The recommendation action session identifier.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



168
169
170
 
# File 'lib/2018-06-01/generated/azure_mgmt_mysql/recommended_actions.rb', line 168

def list_by_server_with_http_info(resource_group_name, server_name, advisor_name, session_id:nil, custom_headers:nil)
  list_by_server_async(resource_group_name, server_name, advisor_name, session_id:session_id, custom_headers:custom_headers).value!
end