Class: Azure::Policy::Mgmt::V2016_12_01::PolicyDefinitions

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2016-12-01/generated/azure_mgmt_policy/policy_definitions.rb

Overview

To manage and control access to your resources, you can define customized policies and assign them at a scope.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ PolicyDefinitions

Creates and initializes a new instance of the PolicyDefinitions class.

Parameters:

  • client

    service class for accessing basic functionality.



18
19
20
# File 'lib/2016-12-01/generated/azure_mgmt_policy/policy_definitions.rb', line 18

def initialize(client)
  @client = client
end

Instance Attribute Details

#clientPolicyClient (readonly)

Returns reference to the PolicyClient.

Returns:



23
24
25
# File 'lib/2016-12-01/generated/azure_mgmt_policy/policy_definitions.rb', line 23

def client
  @client
end

Instance Method Details

#create_or_update(policy_definition_name, parameters, custom_headers: nil) ⇒ PolicyDefinition

Creates or updates a policy definition.

create. will be added to the HTTP request.

Parameters:

  • policy_definition_name (String)

    The name of the policy definition to

  • parameters (PolicyDefinition)

    The policy definition properties.

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

    A hash of custom headers that

Returns:

  • (PolicyDefinition)

    operation results.



36
37
38
39
# File 'lib/2016-12-01/generated/azure_mgmt_policy/policy_definitions.rb', line 36

