Class: Azure::SQL::Mgmt::V2015_05_01_preview::DatabaseRecommendedActions

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2015-05-01-preview/generated/azure_mgmt_sql/database_recommended_actions.rb

Overview

The Azure SQL Database management API provides a RESTful set of web services that interact with Azure SQL Database services to manage your databases. The API enables you to create, retrieve, update, and delete databases.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ DatabaseRecommendedActions

Creates and initializes a new instance of the DatabaseRecommendedActions class.

Parameters:

  • client —

    service class for accessing basic functionality.



20
21
22
 
# File 'lib/2015-05-01-preview/generated/azure_mgmt_sql/database_recommended_actions.rb', line 20

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ SqlManagementClient (readonly)

Returns reference to the SqlManagementClient.

Returns:



25
26
27
 
# File 'lib/2015-05-01-preview/generated/azure_mgmt_sql/database_recommended_actions.rb', line 25

def client
  @client
end

Instance Method Details

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

Gets a database recommended action.

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Action. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • server_name (String) —

    The name of the server.

  • database_name (String) —

    The name of the database.

  • advisor_name (String) —

    The name of the Database Advisor.

  • recommended_action_name (String) —

    The name of Database Recommended

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

    A hash of custom headers that

Returns:

  • (RecommendedAction) —

    operation results.



167
168
169
170
 
# File 'lib/2015-05-01-preview/generated/azure_mgmt_sql/database_recommended_actions.rb', line 167

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

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

Gets a database recommended action.

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Action. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • server_name (String) —

    The name of the server.

  • database_name (String) —

    The name of the database.

  • advisor_name (String) —

    The name of the Database Advisor.

  • recommended_action_name (String) —

    The name of Database Recommended

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
262
263
264
 
# File 'lib/2015-05-01-preview/generated/azure_mgmt_sql/database_recommended_actions.rb', line 208

