Class: Azure::RecoveryServicesBackup::Mgmt::V2019_05_13::Restores

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2019-05-13/generated/azure_mgmt_recovery_services_backup/restores.rb

Overview

Restores

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Restores

Creates and initializes a new instance of the Restores class.

Parameters:

  • client —

    service class for accessing basic functionality.



17
18
19
 
# File 'lib/2019-05-13/generated/azure_mgmt_recovery_services_backup/restores.rb', line 17

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ RecoveryServicesBackupClient (readonly)

Returns reference to the RecoveryServicesBackupClient.

Returns:



22
23
24
 
# File 'lib/2019-05-13/generated/azure_mgmt_recovery_services_backup/restores.rb', line 22

def client
  @client
end

Instance Method Details

#trigger(vault_name, resource_group_name, fabric_name, container_name, protected_item_name, recovery_point_id, parameters, custom_headers: nil) ⇒ Object

Restores the specified backed up data. This is an asynchronous operation. To know the status of this API call, use GetProtectedItemOperationResult API.

recovery services vault is present. items. backed up data to be restored. 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 where the

  • fabric_name (String) —

    Fabric name associated with the backed up items.

  • container_name (String) —

    Container name associated with the backed up

  • protected_item_name (String) —

    Backed up item to be restored.

  • recovery_point_id (String) —

    Recovery point ID which represents the

  • parameters (RestoreRequestResource) —

    resource restore request

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

    A hash of custom headers that



43
44
45
46
 
# File 'lib/2019-05-13/generated/azure_mgmt_recovery_services_backup/restores.rb', line 43

def trigger(vault_name, resource_group_name, fabric_name, container_name, protected_item_name, recovery_point_id, parameters, custom_headers:nil)
  response = trigger_async(vault_name, resource_group_name, fabric_name, container_name, protected_item_name, recovery_point_id, parameters, custom_headers:custom_headers).value!
  nil
end

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

Restores the specified backed up data. This is an asynchronous operation. To know the status of this API call, use GetProtectedItemOperationResult API.

recovery services vault is present. items. backed up data to be restored. 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 where the

  • fabric_name (String) —

    Fabric name associated with the backed up items.

  • container_name (String) —

    Container name associated with the backed up

  • protected_item_name (String) —

    Backed up item to be restored.

  • recovery_point_id (String) —

    Recovery point ID which represents the

  • parameters (RestoreRequestResource) —

    resource restore request

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
140
141
142
143
144
145
146
147
 
# File 'lib/2019-05-13/generated/azure_mgmt_recovery_services_backup/restores.rb', line 92

def trigger_async(vault_name, resource_group_name, fabric_name, container_name, protected_item_name, recovery_point_id, parameters, 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?
  fail ArgumentError, 'parameters is nil' if parameters.nil?


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

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

  # Serialize Request
  request_mapper = Azure::RecoveryServicesBackup::Mgmt::V2019_05_13::Models::RestoreRequestResource.mapper()
  request_content = @client.serialize(request_mapper,  parameters)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}/recoveryPoints/{recoveryPointId}/restore'

  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},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:post, 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 == 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?

    result
  end

  promise.execute
end

#trigger_with_http_info(vault_name, resource_group_name, fabric_name, container_name, protected_item_name, recovery_point_id, parameters, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Restores the specified backed up data. This is an asynchronous operation. To know the status of this API call, use GetProtectedItemOperationResult API.

recovery services vault is present. items. backed up data to be restored. 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 where the

  • fabric_name (String) —

    Fabric name associated with the backed up items.

  • container_name (String) —

    Container name associated with the backed up

  • protected_item_name (String) —

    Backed up item to be restored.

  • recovery_point_id (String) —

    Recovery point ID which represents the

  • parameters (RestoreRequestResource) —

    resource restore request

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



68
69
70
 
# File 'lib/2019-05-13/generated/azure_mgmt_recovery_services_backup/restores.rb', line 68

def trigger_with_http_info(vault_name, resource_group_name, fabric_name, container_name, protected_item_name, recovery_point_id, parameters, custom_headers:nil)
  trigger_async(vault_name, resource_group_name, fabric_name, container_name, protected_item_name, recovery_point_id, parameters, custom_headers:custom_headers).value!
end