def create_or_update(policy_definition_name, parameters, custom_headers:nil)
  response = create_or_update_async(policy_definition_name, parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#create_or_update_async(policy_definition_name, parameters, custom_headers: nil) ⇒ Concurrent::Promise

Creates or updates a policy definition.

create. to the HTTP request.

Parameters:

  • policy_definition_name (String)

    The name of the policy definition to

  • parameters (PolicyDefinition)

    The policy definition properties.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



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
116
117
118
119
120
121
122
123
124
125
126
127
# File 'lib/2016-12-01/generated/azure_mgmt_policy/policy_definitions.rb', line 67

def create_or_update_async(policy_definition_name, parameters, custom_headers:nil)
  fail ArgumentError, 'policy_definition_name is nil' if policy_definition_name.nil?
  fail ArgumentError, 'parameters is nil' if parameters.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?

  # Serialize Request
  request_mapper = Azure::Policy::Mgmt::V2016_12_01::Models::PolicyDefinition.mapper()
  request_content = @client.serialize(request_mapper,  parameters)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policyDefinitions/{policyDefinitionName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'policyDefinitionName' => policy_definition_name,'subscriptionId' => @client.subscription_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 == 201
      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 == 201
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Policy::Mgmt::V2016_12_01::Models::PolicyDefinition.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_at_management_group(policy_definition_name, parameters, management_group_id, custom_headers: nil) ⇒ PolicyDefinition

Creates or updates a policy definition at management group level.

create. will be added to the HTTP request.

Parameters:

  • policy_definition_name (String)

    The name of the policy definition to

  • parameters (PolicyDefinition)

    The policy definition properties.

  • management_group_id (String)

    The ID of the management group.

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

    A hash of custom headers that

Returns:

  • (PolicyDefinition)

    operation results.



408
409
410
411
# File 'lib/2016-12-01/generated/azure_mgmt_policy/policy_definitions.rb', line 408

def create_or_update_at_management_group(policy_definition_name, parameters, management_group_id, custom_headers:nil)
  response = create_or_update_at_management_group_async(policy_definition_name, parameters, management_group_id, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#create_or_update_at_management_group_async(policy_definition_name, parameters, management_group_id, custom_headers: nil) ⇒ Concurrent::Promise

Creates or updates a policy definition at management group level.

create. to the HTTP request.

Parameters:

  • policy_definition_name (String)

    The name of the policy definition to

  • parameters (PolicyDefinition)

    The policy definition properties.

  • management_group_id (String)

    The ID of the management group.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
# File 'lib/2016-12-01/generated/azure_mgmt_policy/policy_definitions.rb', line 441

def create_or_update_at_management_group_async(policy_definition_name, parameters, management_group_id, custom_headers:nil)
  fail ArgumentError, 'policy_definition_name is nil' if policy_definition_name.nil?
  fail ArgumentError, 'parameters is nil' if parameters.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, 'management_group_id is nil' if management_group_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?

  # Serialize Request
  request_mapper = Azure::Policy::Mgmt::V2016_12_01::Models::PolicyDefinition.mapper()
  request_content = @client.serialize(request_mapper,  parameters)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'providers/Microsoft.Management/managementgroups/{managementGroupId}/providers/Microsoft.Authorization/policyDefinitions/{policyDefinitionName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'policyDefinitionName' => policy_definition_name,'managementGroupId' => management_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 == 201
      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 == 201
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Policy::Mgmt::V2016_12_01::Models::PolicyDefinition.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_at_management_group_with_http_info(policy_definition_name, parameters, management_group_id, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Creates or updates a policy definition at management group level.

create. will be added to the HTTP request.

Parameters:

  • policy_definition_name (String)

    The name of the policy definition to

  • parameters (PolicyDefinition)

    The policy definition properties.

  • management_group_id (String)

    The ID of the management group.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



425
426
427
# File 'lib/2016-12-01/generated/azure_mgmt_policy/policy_definitions.rb', line 425

def create_or_update_at_management_group_with_http_info(policy_definition_name, parameters, management_group_id, custom_headers:nil)
  create_or_update_at_management_group_async(policy_definition_name, parameters, management_group_id, custom_headers:custom_headers).value!
end

#create_or_update_with_http_info(policy_definition_name, parameters, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Creates or updates a policy definition.

create. will be added to the HTTP request.

Parameters:

  • policy_definition_name (String)

    The name of the policy definition to

  • parameters (PolicyDefinition)

    The policy definition properties.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



52
53
54
# File 'lib/2016-12-01/generated/azure_mgmt_policy/policy_definitions.rb', line 52

def create_or_update_with_http_info(policy_definition_name, parameters, custom_headers:nil)
  create_or_update_async(policy_definition_name, parameters, custom_headers:custom_headers).value!
end

#delete(policy_definition_name, custom_headers: nil) ⇒ Object

Deletes a policy definition.

delete. will be added to the HTTP request.

Parameters:

  • policy_definition_name (String)

    The name of the policy definition to

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

    A hash of custom headers that



138
139
140
141
# File 'lib/2016-12-01/generated/azure_mgmt_policy/policy_definitions.rb', line 138

def delete(policy_definition_name, custom_headers:nil)
  response = delete_async(policy_definition_name, custom_headers:custom_headers).value!
  nil
end

#delete_async(policy_definition_name, custom_headers: nil) ⇒ Concurrent::Promise

Deletes a policy definition.

delete. to the HTTP request.

Parameters:

  • policy_definition_name (String)

    The name of the policy definition to

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
# File 'lib/2016-12-01/generated/azure_mgmt_policy/policy_definitions.rb', line 167

def delete_async(policy_definition_name, custom_headers:nil)
  fail ArgumentError, 'policy_definition_name is nil' if policy_definition_name.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/Microsoft.Authorization/policyDefinitions/{policyDefinitionName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'policyDefinitionName' => policy_definition_name,'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(: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 == 204 || 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

#delete_at_management_group(policy_definition_name, management_group_id, custom_headers: nil) ⇒ Object

Deletes a policy definition at management group level.

delete. will be added to the HTTP request.

Parameters:

  • policy_definition_name (String)

    The name of the policy definition to

  • management_group_id (String)

    The ID of the management group.

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

    A hash of custom headers that



513
514
515
516
# File 'lib/2016-12-01/generated/azure_mgmt_policy/policy_definitions.rb', line 513

def delete_at_management_group(policy_definition_name, management_group_id, custom_headers:nil)
  response = delete_at_management_group_async(policy_definition_name, management_group_id, custom_headers:custom_headers).value!
  nil
end

#delete_at_management_group_async(policy_definition_name, management_group_id, custom_headers: nil) ⇒ Concurrent::Promise

Deletes a policy definition at management group level.

delete. to the HTTP request.

Parameters:

  • policy_definition_name (String)

    The name of the policy definition to

  • management_group_id (String)

    The ID of the management group.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



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
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
# File 'lib/2016-12-01/generated/azure_mgmt_policy/policy_definitions.rb', line 544

def delete_at_management_group_async(policy_definition_name, management_group_id, custom_headers:nil)
  fail ArgumentError, 'policy_definition_name is nil' if policy_definition_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, 'management_group_id is nil' if management_group_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 = 'providers/Microsoft.Management/managementgroups/{managementGroupId}/providers/Microsoft.Authorization/policyDefinitions/{policyDefinitionName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'policyDefinitionName' => policy_definition_name,'managementGroupId' => management_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 == 204 || 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

#delete_at_management_group_with_http_info(policy_definition_name, management_group_id, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Deletes a policy definition at management group level.

delete. will be added to the HTTP request.

Parameters:

  • policy_definition_name (String)

    The name of the policy definition to

  • management_group_id (String)

    The ID of the management group.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



529
530
531
# File 'lib/2016-12-01/generated/azure_mgmt_policy/policy_definitions.rb', line 529

def delete_at_management_group_with_http_info(policy_definition_name, management_group_id, custom_headers:nil)
  delete_at_management_group_async(policy_definition_name, management_group_id, custom_headers:custom_headers).value!
end

#delete_with_http_info(policy_definition_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Deletes a policy definition.

delete. will be added to the HTTP request.

Parameters:

  • policy_definition_name (String)

    The name of the policy definition to

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



153
154
155
# File 'lib/2016-12-01/generated/azure_mgmt_policy/policy_definitions.rb', line 153

def delete_with_http_info(policy_definition_name, custom_headers:nil)
  delete_async(policy_definition_name, custom_headers:custom_headers).value!
end

#get(policy_definition_name, custom_headers: nil) ⇒ PolicyDefinition

Gets the policy definition.

get. will be added to the HTTP request.

Parameters:

  • policy_definition_name (String)

    The name of the policy definition to

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

    A hash of custom headers that

Returns:

  • (PolicyDefinition)

    operation results.



221
222
223
224
# File 'lib/2016-12-01/generated/azure_mgmt_policy/policy_definitions.rb', line 221

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

#get_async(policy_definition_name, custom_headers: nil) ⇒ Concurrent::Promise

Gets the policy definition.

get. to the HTTP request.

Parameters:

  • policy_definition_name (String)

    The name of the policy definition to

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



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
296
297
298
299
300
301
302
# File 'lib/2016-12-01/generated/azure_mgmt_policy/policy_definitions.rb', line 250

def get_async(policy_definition_name, custom_headers:nil)
  fail ArgumentError, 'policy_definition_name is nil' if policy_definition_name.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/Microsoft.Authorization/policyDefinitions/{policyDefinitionName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'policyDefinitionName' => policy_definition_name,'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(: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::Policy::Mgmt::V2016_12_01::Models::PolicyDefinition.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_management_group(policy_definition_name, management_group_id, custom_headers: nil) ⇒ PolicyDefinition

Gets the policy definition at management group level.

get. will be added to the HTTP request.

Parameters:

  • policy_definition_name (String)

    The name of the policy definition to

  • management_group_id (String)

    The ID of the management group.

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

    A hash of custom headers that

Returns:

  • (PolicyDefinition)

    operation results.



599
600
601
602
# File 'lib/2016-12-01/generated/azure_mgmt_policy/policy_definitions.rb', line 599

def get_at_management_group(policy_definition_name, management_group_id, custom_headers:nil)
  response = get_at_management_group_async(policy_definition_name, management_group_id, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_at_management_group_async(policy_definition_name, management_group_id, custom_headers: nil) ⇒ Concurrent::Promise

Gets the policy definition at management group level.

get. to the HTTP request.

Parameters:

  • policy_definition_name (String)

    The name of the policy definition to

  • management_group_id (String)

    The ID of the management group.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



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
670
671
672
673
674
675
676
677
678
679
680
681
682
# File 'lib/2016-12-01/generated/azure_mgmt_policy/policy_definitions.rb', line 630

def get_at_management_group_async(policy_definition_name, management_group_id, custom_headers:nil)
  fail ArgumentError, 'policy_definition_name is nil' if policy_definition_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, 'management_group_id is nil' if management_group_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 = 'providers/Microsoft.Management/managementgroups/{managementGroupId}/providers/Microsoft.Authorization/policyDefinitions/{policyDefinitionName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'policyDefinitionName' => policy_definition_name,'managementGroupId' => management_group_id},
      query_params: {'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::Policy::Mgmt::V2016_12_01::Models::PolicyDefinition.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_management_group_with_http_info(policy_definition_name, management_group_id, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets the policy definition at management group level.

get. will be added to the HTTP request.

Parameters:

  • policy_definition_name (String)

    The name of the policy definition to

  • management_group_id (String)

    The ID of the management group.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



615
616
617
# File 'lib/2016-12-01/generated/azure_mgmt_policy/policy_definitions.rb', line 615

def get_at_management_group_with_http_info(policy_definition_name, management_group_id, custom_headers:nil)
  get_at_management_group_async(policy_definition_name, management_group_id, custom_headers:custom_headers).value!
end

#get_built_in(policy_definition_name, custom_headers: nil) ⇒ PolicyDefinition

Gets the built in policy definition.

definition to get. will be added to the HTTP request.

Parameters:

  • policy_definition_name (String)

    The name of the built in policy

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

    A hash of custom headers that

Returns:

  • (PolicyDefinition)

    operation results.



314
315
316
317
# File 'lib/2016-12-01/generated/azure_mgmt_policy/policy_definitions.rb', line 314

def get_built_in(policy_definition_name, custom_headers:nil)
  response = get_built_in_async(policy_definition_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_built_in_async(policy_definition_name, custom_headers: nil) ⇒ Concurrent::Promise

Gets the built in policy definition.

definition to get. to the HTTP request.

Parameters:

  • policy_definition_name (String)

    The name of the built in policy

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



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
# File 'lib/2016-12-01/generated/azure_mgmt_policy/policy_definitions.rb', line 343

def get_built_in_async(policy_definition_name, custom_headers:nil)
  fail ArgumentError, 'policy_definition_name is nil' if policy_definition_name.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.Authorization/policyDefinitions/{policyDefinitionName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'policyDefinitionName' => policy_definition_name},
      query_params: {'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::Policy::Mgmt::V2016_12_01::Models::PolicyDefinition.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_built_in_with_http_info(policy_definition_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets the built in policy definition.

definition to get. will be added to the HTTP request.

Parameters:

  • policy_definition_name (String)

    The name of the built in policy

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



329
330
331
# File 'lib/2016-12-01/generated/azure_mgmt_policy/policy_definitions.rb', line 329

def get_built_in_with_http_info(policy_definition_name, custom_headers:nil)
  get_built_in_async(policy_definition_name, custom_headers:custom_headers).value!
end

#get_with_http_info(policy_definition_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets the policy definition.

get. will be added to the HTTP request.

Parameters:

  • policy_definition_name (String)

    The name of the policy definition to

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



236
237
238
# File 'lib/2016-12-01/generated/azure_mgmt_policy/policy_definitions.rb', line 236

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

#list(custom_headers: nil) ⇒ Array<PolicyDefinition>

Gets all the policy definitions for a subscription.

will be added to the HTTP request.

Parameters:

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

    A hash of custom headers that

Returns:

  • (Array<PolicyDefinition>)

    operation results.



692
693
694
695
# File 'lib/2016-12-01/generated/azure_mgmt_policy/policy_definitions.rb', line 692

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

#list_as_lazy(custom_headers: nil) ⇒ PolicyDefinitionListResult

Gets all the policy definitions for a subscription.

will be added to the HTTP request.

the response.

Parameters:

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

    A hash of custom headers that

Returns:

  • (PolicyDefinitionListResult)

    which provide lazy access to pages of



1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
# File 'lib/2016-12-01/generated/azure_mgmt_policy/policy_definitions.rb', line 1222

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

Gets all the policy definitions for a subscription.

to the HTTP request.

Parameters:

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



717
718
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
768
# File 'lib/2016-12-01/generated/azure_mgmt_policy/policy_definitions.rb', line 717

def list_async(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/Microsoft.Authorization/policyDefinitions'

  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: {'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::Policy::Mgmt::V2016_12_01::Models::PolicyDefinitionListResult.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_built_in(custom_headers: nil) ⇒ Array<PolicyDefinition>

Gets all the built in policy definitions.

will be added to the HTTP request.

Parameters:

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

    A hash of custom headers that

Returns:

  • (Array<PolicyDefinition>)

    operation results.



778
779
780
781
# File 'lib/2016-12-01/generated/azure_mgmt_policy/policy_definitions.rb', line 778

def list_built_in(custom_headers:nil)
  first_page = list_built_in_as_lazy(custom_headers:custom_headers)
  first_page.get_all_items
end

#list_built_in_as_lazy(custom_headers: nil) ⇒ PolicyDefinitionListResult

Gets all the built in policy definitions.

will be added to the HTTP request.

the response.

Parameters:

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

    A hash of custom headers that

Returns:

  • (PolicyDefinitionListResult)

    which provide lazy access to pages of



1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
# File 'lib/2016-12-01/generated/azure_mgmt_policy/policy_definitions.rb', line 1242

def list_built_in_as_lazy(custom_headers:nil)
  response = list_built_in_async(custom_headers:custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_built_in_next_async(next_page_link, custom_headers:custom_headers)
    end
    page
  end
end

#list_built_in_async(custom_headers: nil) ⇒ Concurrent::Promise

Gets all the built in policy definitions.

to the HTTP request.

Parameters:

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
# File 'lib/2016-12-01/generated/azure_mgmt_policy/policy_definitions.rb', line 803

def list_built_in_async(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.Authorization/policyDefinitions'

  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},
      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::Policy::Mgmt::V2016_12_01::Models::PolicyDefinitionListResult.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_built_in_next(next_page_link, custom_headers: nil) ⇒ PolicyDefinitionListResult

Gets all the built in policy definitions.

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:

  • (PolicyDefinitionListResult)

    operation results.



1043
1044
1045
1046
# File 'lib/2016-12-01/generated/azure_mgmt_policy/policy_definitions.rb', line 1043

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

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

Gets all the built in policy definitions.

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.



1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
# File 'lib/2016-12-01/generated/azure_mgmt_policy/policy_definitions.rb', line 1072

def list_built_in_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::Policy::Mgmt::V2016_12_01::Models::PolicyDefinitionListResult.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_built_in_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets all the built in policy definitions.

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.



1058
1059
1060
# File 'lib/2016-12-01/generated/azure_mgmt_policy/policy_definitions.rb', line 1058

def list_built_in_next_with_http_info(next_page_link, custom_headers:nil)
  list_built_in_next_async(next_page_link, custom_headers:custom_headers).value!
end

#list_built_in_with_http_info(custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets all the built in policy definitions.

will be added to the HTTP request.

Parameters:

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



791
792
793
# File 'lib/2016-12-01/generated/azure_mgmt_policy/policy_definitions.rb', line 791

def list_built_in_with_http_info(custom_headers:nil)
  list_built_in_async(custom_headers:custom_headers).value!
end

#list_by_management_group(management_group_id, custom_headers: nil) ⇒ Array<PolicyDefinition>

Gets all the policy definitions for a subscription at management group level.

will be added to the HTTP request.

Parameters:

  • management_group_id (String)

    The ID of the management group.

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

    A hash of custom headers that

Returns:

  • (Array<PolicyDefinition>)

    operation results.



863
864
865
866
# File 'lib/2016-12-01/generated/azure_mgmt_policy/policy_definitions.rb', line 863

def list_by_management_group(management_group_id, custom_headers:nil)
  first_page = list_by_management_group_as_lazy(management_group_id, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_by_management_group_as_lazy(management_group_id, custom_headers: nil) ⇒ PolicyDefinitionListResult

Gets all the policy definitions for a subscription at management group level.

will be added to the HTTP request.

the response.

Parameters:

  • management_group_id (String)

    The ID of the management group.

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

    A hash of custom headers that

Returns:

  • (PolicyDefinitionListResult)

    which provide lazy access to pages of



1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
# File 'lib/2016-12-01/generated/azure_mgmt_policy/policy_definitions.rb', line 1263

def list_by_management_group_as_lazy(management_group_id, custom_headers:nil)
  response = list_by_management_group_async(management_group_id, custom_headers:custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_by_management_group_next_async(next_page_link, custom_headers:custom_headers)
    end
    page
  end
end

#list_by_management_group_async(management_group_id, custom_headers: nil) ⇒ Concurrent::Promise

Gets all the policy definitions for a subscription at management group level.

to the HTTP request.

Parameters:

  • management_group_id (String)

    The ID of the management group.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
# File 'lib/2016-12-01/generated/azure_mgmt_policy/policy_definitions.rb', line 890

def list_by_management_group_async(management_group_id, custom_headers:nil)
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, 'management_group_id is nil' if management_group_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 = 'providers/Microsoft.Management/managementgroups/{managementGroupId}/providers/Microsoft.Authorization/policyDefinitions'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'managementGroupId' => management_group_id},
      query_params: {'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::Policy::Mgmt::V2016_12_01::Models::PolicyDefinitionListResult.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_by_management_group_next(next_page_link, custom_headers: nil) ⇒ PolicyDefinitionListResult

Gets all the policy definitions for a subscription at management group level.

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:

  • (PolicyDefinitionListResult)

    operation results.



1133
1134
1135
1136
# File 'lib/2016-12-01/generated/azure_mgmt_policy/policy_definitions.rb', line 1133

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

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

Gets all the policy definitions for a subscription at management group level.

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.



1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
# File 'lib/2016-12-01/generated/azure_mgmt_policy/policy_definitions.rb', line 1162

def list_by_management_group_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::Policy::Mgmt::V2016_12_01::Models::PolicyDefinitionListResult.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_by_management_group_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets all the policy definitions for a subscription at management group level.

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.



1148
1149
1150
# File 'lib/2016-12-01/generated/azure_mgmt_policy/policy_definitions.rb', line 1148

def list_by_management_group_next_with_http_info(next_page_link, custom_headers:nil)
  list_by_management_group_next_async(next_page_link, custom_headers:custom_headers).value!
end

#list_by_management_group_with_http_info(management_group_id, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets all the policy definitions for a subscription at management group level.

will be added to the HTTP request.

Parameters:

  • management_group_id (String)

    The ID of the management group.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



877
878
879
# File 'lib/2016-12-01/generated/azure_mgmt_policy/policy_definitions.rb', line 877

def list_by_management_group_with_http_info(management_group_id, custom_headers:nil)
  list_by_management_group_async(management_group_id, custom_headers:custom_headers).value!
end

#list_next(next_page_link, custom_headers: nil) ⇒ PolicyDefinitionListResult

Gets all the policy definitions 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:

  • (PolicyDefinitionListResult)

    operation results.



953
954
955
956
# File 'lib/2016-12-01/generated/azure_mgmt_policy/policy_definitions.rb', line 953

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 the policy definitions 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.



982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
# File 'lib/2016-12-01/generated/azure_mgmt_policy/policy_definitions.rb', line 982

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::Policy::Mgmt::V2016_12_01::Models::PolicyDefinitionListResult.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 the policy definitions 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.



968
969
970
# File 'lib/2016-12-01/generated/azure_mgmt_policy/policy_definitions.rb', line 968

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

Gets all the policy definitions for a subscription.

will be added to the HTTP request.

Parameters:

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



705
706
707
# File 'lib/2016-12-01/generated/azure_mgmt_policy/policy_definitions.rb', line 705

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