Class: Azure::ResourcesManagement::Mgmt::V2018_01_01_preview::ManagementGroups

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2018-01-01-preview/generated/azure_mgmt_resources_management/management_groups.rb

Overview

The Azure Management Groups API enables consolidation of multiple subscriptions/resources into an organizational hierarchy and centrally manage access control, policies, alerting and reporting for those resources.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ ManagementGroups

Creates and initializes a new instance of the ManagementGroups class.

Parameters:

  • client —

    service class for accessing basic functionality.



21
22
23
 
# File 'lib/2018-01-01-preview/generated/azure_mgmt_resources_management/management_groups.rb', line 21

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ ManagementGroupsAPI (readonly)

Returns reference to the ManagementGroupsAPI.

Returns:



26
27
28
 
# File 'lib/2018-01-01-preview/generated/azure_mgmt_resources_management/management_groups.rb', line 26

def client
  @client
end

Instance Method Details

#begin_create_or_update(group_id, cache_control: 'no-cache', custom_headers: nil) ⇒ Object

Create or update a management group. If a management group is already created and a subsequent create request is issued with different properties, the management group properties will be updated.

any caches. will be added to the HTTP request.

Parameters:

  • group_id (String) —

    Management Group ID.

  • cache_control (String) (defaults to: 'no-cache') —

    Indicates that the request shouldn’t utilize

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

    A hash of custom headers that

Returns:

  • (Object) —

    operation results.



462
463
464
465
 
# File 'lib/2018-01-01-preview/generated/azure_mgmt_resources_management/management_groups.rb', line 462

