Class: Azure::Policy::Mgmt::V2019_01_01::PolicyDefinitions

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2019-01-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/2019-01-01/generated/azure_mgmt_policy/policy_definitions.rb', line 18

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ PolicyClient (readonly)

Returns reference to the PolicyClient.

Returns:



23
24
25
 
# File 'lib/2019-01-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 in a subscription.

This operation creates or updates a policy definition in the given subscription with the given name.

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.



39
40
41
42
 
# File 'lib/2019-01-01/generated/azure_mgmt_policy/policy_definitions.rb', line 39

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 in a subscription.

This operation creates or updates a policy definition in the given subscription with the given name.

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.



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
128
129
130
131
132
133
134
135
136
 
# File 'lib/2019-01-01/generated/azure_mgmt_policy/policy_definitions.rb', line 76

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::V2019_01_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::V2019_01_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 in a management group.

This operation creates or updates a policy definition in the given management group with the given name.

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.



444
445
446
447
 
# File 'lib/2019-01-01/generated/azure_mgmt_policy/policy_definitions.rb', line 444

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 in a management group.

This operation creates or updates a policy definition in the given management group with the given name.

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.



483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
 
# File 'lib/2019-01-01/generated/azure_mgmt_policy/policy_definitions.rb', line 483

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::V2019_01_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::V2019_01_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 in a management group.

This operation creates or updates a policy definition in the given management group with the given name.

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.



464
465
466
 
# File 'lib/2019-01-01/generated/azure_mgmt_policy/policy_definitions.rb', line 464

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 in a subscription.

This operation creates or updates a policy definition in the given subscription with the given name.

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.



58
59
60
 
# File 'lib/2019-01-01/generated/azure_mgmt_policy/policy_definitions.rb', line 58

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 in a subscription.

This operation deletes the policy definition in the given subscription with the given name.

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



150
151
152
153
 
# File 'lib/2019-01-01/generated/azure_mgmt_policy/policy_definitions.rb', line 150

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 in a subscription.

This operation deletes the policy definition in the given subscription with the given name.

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.



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

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 in a management group.

This operation deletes the policy definition in the given management group with the given name.

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



558
559
560
561
 
# File 'lib/2019-01-01/generated/azure_mgmt_policy/policy_definitions.rb', line 558

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 in a management group.

This operation deletes the policy definition in the given management group with the given name.

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.



595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
 
# File 'lib/2019-01-01/generated/azure_mgmt_policy/policy_definitions.rb', line 595

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 in a management group.

This operation deletes the policy definition in the given management group with the given name.

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.



577
578
579
 
# File 'lib/2019-01-01/generated/azure_mgmt_policy/policy_definitions.rb', line 577

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 in a subscription.

This operation deletes the policy definition in the given subscription with the given name.

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.



168
169
170
 
# File 'lib/2019-01-01/generated/azure_mgmt_policy/policy_definitions.rb', line 168

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

Retrieves a policy definition in a subscription.

This operation retrieves the policy definition in the given subscription with the given name.

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.



242
243
244
245
 
# File 'lib/2019-01-01/generated/azure_mgmt_policy/policy_definitions.rb', line 242

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

Retrieves a policy definition in a subscription.

This operation retrieves the policy definition in the given subscription with the given name.

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.



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
323
324
325
326
327
328
329
 
# File 'lib/2019-01-01/generated/azure_mgmt_policy/policy_definitions.rb', line 277

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::V2019_01_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

Retrieve a policy definition in a management group.

This operation retrieves the policy definition in the given management group with the given name.

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.



653
654
655
656
 
# File 'lib/2019-01-01/generated/azure_mgmt_policy/policy_definitions.rb', line 653

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

Retrieve a policy definition in a management group.

This operation retrieves the policy definition in the given management group with the given name.

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.



690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
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
 
# File 'lib/2019-01-01/generated/azure_mgmt_policy/policy_definitions.rb', line 690

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::V2019_01_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

Retrieve a policy definition in a management group.

This operation retrieves the policy definition in the given management group with the given name.

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.



672
673
674
 
# File 'lib/2019-01-01/generated/azure_mgmt_policy/policy_definitions.rb', line 672

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

Retrieves a built-in policy definition.

This operation retrieves the built-in policy definition with the given name.

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.



343
344
345
346
 
# File 'lib/2019-01-01/generated/azure_mgmt_policy/policy_definitions.rb', line 343

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

Retrieves a built-in policy definition.

This operation retrieves the built-in policy definition with the given name.

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.



376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
 
# File 'lib/2019-01-01/generated/azure_mgmt_policy/policy_definitions.rb', line 376

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::V2019_01_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

Retrieves a built-in policy definition.

This operation retrieves the built-in policy definition with the given name.

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.



360
361
362
 
# File 'lib/2019-01-01/generated/azure_mgmt_policy/policy_definitions.rb', line 360

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

Retrieves a policy definition in a subscription.

This operation retrieves the policy definition in the given subscription with the given name.

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.



