Class: Azure::Resources::Mgmt::V2020_06_01::Providers

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2020-06-01/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.



17
18
19
 
# File 'lib/2020-06-01/generated/azure_mgmt_resources/providers.rb', line 17

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ ResourceManagementClient (readonly)

Returns reference to the ResourceManagementClient.

Returns:



22
23
24
 
# File 'lib/2020-06-01/generated/azure_mgmt_resources/providers.rb', line 22

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:

  • (Provider) —

    operation results.



515
516
517
518
 
# File 'lib/2020-06-01/generated/azure_mgmt_resources/providers.rb', line 515

def get(resource_provider_namespace, expand:nil, custom_headers:nil)
  response = get_async(resource_provider_namespace, expand:expand, custom_headers: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.



548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
 
# File 'lib/2020-06-01/generated/azure_mgmt_resources/providers.rb', line 548

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 = {}
  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/{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?
    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::Resources::Mgmt::V2020_06_01::Models::Provider.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_at_tenant_scope(resource_provider_namespace, expand: nil, custom_headers: nil) ⇒ Provider

Gets the specified resource provider at the tenant level.

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:

  • (Provider) —

    operation results.



614
615
616
617
 
# File 'lib/2020-06-01/generated/azure_mgmt_resources/providers.rb', line 614

def get_at_tenant_scope(resource_provider_namespace, expand:nil, custom_headers:nil)
  response = get_at_tenant_scope_async(resource_provider_namespace, expand:expand, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

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

Gets the specified resource provider at the tenant level.

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.



647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
 
# File 'lib/2020-06-01/generated/azure_mgmt_resources/providers.rb', line 647

def get_at_tenant_scope_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?


  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 = '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},
      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?
    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::Resources::Mgmt::V2020_06_01::Models::Provider.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_at_tenant_scope_with_http_info(resource_provider_namespace, expand: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets the specified resource provider at the tenant level.

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.



631
632
633
 
# File 'lib/2020-06-01/generated/azure_mgmt_resources/providers.rb', line 631

def get_at_tenant_scope_with_http_info(resource_provider_namespace, expand:nil, custom_headers:nil)
  get_at_tenant_scope_async(resource_provider_namespace, expand:expand, custom_headers:custom_headers).value!
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.



532
533
534
 
# File 'lib/2020-06-01/generated/azure_mgmt_resources/providers.rb', line 532

def get_with_http_info(resource_provider_namespace, expand:nil, custom_headers:nil)
  get_async(resource_provider_namespace, expand:expand, custom_headers: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.



311
312
313
314
 
# File 'lib/2020-06-01/generated/azure_mgmt_resources/providers.rb', line 311

def list(top:nil, expand:nil, custom_headers:nil)
  first_page = list_as_lazy(top:top, expand:expand, custom_headers: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:

  • (ProviderListResult) —

    which provide lazy access to pages of the



895
896
897
898
899
900
901
902
903
904
 
# File 'lib/2020-06-01/generated/azure_mgmt_resources/providers.rb', line 895

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



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

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 = {}
  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'

  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?
    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::Resources::Mgmt::V2020_06_01::Models::ProviderListResult.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_at_tenant_scope(top: nil, expand: nil, custom_headers: nil) ⇒ Array<Provider>

Gets all resource providers for the tenant.

returns all providers. 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.



415
416
417
418
 
# File 'lib/2020-06-01/generated/azure_mgmt_resources/providers.rb', line 415

def list_at_tenant_scope(top:nil, expand:nil, custom_headers:nil)
  first_page = list_at_tenant_scope_as_lazy(top:top, expand:expand, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_at_tenant_scope_as_lazy(top: nil, expand: nil, custom_headers: nil) ⇒ ProviderListResult

Gets all resource providers for the tenant.

returns all providers. 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:

  • (ProviderListResult) —

    which provide lazy access to pages of the



921
922
923
924
925
926
927
928
929
930
 
# File 'lib/2020-06-01/generated/azure_mgmt_resources/providers.rb', line 921

def list_at_tenant_scope_as_lazy(top:nil, expand:nil, custom_headers:nil)
  response = list_at_tenant_scope_async(top:top, expand:expand, custom_headers:custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_at_tenant_scope_next_async(next_page_link, custom_headers:custom_headers)
    end
    page
  end
end

#list_at_tenant_scope_async(top: nil, expand: nil, custom_headers: nil) ⇒ Concurrent::Promise

Gets all resource providers for the tenant.

returns all providers. 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.



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
488
489
490
491
492
493
494
495
496
497
498
499
500
501
 
# File 'lib/2020-06-01/generated/azure_mgmt_resources/providers.rb', line 452

def list_at_tenant_scope_async(top:nil, expand:nil, custom_headers: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 = 'providers'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      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?
    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::Resources::Mgmt::V2020_06_01::Models::ProviderListResult.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_at_tenant_scope_next(next_page_link, custom_headers: nil) ⇒ ProviderListResult

Gets all resource providers for the tenant.

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:

  • (ProviderListResult) —

    operation results.



800
801
802
803
 
# File 'lib/2020-06-01/generated/azure_mgmt_resources/providers.rb', line 800

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

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

Gets all resource providers for the tenant.

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.



829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
 
# File 'lib/2020-06-01/generated/azure_mgmt_resources/providers.rb', line 829

def list_at_tenant_scope_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::Resources::Mgmt::V2020_06_01::Models::ProviderListResult.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_at_tenant_scope_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets all resource providers for the tenant.

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.



815
816
817
 
# File 'lib/2020-06-01/generated/azure_mgmt_resources/providers.rb', line 815

def list_at_tenant_scope_next_with_http_info(next_page_link, custom_headers:nil)
  list_at_tenant_scope_next_async(next_page_link, custom_headers:custom_headers).value!
end

#list_at_tenant_scope_with_http_info(top: nil, expand: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets all resource providers for the tenant.

returns all providers. 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.



434
435
436
 
# File 'lib/2020-06-01/generated/azure_mgmt_resources/providers.rb', line 434

def list_at_tenant_scope_with_http_info(top:nil, expand:nil, custom_headers:nil)
  list_at_tenant_scope_async(top:top, expand:expand, custom_headers:custom_headers).value!
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:

  • (ProviderListResult) —

    operation results.



710
711
712
713
 
# File 'lib/2020-06-01/generated/azure_mgmt_resources/providers.rb', line 710

def list_next(next_page_link, custom_headers:nil)
  response = list_next_async(next_page_link, custom_headers: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.



739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
 
# File 'lib/2020-06-01/generated/azure_mgmt_resources/providers.rb', line 739

def list_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::Resources::Mgmt::V2020_06_01::Models::ProviderListResult.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 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.



725
726
727
 
# File 'lib/2020-06-01/generated/azure_mgmt_resources/providers.rb', line 725

def list_next_with_http_info(next_page_link, custom_headers:nil)
  list_next_async(next_page_link, custom_headers: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.



330
331
332
 
# File 'lib/2020-06-01/generated/azure_mgmt_resources/providers.rb', line 330

def list_with_http_info(top:nil, expand:nil, custom_headers:nil)
  list_async(top:top, expand:expand, custom_headers: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:

  • (Provider) —

    operation results.



214
215
216
217
 
# File 'lib/2020-06-01/generated/azure_mgmt_resources/providers.rb', line 214

def register(resource_provider_namespace, custom_headers:nil)
  response = register_async(resource_provider_namespace, custom_headers: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.



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
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/2020-06-01/generated/azure_mgmt_resources/providers.rb', line 243

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 = {}
  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/{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?
    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::Resources::Mgmt::V2020_06_01::Models::Provider.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

#register_at_management_group_scope(resource_provider_namespace, group_id, custom_headers: nil) ⇒ Object

Registers a management group with a resource provider.

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

Parameters:

  • resource_provider_namespace (String) —

    The namespace of the resource

  • group_id (String) —

    The management group ID.

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

    A hash of custom headers that



127
128
129
130
 
# File 'lib/2020-06-01/generated/azure_mgmt_resources/providers.rb', line 127

def register_at_management_group_scope(resource_provider_namespace, group_id, custom_headers:nil)
  response = register_at_management_group_scope_async(resource_provider_namespace, group_id, custom_headers:custom_headers).value!
  nil
end

#register_at_management_group_scope_async(resource_provider_namespace, group_id, custom_headers: nil) ⇒ Concurrent::Promise

Registers a management group with a resource provider.

provider to register. to the HTTP request.

Parameters:

  • resource_provider_namespace (String) —

    The namespace of the resource

  • group_id (String) —

    The management group ID.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
 
# File 'lib/2020-06-01/generated/azure_mgmt_resources/providers.rb', line 158

def register_at_management_group_scope_async(resource_provider_namespace, group_id, 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, 'group_id is nil' if group_id.nil?
  fail ArgumentError, "'group_id' should satisfy the constraint - 'MaxLength': '90'" if !group_id.nil? && group_id.length > 90
  fail ArgumentError, "'group_id' should satisfy the constraint - 'MinLength': '1'" if !group_id.nil? && group_id.length < 1


  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 = 'providers/Microsoft.Management/managementGroups/{groupId}/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,'groupId' => group_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?
    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?

    result
  end

  promise.execute
end

#register_at_management_group_scope_with_http_info(resource_provider_namespace, group_id, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Registers a management group with a resource provider.

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

Parameters:

  • resource_provider_namespace (String) —

    The namespace of the resource

  • group_id (String) —

    The management group ID.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



143
144
145
 
# File 'lib/2020-06-01/generated/azure_mgmt_resources/providers.rb', line 143

def register_at_management_group_scope_with_http_info(resource_provider_namespace, group_id, custom_headers:nil)
  register_at_management_group_scope_async(resource_provider_namespace, group_id, custom_headers:custom_headers).value!
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.



229
230
231
 
# File 'lib/2020-06-01/generated/azure_mgmt_resources/providers.rb', line 229

def register_with_http_info(resource_provider_namespace, custom_headers:nil)
  register_async(resource_provider_namespace, custom_headers: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:

  • (Provider) —

    operation results.



34
35
36
37
 
# File 'lib/2020-06-01/generated/azure_mgmt_resources/providers.rb', line 34

def unregister(resource_provider_namespace, custom_headers:nil)
  response = unregister_async(resource_provider_namespace, custom_headers: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.



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
109
110
111
112
113
114
115
 
# File 'lib/2020-06-01/generated/azure_mgmt_resources/providers.rb', line 63

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 = {}
  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/{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?
    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::Resources::Mgmt::V2020_06_01::Models::Provider.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

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



49
50
51
 
# File 'lib/2020-06-01/generated/azure_mgmt_resources/providers.rb', line 49

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