Class: Azure::NetApp::Mgmt::V2020_11_01::Backups

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2020-11-01/generated/azure_mgmt_netapp/backups.rb

Overview

Microsoft NetApp Files Azure Resource Provider specification

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Backups

Creates and initializes a new instance of the Backups class.

Parameters:

  • client —

    service class for accessing basic functionality.



17
18
19
 
# File 'lib/2020-11-01/generated/azure_mgmt_netapp/backups.rb', line 17

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ AzureNetAppFilesManagementClient (readonly)

Returns reference to the AzureNetAppFilesManagementClient.

Returns:



22
23
24
 
# File 'lib/2020-11-01/generated/azure_mgmt_netapp/backups.rb', line 22

def client
  @client
end

Instance Method Details

#begin_create(resource_group_name, account_name, pool_name, volume_name, backup_name, body, custom_headers: nil) ⇒ Backup

Create a backup

Create a backup for the volume

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • account_name (String) —

    The name of the NetApp account

  • pool_name (String) —

    The name of the capacity pool

  • volume_name (String) —

    The name of the volume

  • backup_name (String) —

    The name of the backup

  • body (Backup) —

    Backup object supplied in the body of the operation.

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

    A hash of custom headers that

Returns:

  • (Backup) —

    operation results.



430
431
432
433
 
# File 'lib/2020-11-01/generated/azure_mgmt_netapp/backups.rb', line 430

