Class: Azure::Subscriptions::Mgmt::V2015_11_01::Subscriptions

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2015-11-01/generated/azure_mgmt_subscriptions/subscriptions.rb

Overview

Subscriptions

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Subscriptions

Creates and initializes a new instance of the Subscriptions class.

Parameters:

  • client —

    service class for accessing basic functionality.



17
18
19
 
# File 'lib/2015-11-01/generated/azure_mgmt_subscriptions/subscriptions.rb', line 17

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ SubscriptionClient (readonly)

Returns reference to the SubscriptionClient.

Returns:



22
23
24
 
# File 'lib/2015-11-01/generated/azure_mgmt_subscriptions/subscriptions.rb', line 22

def client
  @client
end

Instance Method Details

#get(subscription_id, custom_headers = nil) ⇒ Subscription

Gets details about particular subscription.

will be added to the HTTP request.

Parameters:

  • subscription_id (String) —

    Id of the subscription.

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

    A hash of custom headers that

Returns:

  • (Subscription) —

    operation results.



119
120
121
122
 
# File 'lib/2015-11-01/generated/azure_mgmt_subscriptions/subscriptions.rb', line 119

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

#get_async(subscription_id, custom_headers = nil) ⇒ Concurrent::Promise

Gets details about particular subscription.

to the HTTP request.

Parameters:

  • subscription_id (String) —

    Id of the subscription.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
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
 
# File 'lib/2015-11-01/generated/azure_mgmt_subscriptions/subscriptions.rb', line 146

def get_async(subscription_id, custom_headers = nil)
  fail ArgumentError, 'subscription_id is nil' if subscription_id.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?


  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?
  path_template = 'subscriptions/{subscriptionId}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => 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?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Subscriptions::Mgmt::V2015_11_01::Models::Subscription.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(subscription_id, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Gets details about particular subscription.

will be added to the HTTP request.

Parameters:

  • subscription_id (String) —

    Id of the subscription.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



133
134
135
 
# File 'lib/2015-11-01/generated/azure_mgmt_subscriptions/subscriptions.rb', line 133

def get_with_http_info(subscription_id, custom_headers = nil)
  get_async(subscription_id, custom_headers).value!
end

#list(custom_headers = nil) ⇒ Array<Subscription>

Gets a list of the subscriptionIds.

will be added to the HTTP request.

Parameters:

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

    A hash of custom headers that

Returns:

  • (Array<Subscription>) —

    operation results.



204
205
206
207
 
# File 'lib/2015-11-01/generated/azure_mgmt_subscriptions/subscriptions.rb', line 204

def list(custom_headers = nil)
  first_page = list_as_lazy(custom_headers)
  first_page.get_all_items
end

#list_as_lazy(custom_headers = nil) ⇒ SubscriptionListResult

Gets a list of the subscriptionIds.

will be added to the HTTP request.

response.

Parameters:

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

    A hash of custom headers that

Returns:

  • (SubscriptionListResult) —

    which provide lazy access to pages of the



373
374
375
376
377
378
379
380
381
382
 
# File 'lib/2015-11-01/generated/azure_mgmt_subscriptions/subscriptions.rb', line 373

def list_as_lazy(custom_headers = nil)
  response = list_async(custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_next_async(next_page_link, custom_headers)
    end
    page
  end
end

#list_async(custom_headers = nil) ⇒ Concurrent::Promise

Gets a list of the subscriptionIds.

to the HTTP request.

Parameters:

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/2015-11-01/generated/azure_mgmt_subscriptions/subscriptions.rb', line 229

def list_async(custom_headers = nil)
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?


  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?
  path_template = 'subscriptions'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      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?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Subscriptions::Mgmt::V2015_11_01::Models::SubscriptionListResult.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_locations(subscription_id, custom_headers = nil) ⇒ LocationListResult

Gets a list of the subscription locations.

will be added to the HTTP request.

Parameters:

  • subscription_id (String) —

    Id of the subscription

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

    A hash of custom headers that

Returns:

  • (LocationListResult) —

    operation results.



33
34
35
36
 
# File 'lib/2015-11-01/generated/azure_mgmt_subscriptions/subscriptions.rb', line 33

def list_locations(subscription_id, custom_headers = nil)
  response = list_locations_async(subscription_id, custom_headers).value!
  response.body unless response.nil?
end

#list_locations_async(subscription_id, custom_headers = nil) ⇒ Concurrent::Promise

Gets a list of the subscription locations.

to the HTTP request.

Parameters:

  • subscription_id (String) —

    Id of the subscription

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



60
61
62
63
64
65
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
 
# File 'lib/2015-11-01/generated/azure_mgmt_subscriptions/subscriptions.rb', line 60

def list_locations_async(subscription_id, custom_headers = nil)
  fail ArgumentError, 'subscription_id is nil' if subscription_id.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?


  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?
  path_template = 'subscriptions/{subscriptionId}/locations'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => 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?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Subscriptions::Mgmt::V2015_11_01::Models::LocationListResult.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_locations_with_http_info(subscription_id, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Gets a list of the subscription locations.

will be added to the HTTP request.

Parameters:

  • subscription_id (String) —

    Id of the subscription

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



47
48
49
 
# File 'lib/2015-11-01/generated/azure_mgmt_subscriptions/subscriptions.rb', line 47

def list_locations_with_http_info(subscription_id, custom_headers = nil)
  list_locations_async(subscription_id, custom_headers).value!
end

#list_next(next_page_link, custom_headers = nil) ⇒ SubscriptionListResult

Gets a list of the subscriptionIds.

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:

  • (SubscriptionListResult) —

    operation results.



287
288
289
290
 
# File 'lib/2015-11-01/generated/azure_mgmt_subscriptions/subscriptions.rb', line 287

def list_next(next_page_link, custom_headers = nil)
  response = list_next_async(next_page_link, custom_headers).value!
  response.body unless response.nil?
end

#list_next_async(next_page_link, custom_headers = nil) ⇒ Concurrent::Promise

Gets a list of the subscriptionIds.

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.



316
317
318
319
320
321
322
323
324
325
326
327
328
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
 
# File 'lib/2015-11-01/generated/azure_mgmt_subscriptions/subscriptions.rb', line 316

def list_next_async(next_page_link, custom_headers = nil)
  fail ArgumentError, 'next_page_link is nil' if next_page_link.nil?


  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?
  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?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Subscriptions::Mgmt::V2015_11_01::Models::SubscriptionListResult.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_next_with_http_info(next_page_link, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Gets a list of the subscriptionIds.

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.



302
303
304
 
# File 'lib/2015-11-01/generated/azure_mgmt_subscriptions/subscriptions.rb', line 302

def list_next_with_http_info(next_page_link, custom_headers = nil)
  list_next_async(next_page_link, custom_headers).value!
end

#list_with_http_info(custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Gets a list of the subscriptionIds.

will be added to the HTTP request.

Parameters:

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



217
218
219
 
# File 'lib/2015-11-01/generated/azure_mgmt_subscriptions/subscriptions.rb', line 217

def list_with_http_info(custom_headers = nil)
  list_async(custom_headers).value!
end