Class: Azure::RecoveryServicesBackup::Mgmt::V2016_12_01::ItemLevelRecoveryConnections

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

Overview

Open API 2.0 Specs for Azure RecoveryServices Backup service

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ ItemLevelRecoveryConnections

Creates and initializes a new instance of the ItemLevelRecoveryConnections class.

Parameters:

  • client —

    service class for accessing basic functionality.



21
22
23
 
# File 'lib/2016-12-01/generated/azure_mgmt_recovery_services_backup/item_level_recovery_connections.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-12-01/generated/azure_mgmt_recovery_services_backup/item_level_recovery_connections.rb', line 26

def client
  @client
end

Instance Method Details

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

Provisions a script which invokes an iSCSI connection to the backup data. Executing this script opens a file explorer displaying all the recoverable files and folders. This is an asynchronous operation. To know the status of provisioning, call GetProtectedItemOperationResult API.

recovery services vault is present. items. are to be restored. up data. iSCSI connection will be provisioned for this backed up data. 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 name whose files/folders

  • recovery_point_id (String) —

    Recovery point ID which represents backed

  • parameters (ILRRequestResource) —

    resource ILR request

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

    A hash of custom headers that



51
52
53
54
 
# File 'lib/2016-12-01/generated/azure_mgmt_recovery_services_backup/item_level_recovery_connections.rb', line 51

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

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

Provisions a script which invokes an iSCSI connection to the backup data. Executing this script opens a file explorer displaying all the recoverable files and folders. This is an asynchronous operation. To know the status of provisioning, call GetProtectedItemOperationResult API.

recovery services vault is present. items. are to be restored. up data. iSCSI connection will be provisioned for this backed up data. 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 name whose files/folders

  • recovery_point_id (String) —

    Recovery point ID which represents backed

  • parameters (ILRRequestResource) —

    resource ILR request

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
155
156
157
158
159
160
161
162
163
 
# File 'lib/2016-12-01/generated/azure_mgmt_recovery_services_backup/item_level_recovery_connections.rb', line 108

def provision_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::V2016_12_01::Models::ILRRequestResource.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}/provisionInstantItemRecovery'

  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

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

Provisions a script which invokes an iSCSI connection to the backup data. Executing this script opens a file explorer displaying all the recoverable files and folders. This is an asynchronous operation. To know the status of provisioning, call GetProtectedItemOperationResult API.

recovery services vault is present. items. are to be restored. up data. iSCSI connection will be provisioned for this backed up data. 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 name whose files/folders

  • recovery_point_id (String) —

    Recovery point ID which represents backed

  • parameters (ILRRequestResource) —

    resource ILR request

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



80
81
82
 
# File 'lib/2016-12-01/generated/azure_mgmt_recovery_services_backup/item_level_recovery_connections.rb', line 80

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

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

Revokes an iSCSI connection which can be used to download a script. Executing this script opens a file explorer displaying all recoverable files and folders. This is an asynchronous operation.

recovery services vault is present. items. are to be restored. up data. iSCSI connection will be revoked for this backed up data. 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 name whose files/folders

  • recovery_point_id (String) —

    Recovery point ID which represents backed

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

    A hash of custom headers that



186
187
188
189
 
# File 'lib/2016-12-01/generated/azure_mgmt_recovery_services_backup/item_level_recovery_connections.rb', line 186

def revoke(vault_name, resource_group_name, fabric_name, container_name, protected_item_name, recovery_point_id, custom_headers:nil)
  response = revoke_async(vault_name, resource_group_name, fabric_name, container_name, protected_item_name, recovery_point_id, custom_headers:custom_headers).value!
  nil
end

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

Revokes an iSCSI connection which can be used to download a script. Executing this script opens a file explorer displaying all recoverable files and folders. This is an asynchronous operation.

recovery services vault is present. items. are to be restored. up data. iSCSI connection will be revoked for this backed up data. 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 name whose files/folders

  • recovery_point_id (String) —

    Recovery point ID which represents backed

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/2016-12-01/generated/azure_mgmt_recovery_services_backup/item_level_recovery_connections.rb', line 239

def revoke_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}/revokeInstantItemRecovery'

  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(: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

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

Revokes an iSCSI connection which can be used to download a script. Executing this script opens a file explorer displaying all recoverable files and folders. This is an asynchronous operation.

recovery services vault is present. items. are to be restored. up data. iSCSI connection will be revoked for this backed up data. 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 name whose files/folders

  • recovery_point_id (String) —

    Recovery point ID which represents backed

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



213
214
215
 
# File 'lib/2016-12-01/generated/azure_mgmt_recovery_services_backup/item_level_recovery_connections.rb', line 213

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