Class: Azure::RecoveryServicesBackup::Mgmt::V2016_06_01::RecoveryPoints

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2016-06-01/generated/azure_mgmt_recovery_services_backup/recovery_points.rb

Overview

Open API 2.0 Specs for Azure RecoveryServices Backup service

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ RecoveryPoints

Creates and initializes a new instance of the RecoveryPoints class.

Parameters:

  • client —

    service class for accessing basic functionality.



21
22
23
 
# File 'lib/2016-06-01/generated/azure_mgmt_recovery_services_backup/recovery_points.rb', line 21

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ RecoveryServicesBackupClient (readonly)

Returns reference to the RecoveryServicesBackupClient.

Returns:



26
27
28
 
# File 'lib/2016-06-01/generated/azure_mgmt_recovery_services_backup/recovery_points.rb', line 26

def client
  @client
end

Instance Method Details

#get(vault_name, resource_group_name, fabric_name, container_name, protected_item_name, recovery_point_id, custom_headers: nil) ⇒ RecoveryPointResource

Provides the backup data for the RecoveryPointID. This is an asynchronous operation. To learn the status of the operation, call the GetProtectedItemOperationResult API.

with the Recovery Services vault. item. GET operation. GET operation. will be added to the HTTP request.

Parameters:

  • vault_name (String) —

    The name of the Recovery Services vault.

  • resource_group_name (String) —

    The name of the resource group associated

  • fabric_name (String) —

    The fabric name associated with backup item.

  • container_name (String) —

    The container name associated with backup

  • protected_item_name (String) —

    The name of the backup item used in this

  • recovery_point_id (String) —

    The RecoveryPointID associated with this

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

    A hash of custom headers that

Returns:

  • (RecoveryPointResource) —

    operation results.



48
49
50
51
 
# File 'lib/2016-06-01/generated/azure_mgmt_recovery_services_backup/recovery_points.rb', line 48

