Class: Azure::SQL::Mgmt::V2014_04_01::ServiceTierAdvisors

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2014-04-01/generated/azure_mgmt_sql/service_tier_advisors.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) ⇒ ServiceTierAdvisors

Creates and initializes a new instance of the ServiceTierAdvisors class.

Parameters:

  • client —

    service class for accessing basic functionality.



20
21
22
 
# File 'lib/2014-04-01/generated/azure_mgmt_sql/service_tier_advisors.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/2014-04-01/generated/azure_mgmt_sql/service_tier_advisors.rb', line 25

def client
  @client
end

Instance Method Details

#get(resource_group_name, server_name, database_name, service_tier_advisor_name, custom_headers: nil) ⇒ ServiceTierAdvisor

Gets a service tier advisor.

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

  • service_tier_advisor_name (String) —

    The name of service tier advisor.

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

    A hash of custom headers that

Returns:

  • (ServiceTierAdvisor) —

    operation results.



41
42
43
44
 
# File 'lib/2014-04-01/generated/azure_mgmt_sql/service_tier_advisors.rb', line 41

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

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

Gets a service tier advisor.

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

  • service_tier_advisor_name (String) —

    The name of service tier 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
 
# File 'lib/2014-04-01/generated/azure_mgmt_sql/service_tier_advisors.rb', line 78

def get_async(resource_group_name, server_name, database_name, service_tier_advisor_name, custom_headers: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?
  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, 'service_tier_advisor_name is nil' if service_tier_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.Sql/servers/{serverName}/databases/{databaseName}/serviceTierAdvisors/{serviceTierAdvisorName}'

  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,'databaseName' => database_name,'serviceTierAdvisorName' => service_tier_advisor_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::SQL::Mgmt::V2014_04_01::Models::ServiceTierAdvisor.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, service_tier_advisor_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets a service tier advisor.

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

  • service_tier_advisor_name (String) —

    The name of service tier 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/2014-04-01/generated/azure_mgmt_sql/service_tier_advisors.rb', line 60

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

#list_by_database(resource_group_name, server_name, database_name, custom_headers: nil) ⇒ ServiceTierAdvisorListResult

Returns service tier advisors for specified database.

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

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

    A hash of custom headers that

Returns:

  • (ServiceTierAdvisorListResult) —

    operation results.



148
149
150
151
 
# File 'lib/2014-04-01/generated/azure_mgmt_sql/service_tier_advisors.rb', line 148

def list_by_database(resource_group_name, server_name, database_name, custom_headers:nil)
  response = list_by_database_async(resource_group_name, server_name, database_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

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

Returns service tier advisors for specified database.

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

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



183
184
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
 
# File 'lib/2014-04-01/generated/azure_mgmt_sql/service_tier_advisors.rb', line 183

def list_by_database_async(resource_group_name, server_name, database_name, custom_headers: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?
  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?


  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}/serviceTierAdvisors'

  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,'databaseName' => database_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::SQL::Mgmt::V2014_04_01::Models::ServiceTierAdvisorListResult.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_database_with_http_info(resource_group_name, server_name, database_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Returns service tier advisors for specified database.

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

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



166
167
168
 
# File 'lib/2014-04-01/generated/azure_mgmt_sql/service_tier_advisors.rb', line 166

def list_by_database_with_http_info(resource_group_name, server_name, database_name, custom_headers:nil)
  list_by_database_async(resource_group_name, server_name, database_name, custom_headers:custom_headers).value!
end