Class: Azure::ResourcesManagement::Mgmt::V2017_11_01_preview::ManagementGroups

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2017-11-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/2017-11-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/2017-11-01-preview/generated/azure_mgmt_resources_management/management_groups.rb', line 26

def client
  @client
end

Instance Method Details

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

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.

Management group creation parameters. any caches. will be added to the HTTP request.

Parameters:

  • group_id (String) —

    Management Group ID.

  • create_management_group_request (CreateManagementGroupRequest)
  • 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.



267
268
269
270
 
# File 'lib/2017-11-01-preview/generated/azure_mgmt_resources_management/management_groups.rb', line 267

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

#create_or_update_async(group_id, create_management_group_request, 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.

Management group creation parameters. any caches. to the HTTP request.

Parameters:

  • group_id (String) —

    Management Group ID.

  • create_management_group_request (CreateManagementGroupRequest)
  • 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.



310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
 
# File 'lib/2017-11-01-preview/generated/azure_mgmt_resources_management/management_groups.rb', line 310

def create_or_update_async(group_id, create_management_group_request, 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, 'create_management_group_request is nil' if 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::V2017_11_01_preview::Models::CreateManagementGroupRequest.mapper()
  request_content = @client.serialize(request_mapper,  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
      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::V2017_11_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

#create_or_update_with_http_info(group_id, create_management_group_request, 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.

Management group creation parameters. any caches. will be added to the HTTP request.

Parameters:

  • group_id (String) —

    Management Group ID.

  • create_management_group_request (CreateManagementGroupRequest)
  • 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.



289
290
291
 
# File 'lib/2017-11-01-preview/generated/azure_mgmt_resources_management/management_groups.rb', line 289

def create_or_update_with_http_info(group_id, create_management_group_request, cache_control:'no-cache', custom_headers:nil)
  create_or_update_async(group_id, create_management_group_request, cache_control:cache_control, custom_headers:custom_headers).value!
end

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

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



493
494
495
496
 
# File 'lib/2017-11-01-preview/generated/azure_mgmt_resources_management/management_groups.rb', line 493

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!
  nil
end

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



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
 
# File 'lib/2017-11-01-preview/generated/azure_mgmt_resources_management/management_groups.rb', line 528

def 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 == 200 || 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?

    result
  end

  promise.execute
end

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



511
512
513
 
# File 'lib/2017-11-01-preview/generated/azure_mgmt_resources_management/management_groups.rb', line 511

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

#get(group_id, expand: nil, recurse: 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. 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

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



155
156
157
158
 
# File 'lib/2017-11-01-preview/generated/azure_mgmt_resources_management/management_groups.rb', line 155

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

#get_async(group_id, expand: nil, recurse: 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. 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

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



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
240
241
242
243
244
245
246
247
248
 
# File 'lib/2017-11-01-preview/generated/azure_mgmt_resources_management/management_groups.rb', line 198

def get_async(group_id, expand:nil, recurse: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},
      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::V2017_11_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, 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. 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

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



177
178
179
 
# File 'lib/2017-11-01-preview/generated/azure_mgmt_resources_management/management_groups.rb', line 177

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

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

List management groups for the authenticated user.

any caches. operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a token parameter that specifies a starting point to use for subsequent calls.

will be added to the HTTP request.

Parameters:

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

    Indicates that the request shouldn’t utilize

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

    Page continuation token is only used if a previous

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

    A hash of custom headers that

Returns:

  • (Array<ManagementGroupInfo>) —

    operation results.



45
46
47
48
 
# File 'lib/2017-11-01-preview/generated/azure_mgmt_resources_management/management_groups.rb', line 45

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

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

List management groups for the authenticated user.

any caches. operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a token parameter that specifies a starting point to use for subsequent calls.

will be added to the HTTP request.

response.

Parameters:

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

    Indicates that the request shouldn’t utilize

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

    Page continuation token is only used if a previous

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

    A hash of custom headers that

Returns:

  • (ManagementGroupListResult) —

    which provide lazy access to pages of the



686
687
688
689
690
691
692
693
694
695
 
# File 'lib/2017-11-01-preview/generated/azure_mgmt_resources_management/management_groups.rb', line 686

def list_as_lazy(cache_control:'no-cache', skiptoken:nil, custom_headers:nil)
  response = list_async(cache_control:cache_control, skiptoken:skiptoken, 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', skiptoken: nil, custom_headers: nil) ⇒ Concurrent::Promise

List management groups for the authenticated user.

any caches. operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a token parameter that specifies a starting point to use for subsequent calls.

to the HTTP request.

Parameters:

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

    Indicates that the request shouldn’t utilize

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

    Page continuation token is only used if a previous

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/2017-11-01-preview/generated/azure_mgmt_resources_management/management_groups.rb', line 88

def list_async(cache_control:'no-cache', skiptoken: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['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' => 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::V2017_11_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.



583
584
585
586
 
# File 'lib/2017-11-01-preview/generated/azure_mgmt_resources_management/management_groups.rb', line 583

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.



618
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
 
# File 'lib/2017-11-01-preview/generated/azure_mgmt_resources_management/management_groups.rb', line 618

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::V2017_11_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.



601
602
603
 
# File 'lib/2017-11-01-preview/generated/azure_mgmt_resources_management/management_groups.rb', line 601

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', skiptoken: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

List management groups for the authenticated user.

any caches. operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a token parameter that specifies a starting point to use for subsequent calls.

will be added to the HTTP request.

Parameters:

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

    Indicates that the request shouldn’t utilize

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

    Page continuation token is only used if a previous

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



67
68
69
 
# File 'lib/2017-11-01-preview/generated/azure_mgmt_resources_management/management_groups.rb', line 67

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

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

Update a management group.

Management group creation parameters. any caches. will be added to the HTTP request.

Parameters:

  • group_id (String) —

    Management Group ID.

  • create_management_group_request (CreateManagementGroupRequest)
  • 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.



384
385
386
387
 
# File 'lib/2017-11-01-preview/generated/azure_mgmt_resources_management/management_groups.rb', line 384

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

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

Update a management group.

Management group creation parameters. any caches. to the HTTP request.

Parameters:

  • group_id (String) —

    Management Group ID.

  • create_management_group_request (CreateManagementGroupRequest)
  • 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.



421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
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
 
# File 'lib/2017-11-01-preview/generated/azure_mgmt_resources_management/management_groups.rb', line 421

def update_async(group_id, create_management_group_request, 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, 'create_management_group_request is nil' if 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::V2017_11_01_preview::Models::CreateManagementGroupRequest.mapper()
  request_content = @client.serialize(request_mapper,  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(: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::V2017_11_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, create_management_group_request, cache_control: 'no-cache', custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Update a management group.

Management group creation parameters. any caches. will be added to the HTTP request.

Parameters:

  • group_id (String) —

    Management Group ID.

  • create_management_group_request (CreateManagementGroupRequest)
  • 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.



403
404
405
 
# File 'lib/2017-11-01-preview/generated/azure_mgmt_resources_management/management_groups.rb', line 403

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