def get(vault_name, resource_group_name, fabric_name, container_name, protected_item_name, recovery_point_id, custom_headers:nil)
  response = get_async(vault_name, resource_group_name, fabric_name, container_name, protected_item_name, recovery_point_id, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_async(vault_name, resource_group_name, fabric_name, container_name, protected_item_name, recovery_point_id, custom_headers: nil) ⇒ Concurrent::Promise

Provides the backup data for the RecoveryPointID. This is an asynchronous operation. To learn the status of the operation, call the GetProtectedItemOperationResult API.

with the Recovery Services vault. item. GET operation. GET operation. to the HTTP request.

Parameters:

  • vault_name (String) —

    The name of the Recovery Services vault.

  • resource_group_name (String) —

    The name of the resource group associated

  • fabric_name (String) —

    The fabric name associated with backup item.

  • container_name (String) —

    The container name associated with backup

  • protected_item_name (String) —

    The name of the backup item used in this

  • recovery_point_id (String) —

    The RecoveryPointID associated with this

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/2016-06-01/generated/azure_mgmt_recovery_services_backup/recovery_points.rb', line 97

def get_async(vault_name, resource_group_name, fabric_name, container_name, protected_item_name, recovery_point_id, custom_headers:nil)
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, 'vault_name is nil' if vault_name.nil?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'fabric_name is nil' if fabric_name.nil?
  fail ArgumentError, 'container_name is nil' if container_name.nil?
  fail ArgumentError, 'protected_item_name is nil' if protected_item_name.nil?
  fail ArgumentError, 'recovery_point_id is nil' if recovery_point_id.nil?


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

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = 'Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}/recoveryPoints/{recoveryPointId}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'vaultName' => vault_name,'resourceGroupName' => resource_group_name,'subscriptionId' => @client.subscription_id,'fabricName' => fabric_name,'containerName' => container_name,'protectedItemName' => protected_item_name,'recoveryPointId' => recovery_point_id},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:get, path_template, options)

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

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::RecoveryServicesBackup::Mgmt::V2016_06_01::Models::RecoveryPointResource.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(vault_name, resource_group_name, fabric_name, container_name, protected_item_name, recovery_point_id, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Provides the backup data for the RecoveryPointID. This is an asynchronous operation. To learn the status of the operation, call the GetProtectedItemOperationResult API.

with the Recovery Services vault. item. GET operation. GET operation. will be added to the HTTP request.

Parameters:

  • vault_name (String) —

    The name of the Recovery Services vault.

  • resource_group_name (String) —

    The name of the resource group associated

  • fabric_name (String) —

    The fabric name associated with backup item.

  • container_name (String) —

    The container name associated with backup

  • protected_item_name (String) —

    The name of the backup item used in this

  • recovery_point_id (String) —

    The RecoveryPointID associated with this

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



73
74
75
 
# File 'lib/2016-06-01/generated/azure_mgmt_recovery_services_backup/recovery_points.rb', line 73

def get_with_http_info(vault_name, resource_group_name, fabric_name, container_name, protected_item_name, recovery_point_id, custom_headers:nil)
  get_async(vault_name, resource_group_name, fabric_name, container_name, protected_item_name, recovery_point_id, custom_headers:custom_headers).value!
end

#list(vault_name, resource_group_name, fabric_name, container_name, protected_item_name, filter: nil, custom_headers: nil) ⇒ RecoveryPointResourceList

Lists the recovery points, or backup copies, for the specified backup item.

with the Recovery Services vault. item. operation. yyyy-mm-dd hh:mm:ss PM}. will be added to the HTTP request.

Parameters:

  • vault_name (String) —

    The name of the Recovery Services vault.

  • resource_group_name (String) —

    The name of the resource group associated

  • fabric_name (String) —

    The fabric name associated with the backup item.

  • container_name (String) —

    The container name associated with the backup

  • protected_item_name (String) —

    The name of backup item used in this GET

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

    startDate eq hh:mm:ss PM and endDate {

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

    A hash of custom headers that

Returns:

  • (RecoveryPointResourceList) —

    operation results.



174
175
176
177
 
# File 'lib/2016-06-01/generated/azure_mgmt_recovery_services_backup/recovery_points.rb', line 174

def list(vault_name, resource_group_name, fabric_name, container_name, protected_item_name, filter:nil, custom_headers:nil)
  response = list_async(vault_name, resource_group_name, fabric_name, container_name, protected_item_name, filter:filter, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#list_async(vault_name, resource_group_name, fabric_name, container_name, protected_item_name, filter: nil, custom_headers: nil) ⇒ Concurrent::Promise

Lists the recovery points, or backup copies, for the specified backup item.

with the Recovery Services vault. item. operation. yyyy-mm-dd hh:mm:ss PM}. to the HTTP request.

Parameters:

  • vault_name (String) —

    The name of the Recovery Services vault.

  • resource_group_name (String) —

    The name of the resource group associated

  • fabric_name (String) —

    The fabric name associated with the backup item.

  • container_name (String) —

    The container name associated with the backup

  • protected_item_name (String) —

    The name of backup item used in this GET

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

    startDate eq hh:mm:ss PM and endDate {

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/2016-06-01/generated/azure_mgmt_recovery_services_backup/recovery_points.rb', line 219

def list_async(vault_name, resource_group_name, fabric_name, container_name, protected_item_name, filter:nil, custom_headers:nil)
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, 'vault_name is nil' if vault_name.nil?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'fabric_name is nil' if fabric_name.nil?
  fail ArgumentError, 'container_name is nil' if container_name.nil?
  fail ArgumentError, 'protected_item_name is nil' if protected_item_name.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.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}/recoveryPoints'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'vaultName' => vault_name,'resourceGroupName' => resource_group_name,'subscriptionId' => @client.subscription_id,'fabricName' => fabric_name,'containerName' => container_name,'protectedItemName' => protected_item_name},
      query_params: {'api-version' => @client.api_version,'$filter' => filter},
      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::RecoveryServicesBackup::Mgmt::V2016_06_01::Models::RecoveryPointResourceList.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(vault_name, resource_group_name, fabric_name, container_name, protected_item_name, filter: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists the recovery points, or backup copies, for the specified backup item.

with the Recovery Services vault. item. operation. yyyy-mm-dd hh:mm:ss PM}. will be added to the HTTP request.

Parameters:

  • vault_name (String) —

    The name of the Recovery Services vault.

  • resource_group_name (String) —

    The name of the resource group associated

  • fabric_name (String) —

    The fabric name associated with the backup item.

  • container_name (String) —

    The container name associated with the backup

  • protected_item_name (String) —

    The name of backup item used in this GET

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

    startDate eq hh:mm:ss PM and endDate {

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



197
198
199
 
# File 'lib/2016-06-01/generated/azure_mgmt_recovery_services_backup/recovery_points.rb', line 197

def list_with_http_info(vault_name, resource_group_name, fabric_name, container_name, protected_item_name, filter:nil, custom_headers:nil)
  list_async(vault_name, resource_group_name, fabric_name, container_name, protected_item_name, filter:filter, custom_headers:custom_headers).value!
end