260
261
262
 
# File 'lib/2019-01-01/generated/azure_mgmt_policy/policy_definitions.rb', line 260

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>

Retrieves policy definitions in a subscription

This operation retrieves a list of all the policy definitions in a given 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.



755
756
757
758
 
# File 'lib/2019-01-01/generated/azure_mgmt_policy/policy_definitions.rb', line 755

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

Retrieves policy definitions in a subscription

This operation retrieves a list of all the policy definitions in a given 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



1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
 
# File 'lib/2019-01-01/generated/azure_mgmt_policy/policy_definitions.rb', line 1333

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

Retrieves policy definitions in a subscription

This operation retrieves a list of all the policy definitions in a given 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.



786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
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
 
# File 'lib/2019-01-01/generated/azure_mgmt_policy/policy_definitions.rb', line 786

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::V2019_01_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>

Retrieve built-in policy definitions

This operation retrieves a list of 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.



849
850
851
852
 
# File 'lib/2019-01-01/generated/azure_mgmt_policy/policy_definitions.rb', line 849

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

Retrieve built-in policy definitions

This operation retrieves a list of 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



1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
 
# File 'lib/2019-01-01/generated/azure_mgmt_policy/policy_definitions.rb', line 1355

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

Retrieve built-in policy definitions

This operation retrieves a list of 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.



878
879
880
881
882
883
884
885
886
887
888
889
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
 
# File 'lib/2019-01-01/generated/azure_mgmt_policy/policy_definitions.rb', line 878

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::V2019_01_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

Retrieve built-in policy definitions

This operation retrieves a list of 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.



1138
1139
1140
1141
 
# File 'lib/2019-01-01/generated/azure_mgmt_policy/policy_definitions.rb', line 1138

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

Retrieve built-in policy definitions

This operation retrieves a list of 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.



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
1212
1213
1214
1215
1216
1217
1218
1219
1220
 
# File 'lib/2019-01-01/generated/azure_mgmt_policy/policy_definitions.rb', line 1171

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::V2019_01_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

Retrieve built-in policy definitions

This operation retrieves a list of 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.



1155
1156
1157
 
# File 'lib/2019-01-01/generated/azure_mgmt_policy/policy_definitions.rb', line 1155

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

Retrieve built-in policy definitions

This operation retrieves a list of 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.



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

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>

Retrieve policy definitions in a management group

This operation retrieves a list of all the policy definitions in a given management group.

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.



941
942
943
944
 
# File 'lib/2019-01-01/generated/azure_mgmt_policy/policy_definitions.rb', line 941

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

Retrieve policy definitions in a management group

This operation retrieves a list of all the policy definitions in a given management group.

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



1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
 
# File 'lib/2019-01-01/generated/azure_mgmt_policy/policy_definitions.rb', line 1379

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

Retrieve policy definitions in a management group

This operation retrieves a list of all the policy definitions in a given management group.

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.



974
975
976
977
978
979
980
981
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
 
# File 'lib/2019-01-01/generated/azure_mgmt_policy/policy_definitions.rb', line 974

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::V2019_01_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

Retrieve policy definitions in a management group

This operation retrieves a list of all the policy definitions in a given management group.

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.



1235
1236
1237
1238
 
# File 'lib/2019-01-01/generated/azure_mgmt_policy/policy_definitions.rb', line 1235

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

Retrieve policy definitions in a management group

This operation retrieves a list of all the policy definitions in a given management group.

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.



1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
 
# File 'lib/2019-01-01/generated/azure_mgmt_policy/policy_definitions.rb', line 1270

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::V2019_01_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

Retrieve policy definitions in a management group

This operation retrieves a list of all the policy definitions in a given management group.

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.



1253
1254
1255
 
# File 'lib/2019-01-01/generated/azure_mgmt_policy/policy_definitions.rb', line 1253

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

Retrieve policy definitions in a management group

This operation retrieves a list of all the policy definitions in a given management group.

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.



958
959
960
 
# File 'lib/2019-01-01/generated/azure_mgmt_policy/policy_definitions.rb', line 958

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

Retrieves policy definitions in a subscription

This operation retrieves a list of all the policy definitions in a given 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.



1040
1041
1042
1043
 
# File 'lib/2019-01-01/generated/azure_mgmt_policy/policy_definitions.rb', line 1040

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

Retrieves policy definitions in a subscription

This operation retrieves a list of all the policy definitions in a given 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.



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
1122
1123
1124
 
# File 'lib/2019-01-01/generated/azure_mgmt_policy/policy_definitions.rb', line 1075

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::V2019_01_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

Retrieves policy definitions in a subscription

This operation retrieves a list of all the policy definitions in a given 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.



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

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

Retrieves policy definitions in a subscription

This operation retrieves a list of all the policy definitions in a given 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.



771
772
773
 
# File 'lib/2019-01-01/generated/azure_mgmt_policy/policy_definitions.rb', line 771

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