def get_async(resource_group_name, server_name, database_name, advisor_name, recommended_action_name, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'server_name is nil' if server_name.nil?
  fail ArgumentError, 'database_name is nil' if database_name.nil?
  fail ArgumentError, 'advisor_name is nil' if advisor_name.nil?
  fail ArgumentError, 'recommended_action_name is nil' if recommended_action_name.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.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.Sql/servers/{serverName}/databases/{databaseName}/advisors/{advisorName}/recommendedActions/{recommendedActionName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'serverName' => server_name,'databaseName' => database_name,'advisorName' => advisor_name,'recommendedActionName' => recommended_action_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?
    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::SQL::Mgmt::V2015_05_01_preview::Models::RecommendedAction.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, database_name, advisor_name, recommended_action_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets a database recommended action.

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Action. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • server_name (String) —

    The name of the server.

  • database_name (String) —

    The name of the database.

  • advisor_name (String) —

    The name of the Database Advisor.

  • recommended_action_name (String) —

    The name of Database Recommended

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



188
189
190
 
# File 'lib/2015-05-01-preview/generated/azure_mgmt_sql/database_recommended_actions.rb', line 188

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

#list_by_database_advisor(resource_group_name, server_name, database_name, advisor_name, custom_headers: nil) ⇒ Array

Gets list of Database Recommended Actions.

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • server_name (String) —

    The name of the server.

  • database_name (String) —

    The name of the database.

  • advisor_name (String) —

    The name of the Database Advisor.

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

    A hash of custom headers that

Returns:

  • (Array) —

    operation results.



41
42
43
44
 
# File 'lib/2015-05-01-preview/generated/azure_mgmt_sql/database_recommended_actions.rb', line 41

def list_by_database_advisor(resource_group_name, server_name, database_name, advisor_name, custom_headers:nil)
  response = list_by_database_advisor_async(resource_group_name, server_name, database_name, advisor_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#list_by_database_advisor_async(resource_group_name, server_name, database_name, advisor_name, custom_headers: nil) ⇒ Concurrent::Promise

Gets list of Database Recommended Actions.

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • server_name (String) —

    The name of the server.

  • database_name (String) —

    The name of the database.

  • advisor_name (String) —

    The name of the Database Advisor.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/2015-05-01-preview/generated/azure_mgmt_sql/database_recommended_actions.rb', line 78

def list_by_database_advisor_async(resource_group_name, server_name, database_name, advisor_name, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'server_name is nil' if server_name.nil?
  fail ArgumentError, 'database_name is nil' if database_name.nil?
  fail ArgumentError, 'advisor_name is nil' if advisor_name.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.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.Sql/servers/{serverName}/databases/{databaseName}/advisors/{advisorName}/recommendedActions'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'serverName' => server_name,'databaseName' => database_name,'advisorName' => advisor_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?
    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 = {
          client_side_validation: true,
          required: false,
          serialized_name: 'parsed_response',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'RecommendedActionElementType',
                type: {
                  name: 'Composite',
                  class_name: 'RecommendedAction'
                }
            }
          }
        }
        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_database_advisor_with_http_info(resource_group_name, server_name, database_name, advisor_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets list of Database Recommended Actions.

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • server_name (String) —

    The name of the server.

  • database_name (String) —

    The name of the database.

  • advisor_name (String) —

    The name of the Database Advisor.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



60
61
62
 
# File 'lib/2015-05-01-preview/generated/azure_mgmt_sql/database_recommended_actions.rb', line 60

def list_by_database_advisor_with_http_info(resource_group_name, server_name, database_name, advisor_name, custom_headers:nil)
  list_by_database_advisor_async(resource_group_name, server_name, database_name, advisor_name, custom_headers:custom_headers).value!
end

#update(resource_group_name, server_name, database_name, advisor_name, recommended_action_name, parameters, custom_headers: nil) ⇒ RecommendedAction

Updates a database recommended action.

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Action. resource state. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • server_name (String) —

    The name of the server.

  • database_name (String) —

    The name of the database.

  • advisor_name (String) —

    The name of the Database Advisor.

  • recommended_action_name (String) —

    The name of Database Recommended

  • parameters (RecommendedAction) —

    The requested recommended action

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

    A hash of custom headers that

Returns:

  • (RecommendedAction) —

    operation results.



284
285
286
287
 
# File 'lib/2015-05-01-preview/generated/azure_mgmt_sql/database_recommended_actions.rb', line 284

def update(resource_group_name, server_name, database_name, advisor_name, recommended_action_name, parameters, custom_headers:nil)
  response = update_async(resource_group_name, server_name, database_name, advisor_name, recommended_action_name, parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#update_async(resource_group_name, server_name, database_name, advisor_name, recommended_action_name, parameters, custom_headers: nil) ⇒ Concurrent::Promise

Updates a database recommended action.

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Action. resource state. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • server_name (String) —

    The name of the server.

  • database_name (String) —

    The name of the database.

  • advisor_name (String) —

    The name of the Database Advisor.

  • recommended_action_name (String) —

    The name of Database Recommended

  • parameters (RecommendedAction) —

    The requested recommended action

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
 
# File 'lib/2015-05-01-preview/generated/azure_mgmt_sql/database_recommended_actions.rb', line 329

def update_async(resource_group_name, server_name, database_name, advisor_name, recommended_action_name, parameters, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'server_name is nil' if server_name.nil?
  fail ArgumentError, 'database_name is nil' if database_name.nil?
  fail ArgumentError, 'advisor_name is nil' if advisor_name.nil?
  fail ArgumentError, 'recommended_action_name is nil' if recommended_action_name.nil?
  fail ArgumentError, 'parameters is nil' if parameters.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.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?

  # Serialize Request
  request_mapper = Azure::SQL::Mgmt::V2015_05_01_preview::Models::RecommendedAction.mapper()
  request_content = @client.serialize(request_mapper,  parameters)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/advisors/{advisorName}/recommendedActions/{recommendedActionName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'serverName' => server_name,'databaseName' => database_name,'advisorName' => advisor_name,'recommendedActionName' => recommended_action_name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:patch, 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::SQL::Mgmt::V2015_05_01_preview::Models::RecommendedAction.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

#update_with_http_info(resource_group_name, server_name, database_name, advisor_name, recommended_action_name, parameters, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Updates a database recommended action.

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Action. resource state. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • server_name (String) —

    The name of the server.

  • database_name (String) —

    The name of the database.

  • advisor_name (String) —

    The name of the Database Advisor.

  • recommended_action_name (String) —

    The name of Database Recommended

  • parameters (RecommendedAction) —

    The requested recommended action

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



307
308
309
 
# File 'lib/2015-05-01-preview/generated/azure_mgmt_sql/database_recommended_actions.rb', line 307

def update_with_http_info(resource_group_name, server_name, database_name, advisor_name, recommended_action_name, parameters, custom_headers:nil)
  update_async(resource_group_name, server_name, database_name, advisor_name, recommended_action_name, parameters, custom_headers:custom_headers).value!
end