Class: Azure::ARM::Policy::PolicyDefinitions

Inherits:
Object
  • Object
show all
Includes:
Models, MsRestAzure
Defined in:
lib/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.



19
20
21
 
# File 'lib/generated/azure_mgmt_policy/policy_definitions.rb', line 19

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ PolicyClient (readonly)

Returns reference to the PolicyClient.

Returns:



24
25
26
 
# File 'lib/generated/azure_mgmt_policy/policy_definitions.rb', line 24

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:



37
38
39
40
 
# File 'lib/generated/azure_mgmt_policy/policy_definitions.rb', line 37

def create_or_update(policy_definition_name, parameters, custom_headers = nil)
  response = create_or_update_async(policy_definition_name, parameters, 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.



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/generated/azure_mgmt_policy/policy_definitions.rb', line 68

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 = {}

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?

  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Serialize Request
  request_mapper = PolicyDefinition.mapper()
  request_content = @client.serialize(request_mapper,  parameters, '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?
    # Deserialize Response
    if status_code == 201
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = PolicyDefinition.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response, 'result.body')
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

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



53
54
55
 
# File 'lib/generated/azure_mgmt_policy/policy_definitions.rb', line 53

def create_or_update_with_http_info(policy_definition_name, parameters, custom_headers = nil)
  create_or_update_async(policy_definition_name, parameters, 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/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).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
 
# File 'lib/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 = {}

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

  promise.execute
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/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).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:



218
219
220
221
 
# File 'lib/generated/azure_mgmt_policy/policy_definitions.rb', line 218

def get(policy_definition_name, custom_headers = nil)
  response = get_async(policy_definition_name, 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.



247
248
249
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
 
# File 'lib/generated/azure_mgmt_policy/policy_definitions.rb', line 247

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 = {}

  # 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?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = PolicyDefinition.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response, 'result.body')
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

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



233
234
235
 
# File 'lib/generated/azure_mgmt_policy/policy_definitions.rb', line 233

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

#list(filter = nil, custom_headers = nil) ⇒ Array<PolicyDefinition>

Gets all the policy definitions for a subscription.

will be added to the HTTP request.

Parameters:

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

    The filter to apply on the operation.

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

    A hash of custom headers that

Returns:



307
308
309
310
 
# File 'lib/generated/azure_mgmt_policy/policy_definitions.rb', line 307

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

#list_as_lazy(filter = nil, custom_headers = nil) ⇒ PolicyDefinitionListResult

Gets all the policy definitions for a subscription.

will be added to the HTTP request.

the response.

Parameters:

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

    The filter to apply on the operation.

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

    A hash of custom headers that

Returns:



481
482
483
484
485
486
487
488
489
490
 
# File 'lib/generated/azure_mgmt_policy/policy_definitions.rb', line 481

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

#list_async(filter = nil, custom_headers = nil) ⇒ Concurrent::Promise

Gets all the policy definitions for a subscription.

to the HTTP request.

Parameters:

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

    The filter to apply on the operation.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
 
# File 'lib/generated/azure_mgmt_policy/policy_definitions.rb', line 334

def list_async(filter = nil, 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 = {}

  # 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: {'$filter' => filter,'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?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = PolicyDefinitionListResult.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response, 'result.body')
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#list_next(next_page_link, custom_headers = nil) ⇒ 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:



394
395
396
397
 
# File 'lib/generated/azure_mgmt_policy/policy_definitions.rb', line 394

def list_next(next_page_link, custom_headers = nil)
  response = list_next_async(next_page_link, 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.



423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
 
# File 'lib/generated/azure_mgmt_policy/policy_definitions.rb', line 423

def list_next_async(next_page_link, custom_headers = nil)
  fail ArgumentError, 'next_page_link is nil' if next_page_link.nil?


  request_headers = {}

  # 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?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = PolicyDefinitionListResult.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response, 'result.body')
      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.



409
410
411
 
# File 'lib/generated/azure_mgmt_policy/policy_definitions.rb', line 409

def list_next_with_http_info(next_page_link, custom_headers = nil)
  list_next_async(next_page_link, custom_headers).value!
end

#list_with_http_info(filter = nil, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Gets all the policy definitions for a subscription.

will be added to the HTTP request.

Parameters:

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

    The filter to apply on the operation.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



321
322
323
 
# File 'lib/generated/azure_mgmt_policy/policy_definitions.rb', line 321

def list_with_http_info(filter = nil, custom_headers = nil)
  list_async(filter, custom_headers).value!
end