Class: Azure::CDN::Mgmt::V2020_04_15::Policies

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2020-04-15/generated/azure_mgmt_cdn/policies.rb

Overview

Cdn Management Client

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Policies

Creates and initializes a new instance of the Policies class.

Parameters:

  • client —

    service class for accessing basic functionality.



17
18
19
 
# File 'lib/2020-04-15/generated/azure_mgmt_cdn/policies.rb', line 17

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ CdnManagementClient (readonly)

Returns reference to the CdnManagementClient.

Returns:



22
23
24
 
# File 'lib/2020-04-15/generated/azure_mgmt_cdn/policies.rb', line 22

def client
  @client
end

Instance Method Details

#begin_create_or_update(resource_group_name, policy_name, cdn_web_application_firewall_policy, custom_headers: nil) ⇒ CdnWebApplicationFirewallPolicy

Create or update policy with specified rule set name within a resource group.

Azure subscription. Policy to be created. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of the Resource group within the

  • policy_name (String) —

    The name of the CdnWebApplicationFirewallPolicy.

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

    A hash of custom headers that

Returns:

  • (CdnWebApplicationFirewallPolicy) —

    operation results.



423
424
425
426
 
# File 'lib/2020-04-15/generated/azure_mgmt_cdn/policies.rb', line 423