def begin_create(resource_group_name, , pool_name, volume_name, backup_name, body, custom_headers:nil)
  response = begin_create_async(resource_group_name, , pool_name, volume_name, backup_name, body, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#begin_create_async(resource_group_name, account_name, pool_name, volume_name, backup_name, body, custom_headers: nil) ⇒ Concurrent::Promise

Create a backup

Create a backup for the volume

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • account_name (String) —

    The name of the NetApp account

  • pool_name (String) —

    The name of the capacity pool

  • volume_name (String) —

    The name of the volume

  • backup_name (String) —

    The name of the backup

  • body (Backup) —

    Backup object supplied in the body of the operation.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
544
545
546
547
548
549
550
551
552
553
554
 
# File 'lib/2020-11-01/generated/azure_mgmt_netapp/backups.rb', line 471

def begin_create_async(resource_group_name, , pool_name, volume_name, backup_name, body, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.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, 'account_name is nil' if .nil?
  fail ArgumentError, 'pool_name is nil' if pool_name.nil?
  fail ArgumentError, "'pool_name' should satisfy the constraint - 'MaxLength': '64'" if !pool_name.nil? && pool_name.length > 64
  fail ArgumentError, "'pool_name' should satisfy the constraint - 'MinLength': '1'" if !pool_name.nil? && pool_name.length < 1
  fail ArgumentError, "'pool_name' should satisfy the constraint - 'Pattern': '^[a-zA-Z0-9][a-zA-Z0-9\-_]{0,63}$'" if !pool_name.nil? && pool_name.match(Regexp.new('^^[a-zA-Z0-9][a-zA-Z0-9\-_]{0,63}$$')).nil?
  fail ArgumentError, 'volume_name is nil' if volume_name.nil?
  fail ArgumentError, "'volume_name' should satisfy the constraint - 'MaxLength': '64'" if !volume_name.nil? && volume_name.length > 64
  fail ArgumentError, "'volume_name' should satisfy the constraint - 'MinLength': '1'" if !volume_name.nil? && volume_name.length < 1
  fail ArgumentError, "'volume_name' should satisfy the constraint - 'Pattern': '^[a-zA-Z][a-zA-Z0-9\-_]{0,63}$'" if !volume_name.nil? && volume_name.match(Regexp.new('^^[a-zA-Z][a-zA-Z0-9\-_]{0,63}$$')).nil?
  fail ArgumentError, 'backup_name is nil' if backup_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, 'body is nil' if body.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::NetApp::Mgmt::V2020_11_01::Models::Backup.mapper()
  request_content = @client.serialize(request_mapper,  body)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/backups/{backupName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'accountName' => ,'poolName' => pool_name,'volumeName' => volume_name,'backupName' => backup_name},
      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 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::NetApp::Mgmt::V2020_11_01::Models::Backup.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::NetApp::Mgmt::V2020_11_01::Models::Backup.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_with_http_info(resource_group_name, account_name, pool_name, volume_name, backup_name, body, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Create a backup

Create a backup for the volume

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • account_name (String) —

    The name of the NetApp account

  • pool_name (String) —

    The name of the capacity pool

  • volume_name (String) —

    The name of the volume

  • backup_name (String) —

    The name of the backup

  • body (Backup) —

    Backup object supplied in the body of the operation.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



451
452
453
 
# File 'lib/2020-11-01/generated/azure_mgmt_netapp/backups.rb', line 451

def begin_create_with_http_info(resource_group_name, , pool_name, volume_name, backup_name, body, custom_headers:nil)
  begin_create_async(resource_group_name, , pool_name, volume_name, backup_name, body, custom_headers:custom_headers).value!
end

#begin_delete(resource_group_name, account_name, pool_name, volume_name, backup_name, custom_headers: nil) ⇒ Object

Delete backup

Delete a backup of the volume

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • account_name (String) —

    The name of the NetApp account

  • pool_name (String) —

    The name of the capacity pool

  • volume_name (String) —

    The name of the volume

  • backup_name (String) —

    The name of the backup

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

    A hash of custom headers that



714
715
716
717
 
# File 'lib/2020-11-01/generated/azure_mgmt_netapp/backups.rb', line 714

def begin_delete(resource_group_name, , pool_name, volume_name, backup_name, custom_headers:nil)
  response = begin_delete_async(resource_group_name, , pool_name, volume_name, backup_name, custom_headers:custom_headers).value!
  nil
end

#begin_delete_async(resource_group_name, account_name, pool_name, volume_name, backup_name, custom_headers: nil) ⇒ Concurrent::Promise

Delete backup

Delete a backup of the volume

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • account_name (String) —

    The name of the NetApp account

  • pool_name (String) —

    The name of the capacity pool

  • volume_name (String) —

    The name of the volume

  • backup_name (String) —

    The name of the backup

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
 
# File 'lib/2020-11-01/generated/azure_mgmt_netapp/backups.rb', line 753

def begin_delete_async(resource_group_name, , pool_name, volume_name, backup_name, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.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, 'account_name is nil' if .nil?
  fail ArgumentError, 'pool_name is nil' if pool_name.nil?
  fail ArgumentError, "'pool_name' should satisfy the constraint - 'MaxLength': '64'" if !pool_name.nil? && pool_name.length > 64
  fail ArgumentError, "'pool_name' should satisfy the constraint - 'MinLength': '1'" if !pool_name.nil? && pool_name.length < 1
  fail ArgumentError, "'pool_name' should satisfy the constraint - 'Pattern': '^[a-zA-Z0-9][a-zA-Z0-9\-_]{0,63}$'" if !pool_name.nil? && pool_name.match(Regexp.new('^^[a-zA-Z0-9][a-zA-Z0-9\-_]{0,63}$$')).nil?
  fail ArgumentError, 'volume_name is nil' if volume_name.nil?
  fail ArgumentError, "'volume_name' should satisfy the constraint - 'MaxLength': '64'" if !volume_name.nil? && volume_name.length > 64
  fail ArgumentError, "'volume_name' should satisfy the constraint - 'MinLength': '1'" if !volume_name.nil? && volume_name.length < 1
  fail ArgumentError, "'volume_name' should satisfy the constraint - 'Pattern': '^[a-zA-Z][a-zA-Z0-9\-_]{0,63}$'" if !volume_name.nil? && volume_name.match(Regexp.new('^^[a-zA-Z][a-zA-Z0-9\-_]{0,63}$$')).nil?
  fail ArgumentError, 'backup_name is nil' if backup_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 = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/backups/{backupName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'accountName' => ,'poolName' => pool_name,'volumeName' => volume_name,'backupName' => backup_name},
      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 == 202 || 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

#begin_delete_with_http_info(resource_group_name, account_name, pool_name, volume_name, backup_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Delete backup

Delete a backup of the volume

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • account_name (String) —

    The name of the NetApp account

  • pool_name (String) —

    The name of the capacity pool

  • volume_name (String) —

    The name of the volume

  • backup_name (String) —

    The name of the backup

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



734
735
736
 
# File 'lib/2020-11-01/generated/azure_mgmt_netapp/backups.rb', line 734

def begin_delete_with_http_info(resource_group_name, , pool_name, volume_name, backup_name, custom_headers:nil)
  begin_delete_async(resource_group_name, , pool_name, volume_name, backup_name, custom_headers:custom_headers).value!
end

#begin_update(resource_group_name, account_name, pool_name, volume_name, backup_name, body: nil, custom_headers: nil) ⇒ Backup

Patch a backup

Patch a backup for the volume

operation. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • account_name (String) —

    The name of the NetApp account

  • pool_name (String) —

    The name of the capacity pool

  • volume_name (String) —

    The name of the volume

  • backup_name (String) —

    The name of the backup

  • body (BackupPatch) (defaults to: nil) —

    Backup object supplied in the body of the

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

    A hash of custom headers that

Returns:

  • (Backup) —

    operation results.



573
574
575
576
 
# File 'lib/2020-11-01/generated/azure_mgmt_netapp/backups.rb', line 573

def begin_update(resource_group_name, , pool_name, volume_name, backup_name, body:nil, custom_headers:nil)
  response = begin_update_async(resource_group_name, , pool_name, volume_name, backup_name, body:body, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#begin_update_async(resource_group_name, account_name, pool_name, volume_name, backup_name, body: nil, custom_headers: nil) ⇒ Concurrent::Promise

Patch a backup

Patch a backup for the volume

operation. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • account_name (String) —

    The name of the NetApp account

  • pool_name (String) —

    The name of the capacity pool

  • volume_name (String) —

    The name of the volume

  • backup_name (String) —

    The name of the backup

  • body (BackupPatch) (defaults to: nil) —

    Backup object supplied in the body of the

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
 
# File 'lib/2020-11-01/generated/azure_mgmt_netapp/backups.rb', line 616

def begin_update_async(resource_group_name, , pool_name, volume_name, backup_name, body:nil, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.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, 'account_name is nil' if .nil?
  fail ArgumentError, 'pool_name is nil' if pool_name.nil?
  fail ArgumentError, "'pool_name' should satisfy the constraint - 'MaxLength': '64'" if !pool_name.nil? && pool_name.length > 64
  fail ArgumentError, "'pool_name' should satisfy the constraint - 'MinLength': '1'" if !pool_name.nil? && pool_name.length < 1
  fail ArgumentError, "'pool_name' should satisfy the constraint - 'Pattern': '^[a-zA-Z0-9][a-zA-Z0-9\-_]{0,63}$'" if !pool_name.nil? && pool_name.match(Regexp.new('^^[a-zA-Z0-9][a-zA-Z0-9\-_]{0,63}$$')).nil?
  fail ArgumentError, 'volume_name is nil' if volume_name.nil?
  fail ArgumentError, "'volume_name' should satisfy the constraint - 'MaxLength': '64'" if !volume_name.nil? && volume_name.length > 64
  fail ArgumentError, "'volume_name' should satisfy the constraint - 'MinLength': '1'" if !volume_name.nil? && volume_name.length < 1
  fail ArgumentError, "'volume_name' should satisfy the constraint - 'Pattern': '^[a-zA-Z][a-zA-Z0-9\-_]{0,63}$'" if !volume_name.nil? && volume_name.match(Regexp.new('^^[a-zA-Z][a-zA-Z0-9\-_]{0,63}$$')).nil?
  fail ArgumentError, 'backup_name is nil' if backup_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?

  # Serialize Request
  request_mapper = Azure::NetApp::Mgmt::V2020_11_01::Models::BackupPatch.mapper()
  request_content = @client.serialize(request_mapper,  body)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/backups/{backupName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'accountName' => ,'poolName' => pool_name,'volumeName' => volume_name,'backupName' => backup_name},
      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 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::NetApp::Mgmt::V2020_11_01::Models::Backup.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::NetApp::Mgmt::V2020_11_01::Models::Backup.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, account_name, pool_name, volume_name, backup_name, body: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Patch a backup

Patch a backup for the volume

operation. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • account_name (String) —

    The name of the NetApp account

  • pool_name (String) —

    The name of the capacity pool

  • volume_name (String) —

    The name of the volume

  • backup_name (String) —

    The name of the backup

  • body (BackupPatch) (defaults to: nil) —

    Backup object supplied in the body of the

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



595
596
597
 
# File 'lib/2020-11-01/generated/azure_mgmt_netapp/backups.rb', line 595

def begin_update_with_http_info(resource_group_name, , pool_name, volume_name, backup_name, body:nil, custom_headers:nil)
  begin_update_async(resource_group_name, , pool_name, volume_name, backup_name, body:body, custom_headers:custom_headers).value!
end

#create(resource_group_name, account_name, pool_name, volume_name, backup_name, body, custom_headers: nil) ⇒ Backup

Create a backup

Create a backup for the volume

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • account_name (String) —

    The name of the NetApp account

  • pool_name (String) —

    The name of the capacity pool

  • volume_name (String) —

    The name of the volume

  • backup_name (String) —

    The name of the backup

  • body (Backup) —

    Backup object supplied in the body of the operation.

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

    A hash of custom headers that

Returns:

  • (Backup) —

    operation results.



278
279
280
281
 
# File 'lib/2020-11-01/generated/azure_mgmt_netapp/backups.rb', line 278

def create(resource_group_name, , pool_name, volume_name, backup_name, body, custom_headers:nil)
  response = create_async(resource_group_name, , pool_name, volume_name, backup_name, body, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#create_async(resource_group_name, account_name, pool_name, volume_name, backup_name, body, custom_headers: nil) ⇒ Concurrent::Promise

will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • account_name (String) —

    The name of the NetApp account

  • pool_name (String) —

    The name of the capacity pool

  • volume_name (String) —

    The name of the volume

  • backup_name (String) —

    The name of the backup

  • body (Backup) —

    Backup object supplied in the body of the operation.

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/2020-11-01/generated/azure_mgmt_netapp/backups.rb', line 296

def create_async(resource_group_name, , pool_name, volume_name, backup_name, body, custom_headers:nil)
  # Send request
  promise = begin_create_async(resource_group_name, , pool_name, volume_name, backup_name, body, custom_headers:custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
      result_mapper = Azure::NetApp::Mgmt::V2020_11_01::Models::Backup.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, account_name, pool_name, volume_name, backup_name, custom_headers: nil) ⇒ Object

Delete backup

Delete a backup of the volume

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • account_name (String) —

    The name of the NetApp account

  • pool_name (String) —

    The name of the capacity pool

  • volume_name (String) —

    The name of the volume

  • backup_name (String) —

    The name of the backup

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

    A hash of custom headers that



381
382
383
384
 
# File 'lib/2020-11-01/generated/azure_mgmt_netapp/backups.rb', line 381

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

#delete_async(resource_group_name, account_name, pool_name, volume_name, backup_name, custom_headers: nil) ⇒ Concurrent::Promise

will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • account_name (String) —

    The name of the NetApp account

  • pool_name (String) —

    The name of the capacity pool

  • volume_name (String) —

    The name of the volume

  • backup_name (String) —

    The name of the backup

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
 
# File 'lib/2020-11-01/generated/azure_mgmt_netapp/backups.rb', line 398

def delete_async(resource_group_name, , pool_name, volume_name, backup_name, custom_headers:nil)
  # Send request
  promise = begin_delete_async(resource_group_name, , pool_name, volume_name, backup_name, custom_headers:custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
    end

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

  promise
end

#get(resource_group_name, account_name, pool_name, volume_name, backup_name, custom_headers: nil) ⇒ Backup

Get a backup

Get a particular backup of the volume

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • account_name (String) —

    The name of the NetApp account

  • pool_name (String) —

    The name of the capacity pool

  • volume_name (String) —

    The name of the volume

  • backup_name (String) —

    The name of the backup

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

    A hash of custom headers that

Returns:

  • (Backup) —

    operation results.



156
157
158
159
 
# File 'lib/2020-11-01/generated/azure_mgmt_netapp/backups.rb', line 156

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

#get_async(resource_group_name, account_name, pool_name, volume_name, backup_name, custom_headers: nil) ⇒ Concurrent::Promise

Get a backup

Get a particular backup of the volume

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • account_name (String) —

    The name of the NetApp account

  • pool_name (String) —

    The name of the capacity pool

  • volume_name (String) —

    The name of the volume

  • backup_name (String) —

    The name of the backup

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/2020-11-01/generated/azure_mgmt_netapp/backups.rb', line 195

def get_async(resource_group_name, , pool_name, volume_name, backup_name, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.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, 'account_name is nil' if .nil?
  fail ArgumentError, 'pool_name is nil' if pool_name.nil?
  fail ArgumentError, "'pool_name' should satisfy the constraint - 'MaxLength': '64'" if !pool_name.nil? && pool_name.length > 64
  fail ArgumentError, "'pool_name' should satisfy the constraint - 'MinLength': '1'" if !pool_name.nil? && pool_name.length < 1
  fail ArgumentError, "'pool_name' should satisfy the constraint - 'Pattern': '^[a-zA-Z0-9][a-zA-Z0-9\-_]{0,63}$'" if !pool_name.nil? && pool_name.match(Regexp.new('^^[a-zA-Z0-9][a-zA-Z0-9\-_]{0,63}$$')).nil?
  fail ArgumentError, 'volume_name is nil' if volume_name.nil?
  fail ArgumentError, "'volume_name' should satisfy the constraint - 'MaxLength': '64'" if !volume_name.nil? && volume_name.length > 64
  fail ArgumentError, "'volume_name' should satisfy the constraint - 'MinLength': '1'" if !volume_name.nil? && volume_name.length < 1
  fail ArgumentError, "'volume_name' should satisfy the constraint - 'Pattern': '^[a-zA-Z][a-zA-Z0-9\-_]{0,63}$'" if !volume_name.nil? && volume_name.match(Regexp.new('^^[a-zA-Z][a-zA-Z0-9\-_]{0,63}$$')).nil?
  fail ArgumentError, 'backup_name is nil' if backup_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 = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/backups/{backupName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'accountName' => ,'poolName' => pool_name,'volumeName' => volume_name,'backupName' => backup_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::NetApp::Mgmt::V2020_11_01::Models::Backup.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, account_name, pool_name, volume_name, backup_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Get a backup

Get a particular backup of the volume

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • account_name (String) —

    The name of the NetApp account

  • pool_name (String) —

    The name of the capacity pool

  • volume_name (String) —

    The name of the volume

  • backup_name (String) —

    The name of the backup

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



176
177
178
 
# File 'lib/2020-11-01/generated/azure_mgmt_netapp/backups.rb', line 176

def get_with_http_info(resource_group_name, , pool_name, volume_name, backup_name, custom_headers:nil)
  get_async(resource_group_name, , pool_name, volume_name, backup_name, custom_headers:custom_headers).value!
end

#list(resource_group_name, account_name, pool_name, volume_name, custom_headers: nil) ⇒ BackupsList

List Backups

List all backups for a volume

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • account_name (String) —

    The name of the NetApp account

  • pool_name (String) —

    The name of the capacity pool

  • volume_name (String) —

    The name of the volume

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

    A hash of custom headers that

Returns:

  • (BackupsList) —

    operation results.



38
39
40
41
 
# File 'lib/2020-11-01/generated/azure_mgmt_netapp/backups.rb', line 38

def list(resource_group_name, , pool_name, volume_name, custom_headers:nil)
  response = list_async(resource_group_name, , pool_name, volume_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#list_async(resource_group_name, account_name, pool_name, volume_name, custom_headers: nil) ⇒ Concurrent::Promise

List Backups

List all backups for a volume

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • account_name (String) —

    The name of the NetApp account

  • pool_name (String) —

    The name of the capacity pool

  • volume_name (String) —

    The name of the volume

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/2020-11-01/generated/azure_mgmt_netapp/backups.rb', line 75

def list_async(resource_group_name, , pool_name, volume_name, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.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, 'account_name is nil' if .nil?
  fail ArgumentError, 'pool_name is nil' if pool_name.nil?
  fail ArgumentError, "'pool_name' should satisfy the constraint - 'MaxLength': '64'" if !pool_name.nil? && pool_name.length > 64
  fail ArgumentError, "'pool_name' should satisfy the constraint - 'MinLength': '1'" if !pool_name.nil? && pool_name.length < 1
  fail ArgumentError, "'pool_name' should satisfy the constraint - 'Pattern': '^[a-zA-Z0-9][a-zA-Z0-9\-_]{0,63}$'" if !pool_name.nil? && pool_name.match(Regexp.new('^^[a-zA-Z0-9][a-zA-Z0-9\-_]{0,63}$$')).nil?
  fail ArgumentError, 'volume_name is nil' if volume_name.nil?
  fail ArgumentError, "'volume_name' should satisfy the constraint - 'MaxLength': '64'" if !volume_name.nil? && volume_name.length > 64
  fail ArgumentError, "'volume_name' should satisfy the constraint - 'MinLength': '1'" if !volume_name.nil? && volume_name.length < 1
  fail ArgumentError, "'volume_name' should satisfy the constraint - 'Pattern': '^[a-zA-Z][a-zA-Z0-9\-_]{0,63}$'" if !volume_name.nil? && volume_name.match(Regexp.new('^^[a-zA-Z][a-zA-Z0-9\-_]{0,63}$$')).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.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/backups'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'accountName' => ,'poolName' => pool_name,'volumeName' => volume_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::NetApp::Mgmt::V2020_11_01::Models::BackupsList.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_with_http_info(resource_group_name, account_name, pool_name, volume_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

List Backups

List all backups for a volume

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • account_name (String) —

    The name of the NetApp account

  • pool_name (String) —

    The name of the capacity pool

  • volume_name (String) —

    The name of the volume

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



57
58
59
 
# File 'lib/2020-11-01/generated/azure_mgmt_netapp/backups.rb', line 57

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

#update(resource_group_name, account_name, pool_name, volume_name, backup_name, body: nil, custom_headers: nil) ⇒ Backup

Patch a backup

Patch a backup for the volume

operation. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • account_name (String) —

    The name of the NetApp account

  • pool_name (String) —

    The name of the capacity pool

  • volume_name (String) —

    The name of the volume

  • backup_name (String) —

    The name of the backup

  • body (BackupPatch) (defaults to: nil) —

    Backup object supplied in the body of the

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

    A hash of custom headers that

Returns:

  • (Backup) —

    operation results.



331
332
333
334
 
# File 'lib/2020-11-01/generated/azure_mgmt_netapp/backups.rb', line 331

def update(resource_group_name, , pool_name, volume_name, backup_name, body:nil, custom_headers:nil)
  response = update_async(resource_group_name, , pool_name, volume_name, backup_name, body:body, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#update_async(resource_group_name, account_name, pool_name, volume_name, backup_name, body: nil, custom_headers: nil) ⇒ Concurrent::Promise

operation. will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • account_name (String) —

    The name of the NetApp account

  • pool_name (String) —

    The name of the capacity pool

  • volume_name (String) —

    The name of the volume

  • backup_name (String) —

    The name of the backup

  • body (BackupPatch) (defaults to: nil) —

    Backup object supplied in the body of the

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'lib/2020-11-01/generated/azure_mgmt_netapp/backups.rb', line 350

def update_async(resource_group_name, , pool_name, volume_name, backup_name, body:nil, custom_headers:nil)
  # Send request
  promise = begin_update_async(resource_group_name, , pool_name, volume_name, backup_name, body:body, custom_headers:custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
      result_mapper = Azure::NetApp::Mgmt::V2020_11_01::Models::Backup.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