Class: Azure::SQL::Mgmt::V2015_05_01_preview::SubscriptionUsages

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2015-05-01-preview/generated/azure_mgmt_sql/subscription_usages.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) ⇒ SubscriptionUsages

Creates and initializes a new instance of the SubscriptionUsages class.

Parameters:

  • client —

    service class for accessing basic functionality.



20
21
22
 
# File 'lib/2015-05-01-preview/generated/azure_mgmt_sql/subscription_usages.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/subscription_usages.rb', line 25

def client
  @client
end

Instance Method Details

#get(location_name, usage_name, custom_headers: nil) ⇒ SubscriptionUsage

Gets a subscription usage metric.

located. will be added to the HTTP request.

Parameters:

  • location_name (String) —

    The name of the region where the resource is

  • usage_name (String) —

    Name of usage metric to return.

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

    A hash of custom headers that

Returns:

  • (SubscriptionUsage) —

    operation results.



131
132
133
134
 
# File 'lib/2015-05-01-preview/generated/azure_mgmt_sql/subscription_usages.rb', line 131

def get(location_name, usage_name, custom_headers:nil)
  response = get_async(location_name, usage_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_async(location_name, usage_name, custom_headers: nil) ⇒ Concurrent::Promise

Gets a subscription usage metric.

located. to the HTTP request.

Parameters:

  • location_name (String) —

    The name of the region where the resource is

  • usage_name (String) —

    Name of usage metric to return.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
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
 
# File 'lib/2015-05-01-preview/generated/azure_mgmt_sql/subscription_usages.rb', line 162

def get_async(location_name, usage_name, custom_headers:nil)
  fail ArgumentError, 'location_name is nil' if location_name.nil?
  fail ArgumentError, 'usage_name is nil' if usage_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}/providers/Microsoft.Sql/locations/{locationName}/usages/{usageName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'locationName' => location_name,'usageName' => usage_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::SubscriptionUsage.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(location_name, usage_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets a subscription usage metric.

located. will be added to the HTTP request.

Parameters:

  • location_name (String) —

    The name of the region where the resource is

  • usage_name (String) —

    Name of usage metric to return.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



147
148
149
 
# File 'lib/2015-05-01-preview/generated/azure_mgmt_sql/subscription_usages.rb', line 147

def get_with_http_info(location_name, usage_name, custom_headers:nil)
  get_async(location_name, usage_name, custom_headers:custom_headers).value!
end

#list_by_location(location_name, custom_headers: nil) ⇒ Array<SubscriptionUsage>

Gets all subscription usage metrics in a given location.

located. will be added to the HTTP request.

Parameters:

  • location_name (String) —

    The name of the region where the resource is

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

    A hash of custom headers that

Returns:

  • (Array<SubscriptionUsage>) —

    operation results.



37
38
39
40
 
# File 'lib/2015-05-01-preview/generated/azure_mgmt_sql/subscription_usages.rb', line 37

def list_by_location(location_name, custom_headers:nil)
  first_page = list_by_location_as_lazy(location_name, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_by_location_as_lazy(location_name, custom_headers: nil) ⇒ SubscriptionUsageListResult

Gets all subscription usage metrics in a given location.

located. will be added to the HTTP request.

the response.

Parameters:

  • location_name (String) —

    The name of the region where the resource is

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

    A hash of custom headers that

Returns:

  • (SubscriptionUsageListResult) —

    which provide lazy access to pages of



318
319
320
321
322
323
324
325
326
327
 
# File 'lib/2015-05-01-preview/generated/azure_mgmt_sql/subscription_usages.rb', line 318

def list_by_location_as_lazy(location_name, custom_headers:nil)
  response = list_by_location_async(location_name, custom_headers:custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_by_location_next_async(next_page_link, custom_headers:custom_headers)
    end
    page
  end
end

#list_by_location_async(location_name, custom_headers: nil) ⇒ Concurrent::Promise

Gets all subscription usage metrics in a given location.

located. to the HTTP request.

Parameters:

  • location_name (String) —

    The name of the region where the resource is

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



66
67
68
69
70
71
72
73
74
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
 
# File 'lib/2015-05-01-preview/generated/azure_mgmt_sql/subscription_usages.rb', line 66

def list_by_location_async(location_name, custom_headers:nil)
  fail ArgumentError, 'location_name is nil' if location_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}/providers/Microsoft.Sql/locations/{locationName}/usages'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'locationName' => location_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::SubscriptionUsageListResult.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_location_next(next_page_link, custom_headers: nil) ⇒ SubscriptionUsageListResult

Gets all subscription usage metrics in a given location.

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:

  • (SubscriptionUsageListResult) —

    operation results.



227
228
229
230
 
# File 'lib/2015-05-01-preview/generated/azure_mgmt_sql/subscription_usages.rb', line 227

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

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

Gets all subscription usage metrics in a given location.

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.



256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/2015-05-01-preview/generated/azure_mgmt_sql/subscription_usages.rb', line 256

def list_by_location_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::SQL::Mgmt::V2015_05_01_preview::Models::SubscriptionUsageListResult.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_location_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets all subscription usage metrics in a given location.

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.



242
243
244
 
# File 'lib/2015-05-01-preview/generated/azure_mgmt_sql/subscription_usages.rb', line 242

def list_by_location_next_with_http_info(next_page_link, custom_headers:nil)
  list_by_location_next_async(next_page_link, custom_headers:custom_headers).value!
end

#list_by_location_with_http_info(location_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets all subscription usage metrics in a given location.

located. will be added to the HTTP request.

Parameters:

  • location_name (String) —

    The name of the region where the resource is

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



52
53
54
 
# File 'lib/2015-05-01-preview/generated/azure_mgmt_sql/subscription_usages.rb', line 52

def list_by_location_with_http_info(location_name, custom_headers:nil)
  list_by_location_async(location_name, custom_headers:custom_headers).value!
end