Class: Azure::NetApp::Mgmt::V2019_08_01::Snapshots

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2019-08-01/generated/azure_mgmt_netapp/snapshots.rb

Overview

Microsoft NetApp Azure Resource Provider specification

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Snapshots

Creates and initializes a new instance of the Snapshots class.

Parameters:

  • client —

    service class for accessing basic functionality.



17
18
19
 
# File 'lib/2019-08-01/generated/azure_mgmt_netapp/snapshots.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/2019-08-01/generated/azure_mgmt_netapp/snapshots.rb', line 22

def client
  @client
end

Instance Method Details

#begin_create(body, resource_group_name, account_name, pool_name, volume_name, snapshot_name, custom_headers: nil) ⇒ Snapshot

Create a snapshot

Create the specified snapshot within the given volume

will be added to the HTTP request.

Parameters:

  • body (Snapshot) —

    Snapshot object supplied in the body of the operation.

  • 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

  • snapshot_name (String) —

    The name of the mount target

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

    A hash of custom headers that

Returns:

  • (Snapshot) —

    operation results.



493
494
495
496
 
# File 'lib/2019-08-01/generated/azure_mgmt_netapp/snapshots.rb', line 493

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

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

Create a snapshot

Create the specified snapshot within the given volume

to the HTTP request.

Parameters:

  • body (Snapshot) —

    Snapshot object supplied in the body of the operation.

  • 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

  • snapshot_name (String) —

    The name of the mount target

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
 
# File 'lib/2019-08-01/generated/azure_mgmt_netapp/snapshots.rb', line 534

def begin_create_async(body, resource_group_name, , pool_name, volume_name, snapshot_name, custom_headers:nil)
  fail ArgumentError, 'body is nil' if body.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, 'volume_name is nil' if volume_name.nil?
  fail ArgumentError, 'snapshot_name is nil' if snapshot_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::V2019_08_01::Models::Snapshot.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}/snapshots/{snapshotName}'

  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,'snapshotName' => snapshot_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 == 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 == 201
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::NetApp::Mgmt::V2019_08_01::Models::Snapshot.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(body, resource_group_name, account_name, pool_name, volume_name, snapshot_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Create a snapshot

Create the specified snapshot within the given volume

will be added to the HTTP request.

Parameters:

  • body (Snapshot) —

    Snapshot object supplied in the body of the operation.

  • 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

  • snapshot_name (String) —

    The name of the mount target

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



514
515
516
 
# File 'lib/2019-08-01/generated/azure_mgmt_netapp/snapshots.rb', line 514

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

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

Delete a snapshot

Delete snapshot

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

  • snapshot_name (String) —

    The name of the mount target

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

    A hash of custom headers that



617
618
619
620
 
# File 'lib/2019-08-01/generated/azure_mgmt_netapp/snapshots.rb', line 617

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

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

Delete a snapshot

Delete snapshot

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

  • snapshot_name (String) —

    The name of the mount target

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
699
700
701
702
703
704
705
 
# File 'lib/2019-08-01/generated/azure_mgmt_netapp/snapshots.rb', line 656

def begin_delete_async(resource_group_name, , pool_name, volume_name, snapshot_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, 'volume_name is nil' if volume_name.nil?
  fail ArgumentError, 'snapshot_name is nil' if snapshot_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}/snapshots/{snapshotName}'

  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,'snapshotName' => snapshot_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, snapshot_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Delete a snapshot

Delete snapshot

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

  • snapshot_name (String) —

    The name of the mount target

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



637
638
639
 
# File 'lib/2019-08-01/generated/azure_mgmt_netapp/snapshots.rb', line 637

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

#create(body, resource_group_name, account_name, pool_name, volume_name, snapshot_name, custom_headers: nil) ⇒ Snapshot

Create a snapshot

Create the specified snapshot within the given volume

will be added to the HTTP request.

Parameters:

  • body (Snapshot) —

    Snapshot object supplied in the body of the operation.

  • 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

  • snapshot_name (String) —

    The name of the mount target

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

    A hash of custom headers that

Returns:

  • (Snapshot) —

    operation results.



266
267
268
269
 
# File 'lib/2019-08-01/generated/azure_mgmt_netapp/snapshots.rb', line 266

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

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

will be added to the HTTP request.

response.

Parameters:

  • body (Snapshot) —

    Snapshot object supplied in the body of the operation.

  • 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

  • snapshot_name (String) —

    The name of the mount target

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'lib/2019-08-01/generated/azure_mgmt_netapp/snapshots.rb', line 284

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

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
      result_mapper = Azure::NetApp::Mgmt::V2019_08_01::Models::Snapshot.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, snapshot_name, custom_headers: nil) ⇒ Object

Delete a snapshot