def begin_create_or_update(resource_group_name, policy_name, cdn_web_application_firewall_policy, custom_headers:nil)
  response = begin_create_or_update_async(resource_group_name, policy_name, cdn_web_application_firewall_policy, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#begin_create_or_update_async(resource_group_name, policy_name, cdn_web_application_firewall_policy, custom_headers: nil) ⇒ Concurrent::Promise

Create or update policy with specified rule set name within a resource group.

Azure subscription. Policy to be created. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of the Resource group within the

  • policy_name (String) —

    The name of the CdnWebApplicationFirewallPolicy.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
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/2020-04-15/generated/azure_mgmt_cdn/policies.rb', line 458

def begin_create_or_update_async(resource_group_name, policy_name, cdn_web_application_firewall_policy, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MaxLength': '90'" if !resource_group_name.nil? && resource_group_name.length > 90
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MinLength': '1'" if !resource_group_name.nil? && resource_group_name.length < 1
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'Pattern': '^[-\w\._\(\)]+$'" if !resource_group_name.nil? && resource_group_name.match(Regexp.new('^^[-\w\._\(\)]+$$')).nil?
  fail ArgumentError, 'policy_name is nil' if policy_name.nil?
  fail ArgumentError, "'policy_name' should satisfy the constraint - 'MaxLength': '128'" if !policy_name.nil? && policy_name.length > 128
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, 'cdn_web_application_firewall_policy is nil' if cdn_web_application_firewall_policy.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::CDN::Mgmt::V2020_04_15::Models::CdnWebApplicationFirewallPolicy.mapper()
  request_content = @client.serialize(request_mapper,  cdn_web_application_firewall_policy)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/CdnWebApplicationFirewallPolicies/{policyName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'policyName' => policy_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 == 200 || status_code == 201 || status_code == 202
      error_model = JSON.load(response_content)
      fail MsRest::HttpOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.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::CDN::Mgmt::V2020_04_15::Models::CdnWebApplicationFirewallPolicy.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
    # Deserialize Response
    if status_code == 201
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::CDN::Mgmt::V2020_04_15::Models::CdnWebApplicationFirewallPolicy.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
    # Deserialize Response
    if status_code == 202
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::CDN::Mgmt::V2020_04_15::Models::CdnWebApplicationFirewallPolicy.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

#begin_create_or_update_with_http_info(resource_group_name, policy_name, cdn_web_application_firewall_policy, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Create or update policy with specified rule set name within a resource group.

Azure subscription. Policy to be created. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of the Resource group within the

  • policy_name (String) —

    The name of the CdnWebApplicationFirewallPolicy.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



441
442
443
 
# File 'lib/2020-04-15/generated/azure_mgmt_cdn/policies.rb', line 441

def begin_create_or_update_with_http_info(resource_group_name, policy_name, cdn_web_application_firewall_policy, custom_headers:nil)
  begin_create_or_update_async(resource_group_name, policy_name, cdn_web_application_firewall_policy, custom_headers:custom_headers).value!
end

#begin_update(resource_group_name, policy_name, cdn_web_application_firewall_policy_patch_parameters, custom_headers: nil) ⇒ CdnWebApplicationFirewallPolicy

Update an existing CdnWebApplicationFirewallPolicy with the specified policy name under the specified subscription and resource group

Azure subscription.

CdnWebApplicationFirewallPolicyPatchParameters

CdnWebApplicationFirewallPolicy parameters to be patched. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of the Resource group within the

  • policy_name (String) —

    The name of the CdnWebApplicationFirewallPolicy.

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

    A hash of custom headers that

Returns:

  • (CdnWebApplicationFirewallPolicy) —

    operation results.



560
561
562
563
 
# File 'lib/2020-04-15/generated/azure_mgmt_cdn/policies.rb', line 560

def begin_update(resource_group_name, policy_name, cdn_web_application_firewall_policy_patch_parameters, custom_headers:nil)
  response = begin_update_async(resource_group_name, policy_name, cdn_web_application_firewall_policy_patch_parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#begin_update_async(resource_group_name, policy_name, cdn_web_application_firewall_policy_patch_parameters, custom_headers: nil) ⇒ Concurrent::Promise

Update an existing CdnWebApplicationFirewallPolicy with the specified policy name under the specified subscription and resource group

Azure subscription.

CdnWebApplicationFirewallPolicyPatchParameters

CdnWebApplicationFirewallPolicy parameters to be patched. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of the Resource group within the

  • policy_name (String) —

    The name of the CdnWebApplicationFirewallPolicy.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
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
 
# File 'lib/2020-04-15/generated/azure_mgmt_cdn/policies.rb', line 599

def begin_update_async(resource_group_name, policy_name, cdn_web_application_firewall_policy_patch_parameters, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MaxLength': '90'" if !resource_group_name.nil? && resource_group_name.length > 90
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MinLength': '1'" if !resource_group_name.nil? && resource_group_name.length < 1
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'Pattern': '^[-\w\._\(\)]+$'" if !resource_group_name.nil? && resource_group_name.match(Regexp.new('^^[-\w\._\(\)]+$$')).nil?
  fail ArgumentError, 'policy_name is nil' if policy_name.nil?
  fail ArgumentError, "'policy_name' should satisfy the constraint - 'MaxLength': '128'" if !policy_name.nil? && policy_name.length > 128
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, 'cdn_web_application_firewall_policy_patch_parameters is nil' if cdn_web_application_firewall_policy_patch_parameters.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::CDN::Mgmt::V2020_04_15::Models::CdnWebApplicationFirewallPolicyPatchParameters.mapper()
  request_content = @client.serialize(request_mapper,  cdn_web_application_firewall_policy_patch_parameters)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/CdnWebApplicationFirewallPolicies/{policyName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'policyName' => policy_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(:patch, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200 || status_code == 202
      error_model = JSON.load(response_content)
      fail MsRest::HttpOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.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::CDN::Mgmt::V2020_04_15::Models::CdnWebApplicationFirewallPolicy.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
    # Deserialize Response
    if status_code == 202
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::CDN::Mgmt::V2020_04_15::Models::CdnWebApplicationFirewallPolicy.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

#begin_update_with_http_info(resource_group_name, policy_name, cdn_web_application_firewall_policy_patch_parameters, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Update an existing CdnWebApplicationFirewallPolicy with the specified policy name under the specified subscription and resource group

Azure subscription.

CdnWebApplicationFirewallPolicyPatchParameters

CdnWebApplicationFirewallPolicy parameters to be patched. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of the Resource group within the

  • policy_name (String) —

    The name of the CdnWebApplicationFirewallPolicy.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



580
581
582
 
# File 'lib/2020-04-15/generated/azure_mgmt_cdn/policies.rb', line 580

def begin_update_with_http_info(resource_group_name, policy_name, cdn_web_application_firewall_policy_patch_parameters, custom_headers:nil)
  begin_update_async(resource_group_name, policy_name, cdn_web_application_firewall_policy_patch_parameters, custom_headers:custom_headers).value!
end

#create_or_update(resource_group_name, policy_name, cdn_web_application_firewall_policy, custom_headers: nil) ⇒ CdnWebApplicationFirewallPolicy

Create or update policy with specified rule set name within a resource group.

Azure subscription. Policy to be created. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of the Resource group within the

  • policy_name (String) —

    The name of the CdnWebApplicationFirewallPolicy.

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

    A hash of custom headers that

Returns:

  • (CdnWebApplicationFirewallPolicy) —

    operation results.



234
235
236
237
 
# File 'lib/2020-04-15/generated/azure_mgmt_cdn/policies.rb', line 234

def create_or_update(resource_group_name, policy_name, cdn_web_application_firewall_policy, custom_headers:nil)
  response = create_or_update_async(resource_group_name, policy_name, cdn_web_application_firewall_policy, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#create_or_update_async(resource_group_name, policy_name, cdn_web_application_firewall_policy, custom_headers: nil) ⇒ Concurrent::Promise

Azure subscription. Policy to be created. will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    Name of the Resource group within the

  • policy_name (String) —

    The name of the CdnWebApplicationFirewallPolicy.

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/2020-04-15/generated/azure_mgmt_cdn/policies.rb', line 251

def create_or_update_async(resource_group_name, policy_name, cdn_web_application_firewall_policy, custom_headers:nil)
  # Send request
  promise = begin_create_or_update_async(resource_group_name, policy_name, cdn_web_application_firewall_policy, custom_headers:custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
      result_mapper = Azure::CDN::Mgmt::V2020_04_15::Models::CdnWebApplicationFirewallPolicy.mapper()
      parsed_response = @client.deserialize(result_mapper, parsed_response)
    end

    # Waiting for response.
    @client.get_long_running_operation_result(response, deserialize_method)
  end

  promise
end

#delete(resource_group_name, policy_name, custom_headers: nil) ⇒ Object

Deletes Policy

Azure subscription. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of the Resource group within the

  • policy_name (String) —

    The name of the CdnWebApplicationFirewallPolicy.

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

    A hash of custom headers that



330
331
332
333
 
# File 'lib/2020-04-15/generated/azure_mgmt_cdn/policies.rb', line 330

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

#delete_async(resource_group_name, policy_name, custom_headers: nil) ⇒ Concurrent::Promise

Deletes Policy

Azure subscription. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of the Resource group within the

  • policy_name (String) —

    The name of the CdnWebApplicationFirewallPolicy.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
395
396
397
398
399
400
401
402
403
404
405
406
407
408
 
# File 'lib/2020-04-15/generated/azure_mgmt_cdn/policies.rb', line 361

def delete_async(resource_group_name, policy_name, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MaxLength': '90'" if !resource_group_name.nil? && resource_group_name.length > 90
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MinLength': '1'" if !resource_group_name.nil? && resource_group_name.length < 1
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'Pattern': '^[-\w\._\(\)]+$'" if !resource_group_name.nil? && resource_group_name.match(Regexp.new('^^[-\w\._\(\)]+$$')).nil?
  fail ArgumentError, 'policy_name is nil' if policy_name.nil?
  fail ArgumentError, "'policy_name' should satisfy the constraint - 'MaxLength': '128'" if !policy_name.nil? && policy_name.length > 128
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?


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

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/CdnWebApplicationFirewallPolicies/{policyName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'policyName' => policy_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 == 200 || status_code == 204
      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_with_http_info(resource_group_name, policy_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Deletes Policy

Azure subscription. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of the Resource group within the

  • policy_name (String) —

    The name of the CdnWebApplicationFirewallPolicy.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



346
347
348
 
# File 'lib/2020-04-15/generated/azure_mgmt_cdn/policies.rb', line 346

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

#get(resource_group_name, policy_name, custom_headers: nil) ⇒ CdnWebApplicationFirewallPolicy

Retrieve protection policy with specified name within a resource group.

Azure subscription. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of the Resource group within the

  • policy_name (String) —

    The name of the CdnWebApplicationFirewallPolicy.

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

    A hash of custom headers that

Returns:

  • (CdnWebApplicationFirewallPolicy) —

    operation results.



131
132
133
134
 
# File 'lib/2020-04-15/generated/azure_mgmt_cdn/policies.rb', line 131

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

#get_async(resource_group_name, policy_name, custom_headers: nil) ⇒ Concurrent::Promise

Retrieve protection policy with specified name within a resource group.

Azure subscription. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of the Resource group within the

  • policy_name (String) —

    The name of the CdnWebApplicationFirewallPolicy.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



162
163
164
165
166
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
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/2020-04-15/generated/azure_mgmt_cdn/policies.rb', line 162

def get_async(resource_group_name, policy_name, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MaxLength': '90'" if !resource_group_name.nil? && resource_group_name.length > 90
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MinLength': '1'" if !resource_group_name.nil? && resource_group_name.length < 1
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'Pattern': '^[-\w\._\(\)]+$'" if !resource_group_name.nil? && resource_group_name.match(Regexp.new('^^[-\w\._\(\)]+$$')).nil?
  fail ArgumentError, 'policy_name is nil' if policy_name.nil?
  fail ArgumentError, "'policy_name' should satisfy the constraint - 'MaxLength': '128'" if !policy_name.nil? && policy_name.length > 128
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?


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

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/CdnWebApplicationFirewallPolicies/{policyName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'policyName' => policy_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 MsRest::HttpOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.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::CDN::Mgmt::V2020_04_15::Models::CdnWebApplicationFirewallPolicy.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#get_with_http_info(resource_group_name, policy_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Retrieve protection policy with specified name within a resource group.

Azure subscription. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of the Resource group within the

  • policy_name (String) —

    The name of the CdnWebApplicationFirewallPolicy.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



147
148
149
 
# File 'lib/2020-04-15/generated/azure_mgmt_cdn/policies.rb', line 147

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

#list(resource_group_name, custom_headers: nil) ⇒ Array<CdnWebApplicationFirewallPolicy>

Lists all of the protection policies within a resource group.

Azure subscription. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of the Resource group within the

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

    A hash of custom headers that

Returns:

  • (Array<CdnWebApplicationFirewallPolicy>) —

    operation results.



34
35
36
37
 
# File 'lib/2020-04-15/generated/azure_mgmt_cdn/policies.rb', line 34

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

#list_as_lazy(resource_group_name, custom_headers: nil) ⇒ CdnWebApplicationFirewallPolicyList

Lists all of the protection policies within a resource group.

Azure subscription. will be added to the HTTP request.

pages of the response.

Parameters:

  • resource_group_name (String) —

    Name of the Resource group within the

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

    A hash of custom headers that

Returns:

  • (CdnWebApplicationFirewallPolicyList) —

    which provide lazy access to



777
778
779
780
781
782
783
784
785
786
 
# File 'lib/2020-04-15/generated/azure_mgmt_cdn/policies.rb', line 777

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

Lists all of the protection policies within a resource group.

Azure subscription. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of the Resource group within the

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



63
64
65
66
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
 
# File 'lib/2020-04-15/generated/azure_mgmt_cdn/policies.rb', line 63

def list_async(resource_group_name, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MaxLength': '90'" if !resource_group_name.nil? && resource_group_name.length > 90
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MinLength': '1'" if !resource_group_name.nil? && resource_group_name.length < 1
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'Pattern': '^[-\w\._\(\)]+$'" if !resource_group_name.nil? && resource_group_name.match(Regexp.new('^^[-\w\._\(\)]+$$')).nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?


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

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/CdnWebApplicationFirewallPolicies'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_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 MsRest::HttpOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.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::CDN::Mgmt::V2020_04_15::Models::CdnWebApplicationFirewallPolicyList.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#list_next(next_page_link, custom_headers: nil) ⇒ CdnWebApplicationFirewallPolicyList

Lists all of the protection policies within a resource 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:

  • (CdnWebApplicationFirewallPolicyList) —

    operation results.



686
687
688
689
 
# File 'lib/2020-04-15/generated/azure_mgmt_cdn/policies.rb', line 686

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

Lists all of the protection policies within a resource 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.



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
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
 
# File 'lib/2020-04-15/generated/azure_mgmt_cdn/policies.rb', line 715

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


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

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

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      skip_encoding_path_params: {'nextLink' => next_page_link},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:get, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail MsRest::HttpOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    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::CDN::Mgmt::V2020_04_15::Models::CdnWebApplicationFirewallPolicyList.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

Lists all of the protection policies within a resource 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.



701
702
703
 
# File 'lib/2020-04-15/generated/azure_mgmt_cdn/policies.rb', line 701

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

Lists all of the protection policies within a resource group.

Azure subscription. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of the Resource group within the

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



49
50
51
 
# File 'lib/2020-04-15/generated/azure_mgmt_cdn/policies.rb', line 49

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

#update(resource_group_name, policy_name, cdn_web_application_firewall_policy_patch_parameters, custom_headers: nil) ⇒ CdnWebApplicationFirewallPolicy

Update an existing CdnWebApplicationFirewallPolicy with the specified policy name under the specified subscription and resource group

Azure subscription.

CdnWebApplicationFirewallPolicyPatchParameters

CdnWebApplicationFirewallPolicy parameters to be patched. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of the Resource group within the

  • policy_name (String) —

    The name of the CdnWebApplicationFirewallPolicy.

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

    A hash of custom headers that

Returns:

  • (CdnWebApplicationFirewallPolicy) —

    operation results.



284
285
286
287
 
# File 'lib/2020-04-15/generated/azure_mgmt_cdn/policies.rb', line 284

def update(resource_group_name, policy_name, cdn_web_application_firewall_policy_patch_parameters, custom_headers:nil)
  response = update_async(resource_group_name, policy_name, cdn_web_application_firewall_policy_patch_parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#update_async(resource_group_name, policy_name, cdn_web_application_firewall_policy_patch_parameters, custom_headers: nil) ⇒ Concurrent::Promise

Azure subscription.

CdnWebApplicationFirewallPolicyPatchParameters

CdnWebApplicationFirewallPolicy parameters to be patched. will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    Name of the Resource group within the

  • policy_name (String) —

    The name of the CdnWebApplicationFirewallPolicy.

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
 
# File 'lib/2020-04-15/generated/azure_mgmt_cdn/policies.rb', line 302

def update_async(resource_group_name, policy_name, cdn_web_application_firewall_policy_patch_parameters, custom_headers:nil)
  # Send request
  promise = begin_update_async(resource_group_name, policy_name, cdn_web_application_firewall_policy_patch_parameters, custom_headers:custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
      result_mapper = Azure::CDN::Mgmt::V2020_04_15::Models::CdnWebApplicationFirewallPolicy.mapper()
      parsed_response = @client.deserialize(result_mapper, parsed_response)
    end

    # Waiting for response.
    @client.get_long_running_operation_result(response, deserialize_method)
  end

  promise
end