Class: Azure::ARM::Resources::Providers

Inherits:
Object
  • Object
show all
Includes:
Models, MsRestAzure
Defined in:
lib/generated/azure_mgmt_resources/providers.rb

Overview

Provides operations for working with resources and resource groups.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Providers

Creates and initializes a new instance of the Providers class.

Parameters:

  • client —

    service class for accessing basic functionality.



18
19
20
 
# File 'lib/generated/azure_mgmt_resources/providers.rb', line 18

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ ResourceManagementClient (readonly)

Returns reference to the ResourceManagementClient.

Returns:



23
24
25
 
# File 'lib/generated/azure_mgmt_resources/providers.rb', line 23

def client
  @client
end

Instance Method Details

#get(resource_provider_namespace, expand = nil, custom_headers = nil) ⇒ Provider

Gets the specified resource provider.

provider. property aliases in response, use $expand=resourceTypes/aliases. will be added to the HTTP request.

Parameters:

  • resource_provider_namespace (String) —

    The namespace of the resource

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

    The $expand query parameter. For example, to include

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

    A hash of custom headers that

Returns:



318
319
320
321
 
# File 'lib/generated/azure_mgmt_resources/providers.rb', line 318

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

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

Gets the specified resource provider.

provider. property aliases in response, use $expand=resourceTypes/aliases. to the HTTP request.

Parameters:

  • resource_provider_namespace (String) —

    The namespace of the resource

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

    The $expand query parameter. For example, to include

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
394
395
396
397
398
399
400
 
# File 'lib/generated/azure_mgmt_resources/providers.rb', line 351

