Class: Azure::ResourcesManagement::Mgmt::V2017_08_31_preview::ManagementGroups

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

def client
  @client
end

Instance Method Details

#get(expand: nil, recurse: nil, custom_headers: nil) ⇒ ManagementGroupWithHierarchy

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. will be added to the HTTP request.

Parameters:

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

    The $expand=children query string parameter allows

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

    The $recurse=true query string parameter allows

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

    A hash of custom headers that

Returns:

  • (ManagementGroupWithHierarchy) —

    operation results.



145
146
147
148
 
# File 'lib/2017-08-31-preview/generated/azure_mgmt_resources_management/management_groups.rb', line 145

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

#get_async(expand: nil, recurse: nil, 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. to the HTTP request.

Parameters:

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

    The $expand=children query string parameter allows

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

    The $recurse=true query string parameter allows

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



182
183
184
185
186
187
188
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
 
# File 'lib/2017-08-31-preview/generated/azure_mgmt_resources_management/management_groups.rb', line 182

def get_async(expand:nil, recurse:nil, custom_headers:nil)
  fail ArgumentError, '@client.group_id is nil' if @client.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['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' => @client.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_08_31_preview::Models::ManagementGroupWithHierarchy.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(expand: nil, recurse: nil, 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. will be added to the HTTP request.

Parameters:

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

    The $expand=children query string parameter allows

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

    The $recurse=true query string parameter allows

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



164
165
166
 
# File 'lib/2017-08-31-preview/generated/azure_mgmt_resources_management/management_groups.rb', line 164

def get_with_http_info(expand:nil, recurse:nil, custom_headers:nil)
  get_async(expand:expand, recurse:recurse, custom_headers:custom_headers).value!
end

#list(skiptoken: nil, custom_headers: nil) ⇒ Array<ManagementGroupInfo>

List management groups for the authenticated user.

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:

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



43
44
45
46
 
# File 'lib/2017-08-31-preview/generated/azure_mgmt_resources_management/management_groups.rb', line 43

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

#list_as_lazy(skiptoken: nil, custom_headers: nil) ⇒ ManagementGroupListResult

List management groups for the authenticated user.

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:

  • 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



340
341
342
343
344
345
346
347
348
349
 
# File 'lib/2017-08-31-preview/generated/azure_mgmt_resources_management/management_groups.rb', line 340

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

#list_async(skiptoken: nil, custom_headers: nil) ⇒ Concurrent::Promise

List management groups for the authenticated user.

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:

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



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
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/2017-08-31-preview/generated/azure_mgmt_resources_management/management_groups.rb', line 82

def list_async(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['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_08_31_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, custom_headers: nil) ⇒ ManagementGroupListResult

List management groups for the authenticated user.

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:

  • (ManagementGroupListResult) —

    operation results.



244
245
246
247
 
# File 'lib/2017-08-31-preview/generated/azure_mgmt_resources_management/management_groups.rb', line 244

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

List management groups for the authenticated user.

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.



275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/2017-08-31-preview/generated/azure_mgmt_resources_management/management_groups.rb', line 275

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

List management groups for the authenticated user.

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.



260
261
262
 
# File 'lib/2017-08-31-preview/generated/azure_mgmt_resources_management/management_groups.rb', line 260

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

List management groups for the authenticated user.

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:

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



63
64
65
 
# File 'lib/2017-08-31-preview/generated/azure_mgmt_resources_management/management_groups.rb', line 63

def list_with_http_info(skiptoken:nil, custom_headers:nil)
  list_async(skiptoken:skiptoken, custom_headers:custom_headers).value!
end