def begin_create_or_update(group_id, cache_control:'no-cache', custom_headers:nil)
  response = begin_create_or_update_async(group_id, cache_control:cache_control, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#begin_create_or_update_async(group_id, cache_control: 'no-cache', custom_headers: nil) ⇒ Concurrent::Promise

Create or update a management group. If a management group is already created and a subsequent create request is issued with different properties, the management group properties will be updated.

any caches. to the HTTP request.

Parameters:

  • group_id (String) —

    Management Group ID.

  • cache_control (String) (defaults to: 'no-cache') —

    Indicates that the request shouldn’t utilize

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
 
# File 'lib/2018-01-01-preview/generated/azure_mgmt_resources_management/management_groups.rb', line 501

def begin_create_or_update_async(group_id, cache_control:'no-cache', custom_headers:nil)
  fail ArgumentError, 'group_id is nil' if group_id.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.create_management_group_request is nil' if @client.create_management_group_request.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['Cache-Control'] = cache_control unless cache_control.nil?
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?

  # Serialize Request
  request_mapper = Azure::ResourcesManagement::Mgmt::V2018_01_01_preview::Models::CreateManagementGroupRequest.mapper()
  request_content = @client.serialize(request_mapper,  @client.create_management_group_request)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'providers/Microsoft.Management/managementGroups/{groupId}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'groupId' => group_id},
      query_params: {'api-version' => @client.api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:put, 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 || status_code == 202
      error_model = JSON.load(response_content)
      fail MsRest::HttpOperationError.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::ResourcesManagement::Mgmt::V2018_01_01_preview::Models::ManagementGroup.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
    # Deserialize Response
    if status_code == 202
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::ResourcesManagement::Mgmt::V2018_01_01_preview::Models::OperationResults.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

#begin_create_or_update_with_http_info(group_id, cache_control: 'no-cache', custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Create or update a management group. If a management group is already created and a subsequent create request is issued with different properties, the management group properties will be updated.

any caches. will be added to the HTTP request.

Parameters:

  • group_id (String) —

    Management Group ID.

  • cache_control (String) (defaults to: 'no-cache') —

    Indicates that the request shouldn’t utilize

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



482
483
484
 
# File 'lib/2018-01-01-preview/generated/azure_mgmt_resources_management/management_groups.rb', line 482

def begin_create_or_update_with_http_info(group_id, cache_control:'no-cache', custom_headers:nil)
  begin_create_or_update_async(group_id, cache_control:cache_control, custom_headers:custom_headers).value!
end

#begin_delete(group_id, cache_control: 'no-cache', custom_headers: nil) ⇒ OperationResults

Delete management group. If a management group contains child resources, the request will fail.

any caches. will be added to the HTTP request.

Parameters:

  • group_id (String) —

    Management Group ID.

  • cache_control (String) (defaults to: 'no-cache') —

    Indicates that the request shouldn’t utilize

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

    A hash of custom headers that

Returns:

  • (OperationResults) —

    operation results.



584
585
586
587
 
# File 'lib/2018-01-01-preview/generated/azure_mgmt_resources_management/management_groups.rb', line 584

def begin_delete(group_id, cache_control:'no-cache', custom_headers:nil)
  response = begin_delete_async(group_id, cache_control:cache_control, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#begin_delete_async(group_id, cache_control: 'no-cache', custom_headers: nil) ⇒ Concurrent::Promise

Delete management group. If a management group contains child resources, the request will fail.

any caches. to the HTTP request.

Parameters:

  • group_id (String) —

    Management Group ID.

  • cache_control (String) (defaults to: 'no-cache') —

    Indicates that the request shouldn’t utilize

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
 
# File 'lib/2018-01-01-preview/generated/azure_mgmt_resources_management/management_groups.rb', line 619

def begin_delete_async(group_id, cache_control:'no-cache', custom_headers:nil)
  fail ArgumentError, 'group_id is nil' if group_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['Cache-Control'] = cache_control unless cache_control.nil?
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = 'providers/Microsoft.Management/managementGroups/{groupId}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'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(:delete, 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 == 202 || status_code == 204
      error_model = JSON.load(response_content)
      fail MsRest::HttpOperationError.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 == 202
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::ResourcesManagement::Mgmt::V2018_01_01_preview::Models::OperationResults.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

#begin_delete_with_http_info(group_id, cache_control: 'no-cache', custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Delete management group. If a management group contains child resources, the request will fail.

any caches. will be added to the HTTP request.

Parameters:

  • group_id (String) —

    Management Group ID.

  • cache_control (String) (defaults to: 'no-cache') —

    Indicates that the request shouldn’t utilize

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



602
603
604
 
# File 'lib/2018-01-01-preview/generated/azure_mgmt_resources_management/management_groups.rb', line 602

def begin_delete_with_http_info(group_id, cache_control:'no-cache', custom_headers:nil)
  begin_delete_async(group_id, cache_control:cache_control, custom_headers:custom_headers).value!
end

#create_or_update(group_id, cache_control: 'no-cache', custom_headers: nil) ⇒ Object

Create or update a management group. If a management group is already created and a subsequent create request is issued with different properties, the management group properties will be updated.

any caches. will be added to the HTTP request.

Parameters:

  • group_id (String) —

    Management Group ID.

  • cache_control (String) (defaults to: 'no-cache') —

    Indicates that the request shouldn’t utilize

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

    A hash of custom headers that

Returns:

  • (Object) —

    operation results.



256
257
258
259
 
# File 'lib/2018-01-01-preview/generated/azure_mgmt_resources_management/management_groups.rb', line 256

def create_or_update(group_id, cache_control:'no-cache', custom_headers:nil)
  response = create_or_update_async(group_id, cache_control:cache_control, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#create_or_update_async(group_id, cache_control: 'no-cache', custom_headers: nil) ⇒ Concurrent::Promise

any caches. will be added to the HTTP request.

response.

Parameters:

  • group_id (String) —

    Management Group ID.

  • cache_control (String) (defaults to: 'no-cache') —

    Indicates that the request shouldn’t utilize

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/2018-01-01-preview/generated/azure_mgmt_resources_management/management_groups.rb', line 271

def create_or_update_async(group_id, cache_control:'no-cache', custom_headers:nil)
  # Send request
  promise = begin_create_or_update_async(group_id, cache_control:cache_control, custom_headers:custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
      result_mapper = {
        client_side_validation: true,
        required: false,
        serialized_name: 'parsed_response',
        type: {
          name: 'Object'
        }
      }
      parsed_response = @client.deserialize(result_mapper, parsed_response)
    end

    # Waiting for response.
    @client.get_long_running_operation_result(response, deserialize_method)
  end

  promise
end

#delete(group_id, cache_control: 'no-cache', custom_headers: nil) ⇒ OperationResults

Delete management group. If a management group contains child resources, the request will fail.

any caches. will be added to the HTTP request.

Parameters:

  • group_id (String) —

    Management Group ID.

  • cache_control (String) (defaults to: 'no-cache') —

    Indicates that the request shouldn’t utilize

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

    A hash of custom headers that

Returns:

  • (OperationResults) —

    operation results.



414
415
416
417
 
# File 'lib/2018-01-01-preview/generated/azure_mgmt_resources_management/management_groups.rb', line 414

def delete(group_id, cache_control:'no-cache', custom_headers:nil)
  response = delete_async(group_id, cache_control:cache_control, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#delete_async(group_id, cache_control: 'no-cache', custom_headers: nil) ⇒ Concurrent::Promise

any caches. will be added to the HTTP request.

response.

Parameters:

  • group_id (String) —

    Management Group ID.

  • cache_control (String) (defaults to: 'no-cache') —

    Indicates that the request shouldn’t utilize

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
 
# File 'lib/2018-01-01-preview/generated/azure_mgmt_resources_management/management_groups.rb', line 429

def delete_async(group_id, cache_control:'no-cache', custom_headers:nil)
  # Send request
  promise = begin_delete_async(group_id, cache_control:cache_control, custom_headers:custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
      result_mapper = Azure::ResourcesManagement::Mgmt::V2018_01_01_preview::Models::OperationResults.mapper()
      parsed_response = @client.deserialize(result_mapper, parsed_response)
    end

    # Waiting for response.
    @client.get_long_running_operation_result(response, deserialize_method)
  end

  promise
end

#get(group_id, expand: nil, recurse: nil, filter: nil, cache_control: 'no-cache', custom_headers: nil) ⇒ ManagementGroup

Get the details of the management group.

clients to request inclusion of children in the response payload. Possible values include: ‘children’ clients to request inclusion of entire hierarchy in the response payload. Note that $expand=children must be passed up if $recurse is set to true. from results (i.e. ‘$filter=children.childType ne Subscription’) any caches. will be added to the HTTP request.

Parameters:

  • group_id (String) —

    Management Group ID.

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

    The $expand=children query string parameter allows

  • recurse (Boolean) (defaults to: nil) —

    The $recurse=true query string parameter allows

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

    A filter which allows the exclusion of subscriptions

  • cache_control (String) (defaults to: 'no-cache') —

    Indicates that the request shouldn’t utilize

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

    A hash of custom headers that

Returns:

  • (ManagementGroup) —

    operation results.



140
141
142
143
 
# File 'lib/2018-01-01-preview/generated/azure_mgmt_resources_management/management_groups.rb', line 140

def get(group_id, expand:nil, recurse:nil, filter:nil, cache_control:'no-cache', custom_headers:nil)
  response = get_async(group_id, expand:expand, recurse:recurse, filter:filter, cache_control:cache_control, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_async(group_id, expand: nil, recurse: nil, filter: nil, cache_control: 'no-cache', custom_headers: nil) ⇒ Concurrent::Promise

Get the details of the management group.

clients to request inclusion of children in the response payload. Possible values include: ‘children’ clients to request inclusion of entire hierarchy in the response payload. Note that $expand=children must be passed up if $recurse is set to true. from results (i.e. ‘$filter=children.childType ne Subscription’) any caches. to the HTTP request.

Parameters:

  • group_id (String) —

    Management Group ID.

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

    The $expand=children query string parameter allows

  • recurse (Boolean) (defaults to: nil) —

    The $recurse=true query string parameter allows

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

    A filter which allows the exclusion of subscriptions

  • cache_control (String) (defaults to: 'no-cache') —

    Indicates that the request shouldn’t utilize

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/2018-01-01-preview/generated/azure_mgmt_resources_management/management_groups.rb', line 189

def get_async(group_id, expand:nil, recurse:nil, filter:nil, cache_control:'no-cache', custom_headers:nil)
  fail ArgumentError, 'group_id is nil' if group_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['Cache-Control'] = cache_control unless cache_control.nil?
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = 'providers/Microsoft.Management/managementGroups/{groupId}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'groupId' => group_id},
      query_params: {'api-version' => @client.api_version,'$expand' => expand,'$recurse' => recurse,'$filter' => filter},
      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 MsRest::HttpOperationError.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::ResourcesManagement::Mgmt::V2018_01_01_preview::Models::ManagementGroup.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(group_id, expand: nil, recurse: nil, filter: nil, cache_control: 'no-cache', custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Get the details of the management group.

clients to request inclusion of children in the response payload. Possible values include: ‘children’ clients to request inclusion of entire hierarchy in the response payload. Note that $expand=children must be passed up if $recurse is set to true. from results (i.e. ‘$filter=children.childType ne Subscription’) any caches. will be added to the HTTP request.

Parameters:

  • group_id (String) —

    Management Group ID.

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

    The $expand=children query string parameter allows

  • recurse (Boolean) (defaults to: nil) —

    The $recurse=true query string parameter allows

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

    A filter which allows the exclusion of subscriptions

  • cache_control (String) (defaults to: 'no-cache') —

    Indicates that the request shouldn’t utilize

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



165
166
167
 
# File 'lib/2018-01-01-preview/generated/azure_mgmt_resources_management/management_groups.rb', line 165

def get_with_http_info(group_id, expand:nil, recurse:nil, filter:nil, cache_control:'no-cache', custom_headers:nil)
  get_async(group_id, expand:expand, recurse:recurse, filter:filter, cache_control:cache_control, custom_headers:custom_headers).value!
end

#list(cache_control: 'no-cache', custom_headers: nil) ⇒ Array<ManagementGroupInfo>

List management groups for the authenticated user.

any caches. will be added to the HTTP request.

Parameters:

  • cache_control (String) (defaults to: 'no-cache') —

    Indicates that the request shouldn’t utilize

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

    A hash of custom headers that

Returns:

  • (Array<ManagementGroupInfo>) —

    operation results.



39
40
41
42
 
# File 'lib/2018-01-01-preview/generated/azure_mgmt_resources_management/management_groups.rb', line 39

def list(cache_control:'no-cache', custom_headers:nil)
  first_page = list_as_lazy(cache_control:cache_control, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_as_lazy(cache_control: 'no-cache', custom_headers: nil) ⇒ ManagementGroupListResult

List management groups for the authenticated user.

any caches. will be added to the HTTP request.

response.

Parameters:

  • cache_control (String) (defaults to: 'no-cache') —

    Indicates that the request shouldn’t utilize

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

    A hash of custom headers that

Returns:

  • (ManagementGroupListResult) —

    which provide lazy access to pages of the



781
782
783
784
785
786
787
788
789
790
 
# File 'lib/2018-01-01-preview/generated/azure_mgmt_resources_management/management_groups.rb', line 781

def list_as_lazy(cache_control:'no-cache', custom_headers:nil)
  response = list_async(cache_control:cache_control, 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, cache_control:cache_control, custom_headers:custom_headers)
    end
    page
  end
end

#list_async(cache_control: 'no-cache', custom_headers: nil) ⇒ Concurrent::Promise

List management groups for the authenticated user.

any caches. to the HTTP request.

Parameters:

  • cache_control (String) (defaults to: 'no-cache') —

    Indicates that the request shouldn’t utilize

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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/2018-01-01-preview/generated/azure_mgmt_resources_management/management_groups.rb', line 70

def list_async(cache_control:'no-cache', 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['Cache-Control'] = cache_control unless cache_control.nil?
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = 'providers/Microsoft.Management/managementGroups'

  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,'$skiptoken' => @client.skiptoken},
      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 MsRest::HttpOperationError.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::ResourcesManagement::Mgmt::V2018_01_01_preview::Models::ManagementGroupListResult.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(next_page_link, cache_control: 'no-cache', custom_headers: nil) ⇒ ManagementGroupListResult

List management groups for the authenticated user.

to List operation. any caches. will be added to the HTTP request.

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful call

  • cache_control (String) (defaults to: 'no-cache') —

    Indicates that the request shouldn’t utilize

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

    A hash of custom headers that

Returns:

  • (ManagementGroupListResult) —

    operation results.



684
685
686
687
 
# File 'lib/2018-01-01-preview/generated/azure_mgmt_resources_management/management_groups.rb', line 684

def list_next(next_page_link, cache_control:'no-cache', custom_headers:nil)
  response = list_next_async(next_page_link, cache_control:cache_control, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#list_next_async(next_page_link, cache_control: 'no-cache', custom_headers: nil) ⇒ Concurrent::Promise

List management groups for the authenticated user.

to List operation. any caches. to the HTTP request.

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful call

  • cache_control (String) (defaults to: 'no-cache') —

    Indicates that the request shouldn’t utilize

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
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
 
# File 'lib/2018-01-01-preview/generated/azure_mgmt_resources_management/management_groups.rb', line 719

def list_next_async(next_page_link, cache_control:'no-cache', 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['Cache-Control'] = cache_control unless cache_control.nil?
  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 MsRest::HttpOperationError.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::ResourcesManagement::Mgmt::V2018_01_01_preview::Models::ManagementGroupListResult.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, cache_control: 'no-cache', custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

List management groups for the authenticated user.

to List operation. any caches. will be added to the HTTP request.

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful call

  • cache_control (String) (defaults to: 'no-cache') —

    Indicates that the request shouldn’t utilize

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



702
703
704
 
# File 'lib/2018-01-01-preview/generated/azure_mgmt_resources_management/management_groups.rb', line 702

def list_next_with_http_info(next_page_link, cache_control:'no-cache', custom_headers:nil)
  list_next_async(next_page_link, cache_control:cache_control, custom_headers:custom_headers).value!
end

#list_with_http_info(cache_control: 'no-cache', custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

List management groups for the authenticated user.

any caches. will be added to the HTTP request.

Parameters:

  • cache_control (String) (defaults to: 'no-cache') —

    Indicates that the request shouldn’t utilize

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



55
56
57
 
# File 'lib/2018-01-01-preview/generated/azure_mgmt_resources_management/management_groups.rb', line 55

def list_with_http_info(cache_control:'no-cache', custom_headers:nil)
  list_async(cache_control:cache_control, custom_headers:custom_headers).value!
end

#update(group_id, cache_control: 'no-cache', custom_headers: nil) ⇒ ManagementGroup

Update a management group.

any caches. will be added to the HTTP request.

Parameters:

  • group_id (String) —

    Management Group ID.

  • cache_control (String) (defaults to: 'no-cache') —

    Indicates that the request shouldn’t utilize

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

    A hash of custom headers that

Returns:

  • (ManagementGroup) —

    operation results.



308
309
310
311
 
# File 'lib/2018-01-01-preview/generated/azure_mgmt_resources_management/management_groups.rb', line 308

def update(group_id, cache_control:'no-cache', custom_headers:nil)
  response = update_async(group_id, cache_control:cache_control, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#update_async(group_id, cache_control: 'no-cache', custom_headers: nil) ⇒ Concurrent::Promise

Update a management group.

any caches. to the HTTP request.

Parameters:

  • group_id (String) —

    Management Group ID.

  • cache_control (String) (defaults to: 'no-cache') —

    Indicates that the request shouldn’t utilize

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



341
342
343
344
345
346
347
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/2018-01-01-preview/generated/azure_mgmt_resources_management/management_groups.rb', line 341

def update_async(group_id, cache_control:'no-cache', custom_headers:nil)
  fail ArgumentError, 'group_id is nil' if group_id.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.patch_group_request is nil' if @client.patch_group_request.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['Cache-Control'] = cache_control unless cache_control.nil?
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?

  # Serialize Request
  request_mapper = Azure::ResourcesManagement::Mgmt::V2018_01_01_preview::Models::PatchManagementGroupRequest.mapper()
  request_content = @client.serialize(request_mapper,  @client.patch_group_request)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'providers/Microsoft.Management/managementGroups/{groupId}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'groupId' => group_id},
      query_params: {'api-version' => @client.api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:patch, 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 MsRest::HttpOperationError.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::ResourcesManagement::Mgmt::V2018_01_01_preview::Models::ManagementGroup.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

#update_with_http_info(group_id, cache_control: 'no-cache', custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Update a management group.

any caches. will be added to the HTTP request.

Parameters:

  • group_id (String) —

    Management Group ID.

  • cache_control (String) (defaults to: 'no-cache') —

    Indicates that the request shouldn’t utilize

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



325
326
327
 
# File 'lib/2018-01-01-preview/generated/azure_mgmt_resources_management/management_groups.rb', line 325

def update_with_http_info(group_id, cache_control:'no-cache', custom_headers:nil)
  update_async(group_id, cache_control:cache_control, custom_headers:custom_headers).value!
end