Delete snapshot

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

  • snapshot_name (String) —

    The name of the mount target

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

    A hash of custom headers that



444
445
446
447
 
# File 'lib/2019-08-01/generated/azure_mgmt_netapp/snapshots.rb', line 444

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

#delete_async(resource_group_name, account_name, pool_name, volume_name, snapshot_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

  • snapshot_name (String) —

    The name of the mount target

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
 
# File 'lib/2019-08-01/generated/azure_mgmt_netapp/snapshots.rb', line 461

def delete_async(resource_group_name, , pool_name, volume_name, snapshot_name, custom_headers:nil)
  # Send request
  promise = begin_delete_async(resource_group_name, , pool_name, volume_name, snapshot_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, snapshot_name, custom_headers: nil) ⇒ Snapshot

Describe a snapshot

Get details of the specified snapshot

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

  • snapshot_name (String) —

    The name of the mount target

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

    A hash of custom headers that

Returns:

  • (Snapshot) —

    operation results.



150
151
152
153
 
# File 'lib/2019-08-01/generated/azure_mgmt_netapp/snapshots.rb', line 150

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

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

Describe a snapshot

Get details of the specified snapshot

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

  • snapshot_name (String) —

    The name of the mount target

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/2019-08-01/generated/azure_mgmt_netapp/snapshots.rb', line 189

def get_async(resource_group_name, , pool_name, volume_name, snapshot_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, 'volume_name is nil' if volume_name.nil?
  fail ArgumentError, 'snapshot_name is nil' if snapshot_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}/snapshots/{snapshotName}'

  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,'snapshotName' => snapshot_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::V2019_08_01::Models::Snapshot.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, snapshot_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Describe a snapshot

Get details of the specified snapshot

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

  • snapshot_name (String) —

    The name of the mount target

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



170
171
172
 
# File 'lib/2019-08-01/generated/azure_mgmt_netapp/snapshots.rb', line 170

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

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

Describe all snapshots

List all snapshots associated with 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

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

    A hash of custom headers that

Returns:

  • (SnapshotsList) —

    operation results.



38
39
40
41
 
# File 'lib/2019-08-01/generated/azure_mgmt_netapp/snapshots.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

Describe all snapshots

List all snapshots associated with 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

  • 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
 
# File 'lib/2019-08-01/generated/azure_mgmt_netapp/snapshots.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, 'volume_name is nil' if volume_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}/snapshots'

  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::V2019_08_01::Models::SnapshotsList.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

Describe all snapshots

List all snapshots associated with 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

  • 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/2019-08-01/generated/azure_mgmt_netapp/snapshots.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(body, resource_group_name, account_name, pool_name, volume_name, snapshot_name, custom_headers: nil) ⇒ Snapshot

Update a snapshot

Patch a snapshot

operation. will be added to the HTTP request.

Parameters:

  • body (SnapshotPatch) —

    Snapshot object supplied in the body of the

  • 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

  • snapshot_name (String) —

    The name of the mount target

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

    A hash of custom headers that

Returns:

  • (Snapshot) —

    operation results.



319
320
321
322
 
# File 'lib/2019-08-01/generated/azure_mgmt_netapp/snapshots.rb', line 319

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

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

Update a snapshot

Patch a snapshot

operation. to the HTTP request.

Parameters:

  • body (SnapshotPatch) —

    Snapshot object supplied in the body of the

  • 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

  • snapshot_name (String) —

    The name of the mount target

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
 
# File 'lib/2019-08-01/generated/azure_mgmt_netapp/snapshots.rb', line 362

def update_async(body, resource_group_name, , pool_name, volume_name, snapshot_name, custom_headers:nil)
  fail ArgumentError, 'body is nil' if body.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, 'volume_name is nil' if volume_name.nil?
  fail ArgumentError, 'snapshot_name is nil' if snapshot_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::V2019_08_01::Models::SnapshotPatch.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}/snapshots/{snapshotName}'

  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,'snapshotName' => snapshot_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::V2019_08_01::Models::Snapshot.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

#update_with_http_info(body, resource_group_name, account_name, pool_name, volume_name, snapshot_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Update a snapshot

Patch a snapshot

operation. will be added to the HTTP request.

Parameters:

  • body (SnapshotPatch) —

    Snapshot object supplied in the body of the

  • 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

  • snapshot_name (String) —

    The name of the mount target

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



341
342
343
 
# File 'lib/2019-08-01/generated/azure_mgmt_netapp/snapshots.rb', line 341

def update_with_http_info(body, resource_group_name, , pool_name, volume_name, snapshot_name, custom_headers:nil)
  update_async(body, resource_group_name, , pool_name, volume_name, snapshot_name, custom_headers:custom_headers).value!
end