def get_async(resource_provider_namespace, expand = nil, custom_headers = nil)
  fail ArgumentError, 'resource_provider_namespace is nil' if resource_provider_namespace.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?


  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}/providers/{resourceProviderNamespace}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceProviderNamespace' => resource_provider_namespace,'subscriptionId' => @client.subscription_id},
      query_params: {'$expand' => expand,'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 = Provider.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response, 'result.body')
      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_provider_namespace, expand = nil, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Gets the specified resource provider.

provider. property aliases in response, use $expand=resourceTypes/aliases. will be added to the HTTP request.

Parameters:

  • resource_provider_namespace (String) —

    The namespace of the resource

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

    The $expand query parameter. For example, to include

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



335
336
337
 
# File 'lib/generated/azure_mgmt_resources/providers.rb', line 335

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

#list(top = nil, expand = nil, custom_headers = nil) ⇒ Array<Provider>

Gets all resource providers for a subscription.

returns all deployments. use &$expand=metadata in the query string to retrieve resource provider metadata. To include property aliases in response, use $expand=resourceTypes/aliases. will be added to the HTTP request.

Parameters:

  • top (Integer) (defaults to: nil) —

    The number of results to return. If null is passed

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

    The properties to include in the results. For example,

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

    A hash of custom headers that

Returns:

  • (Array<Provider>) —

    operation results.



219
220
221
222
 
# File 'lib/generated/azure_mgmt_resources/providers.rb', line 219

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

#list_as_lazy(top = nil, expand = nil, custom_headers = nil) ⇒ ProviderListResult

Gets all resource providers for a subscription.

returns all deployments. use &$expand=metadata in the query string to retrieve resource provider metadata. To include property aliases in response, use $expand=resourceTypes/aliases. will be added to the HTTP request.

response.

Parameters:

  • top (Integer) (defaults to: nil) —

    The number of results to return. If null is passed

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

    The properties to include in the results. For example,

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

    A hash of custom headers that

Returns:



504
505
506
507
508
509
510
511
512
513
 
# File 'lib/generated/azure_mgmt_resources/providers.rb', line 504

def list_as_lazy(top = nil, expand = nil, custom_headers = nil)
  response = list_async(top, expand, 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(top = nil, expand = nil, custom_headers = nil) ⇒ Concurrent::Promise

Gets all resource providers for a subscription.

returns all deployments. use &$expand=metadata in the query string to retrieve resource provider metadata. To include property aliases in response, use $expand=resourceTypes/aliases. to the HTTP request.

Parameters:

  • top (Integer) (defaults to: nil) —

    The number of results to return. If null is passed

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

    The properties to include in the results. For example,

  • 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
 
# File 'lib/generated/azure_mgmt_resources/providers.rb', line 256

def list_async(top = nil, expand = nil, 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?


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

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id},
      query_params: {'$top' => top,'$expand' => expand,'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 = ProviderListResult.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response, 'result.body')
      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(next_page_link, custom_headers = nil) ⇒ ProviderListResult

Gets all resource providers for a subscription.

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:



412
413
414
415
 
# File 'lib/generated/azure_mgmt_resources/providers.rb', line 412

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 all resource providers for a subscription.

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.



441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
 
# File 'lib/generated/azure_mgmt_resources/providers.rb', line 441

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 = ProviderListResult.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response, 'result.body')
      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 all resource providers for a subscription.

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.



427
428
429
 
# File 'lib/generated/azure_mgmt_resources/providers.rb', line 427

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(top = nil, expand = nil, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Gets all resource providers for a subscription.

returns all deployments. use &$expand=metadata in the query string to retrieve resource provider metadata. To include property aliases in response, use $expand=resourceTypes/aliases. will be added to the HTTP request.

Parameters:

  • top (Integer) (defaults to: nil) —

    The number of results to return. If null is passed

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

    The properties to include in the results. For example,

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



238
239
240
 
# File 'lib/generated/azure_mgmt_resources/providers.rb', line 238

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

#register(resource_provider_namespace, custom_headers = nil) ⇒ Provider

Registers a subscription with a resource provider.

provider to register. will be added to the HTTP request.

Parameters:

  • resource_provider_namespace (String) —

    The namespace of the resource

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

    A hash of custom headers that

Returns:



125
126
127
128
 
# File 'lib/generated/azure_mgmt_resources/providers.rb', line 125

def register(resource_provider_namespace, custom_headers = nil)
  response = register_async(resource_provider_namespace, custom_headers).value!
  response.body unless response.nil?
end

#register_async(resource_provider_namespace, custom_headers = nil) ⇒ Concurrent::Promise

Registers a subscription with a resource provider.

provider to register. to the HTTP request.

Parameters:

  • resource_provider_namespace (String) —

    The namespace of the resource

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
195
196
197
198
199
200
201
202
203
 
# File 'lib/generated/azure_mgmt_resources/providers.rb', line 154

def register_async(resource_provider_namespace, custom_headers = nil)
  fail ArgumentError, 'resource_provider_namespace is nil' if resource_provider_namespace.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?


  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}/providers/{resourceProviderNamespace}/register'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceProviderNamespace' => resource_provider_namespace,'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(:post, 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 = Provider.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response, 'result.body')
      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

#register_with_http_info(resource_provider_namespace, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Registers a subscription with a resource provider.

provider to register. will be added to the HTTP request.

Parameters:

  • resource_provider_namespace (String) —

    The namespace of the resource

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



140
141
142
 
# File 'lib/generated/azure_mgmt_resources/providers.rb', line 140

def register_with_http_info(resource_provider_namespace, custom_headers = nil)
  register_async(resource_provider_namespace, custom_headers).value!
end

#unregister(resource_provider_namespace, custom_headers = nil) ⇒ Provider

Unregisters a subscription from a resource provider.

provider to unregister. will be added to the HTTP request.

Parameters:

  • resource_provider_namespace (String) —

    The namespace of the resource

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

    A hash of custom headers that

Returns:



35
36
37
38
 
# File 'lib/generated/azure_mgmt_resources/providers.rb', line 35

def unregister(resource_provider_namespace, custom_headers = nil)
  response = unregister_async(resource_provider_namespace, custom_headers).value!
  response.body unless response.nil?
end

#unregister_async(resource_provider_namespace, custom_headers = nil) ⇒ Concurrent::Promise

Unregisters a subscription from a resource provider.

provider to unregister. to the HTTP request.

Parameters:

  • resource_provider_namespace (String) —

    The namespace of the resource

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
109
110
111
112
113
 
# File 'lib/generated/azure_mgmt_resources/providers.rb', line 64

def unregister_async(resource_provider_namespace, custom_headers = nil)
  fail ArgumentError, 'resource_provider_namespace is nil' if resource_provider_namespace.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?


  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}/providers/{resourceProviderNamespace}/unregister'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceProviderNamespace' => resource_provider_namespace,'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(:post, 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 = Provider.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response, 'result.body')
      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

#unregister_with_http_info(resource_provider_namespace, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Unregisters a subscription from a resource provider.

provider to unregister. will be added to the HTTP request.

Parameters:

  • resource_provider_namespace (String) —

    The namespace of the resource

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



50
51
52
 
# File 'lib/generated/azure_mgmt_resources/providers.rb', line 50

def unregister_with_http_info(resource_provider_namespace, custom_headers = nil)
  unregister_async(resource_provider_namespace, custom_headers).value!
end