Class: Azure::RecoveryServicesBackup::Mgmt::V2016_12_01::ProtectedItems

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

Overview

Open API 2.0 Specs for Azure RecoveryServices Backup service

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ ProtectedItems

Creates and initializes a new instance of the ProtectedItems class.

Parameters:

  • client —

    service class for accessing basic functionality.



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

def client
  @client
end

Instance Method Details

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

Enables backup of an item or to modifies the backup policy information of an already backed up item. This is an asynchronous operation. To know the status of the operation, call the GetItemOperationResult API.

recovery services vault is present. item. 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 backup item.

  • container_name (String) —

    Container name associated with the backup

  • protected_item_name (String) —

    Item name to be backed up.

  • parameters (ProtectedItemResource) —

    resource backed up item

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

    A hash of custom headers that



170
171
172
173
 
# File 'lib/2016-12-01/generated/azure_mgmt_recovery_services_backup/protected_items.rb', line 170

def create_or_update(vault_name, resource_group_name, fabric_name, container_name, protected_item_name, parameters, custom_headers:nil)
  response = create_or_update_async(vault_name, resource_group_name, fabric_name, container_name, protected_item_name, parameters, custom_headers:custom_headers).value!
  nil
end

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

Enables backup of an item or to modifies the backup policy information of an already backed up item. This is an asynchronous operation. To know the status of the operation, call the GetItemOperationResult API.

recovery services vault is present. item. 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 backup item.

  • container_name (String) —

    Container name associated with the backup

  • protected_item_name (String) —

    Item name to be backed up.

  • parameters (ProtectedItemResource) —

    resource backed up item

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
261
262
263
264
265
266
267
268
269
270
271
 
# File 'lib/2016-12-01/generated/azure_mgmt_recovery_services_backup/protected_items.rb', line 217

def create_or_update_async(vault_name, resource_group_name, fabric_name, container_name, protected_item_name, 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, '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::ProtectedItemResource.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}'

  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},
      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 == 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

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

Enables backup of an item or to modifies the backup policy information of an already backed up item. This is an asynchronous operation. To know the status of the operation, call the GetItemOperationResult API.

recovery services vault is present. item. 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 backup item.

  • container_name (String) —

    Container name associated with the backup

  • protected_item_name (String) —

    Item name to be backed up.

  • parameters (ProtectedItemResource) —

    resource backed up item

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



194
195
196
 
# File 'lib/2016-12-01/generated/azure_mgmt_recovery_services_backup/protected_items.rb', line 194

def create_or_update_with_http_info(vault_name, resource_group_name, fabric_name, container_name, protected_item_name, parameters, custom_headers:nil)
  create_or_update_async(vault_name, resource_group_name, fabric_name, container_name, protected_item_name, parameters, custom_headers:custom_headers).value!
end

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

Used to disable backup of an item within a container. This is an asynchronous operation. To know the status of the request, call the GetItemOperationResult API.

recovery services vault is present. item. 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 item.

  • container_name (String) —

    Container name associated with the backed up

  • protected_item_name (String) —

    Backed up item to be deleted.

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

    A hash of custom headers that



289
290
291
292
 
# File 'lib/2016-12-01/generated/azure_mgmt_recovery_services_backup/protected_items.rb', line 289

def delete(vault_name, resource_group_name, fabric_name, container_name, protected_item_name, custom_headers:nil)
  response = delete_async(vault_name, resource_group_name, fabric_name, container_name, protected_item_name, custom_headers:custom_headers).value!
  nil
end

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

Used to disable backup of an item within a container. This is an asynchronous operation. To know the status of the request, call the GetItemOperationResult API.

recovery services vault is present. item. 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 item.

  • container_name (String) —

    Container name associated with the backed up

  • protected_item_name (String) —

    Backed up item to be deleted.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
 
# File 'lib/2016-12-01/generated/azure_mgmt_recovery_services_backup/protected_items.rb', line 332

def delete_async(vault_name, resource_group_name, fabric_name, container_name, protected_item_name, 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}'

  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},
      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 == 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

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

Used to disable backup of an item within a container. This is an asynchronous operation. To know the status of the request, call the GetItemOperationResult API.

recovery services vault is present. item. 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 item.

  • container_name (String) —

    Container name associated with the backed up

  • protected_item_name (String) —

    Backed up item to be deleted.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



311
312
313
 
# File 'lib/2016-12-01/generated/azure_mgmt_recovery_services_backup/protected_items.rb', line 311

def delete_with_http_info(vault_name, resource_group_name, fabric_name, container_name, protected_item_name, custom_headers:nil)
  delete_async(vault_name, resource_group_name, fabric_name, container_name, protected_item_name, custom_headers:custom_headers).value!
end

#get(vault_name, resource_group_name, fabric_name, container_name, protected_item_name, filter: nil, custom_headers: nil) ⇒ ProtectedItemResource

Provides the details of the backed up item. This is an asynchronous operation. To know the status of the operation, call the GetItemOperationResult API.

recovery services vault is present. item. be fetched. 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 item.

  • container_name (String) —

    Container name associated with the backed up

  • protected_item_name (String) —

    Backed up item name whose details are to

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

    OData filter options.

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

    A hash of custom headers that

Returns:

  • (ProtectedItemResource) —

    operation results.



47
48
49
50
 
# File 'lib/2016-12-01/generated/azure_mgmt_recovery_services_backup/protected_items.rb', line 47

def get(vault_name, resource_group_name, fabric_name, container_name, protected_item_name, filter:nil, custom_headers:nil)
  response = get_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

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

Provides the details of the backed up item. This is an asynchronous operation. To know the status of the operation, call the GetItemOperationResult API.

recovery services vault is present. item. be fetched. 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 item.

  • container_name (String) —

    Container name associated with the backed up

  • protected_item_name (String) —

    Backed up item name whose details are to

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

    OData filter options.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
148
149
150
 
# File 'lib/2016-12-01/generated/azure_mgmt_recovery_services_backup/protected_items.rb', line 94

def get_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}'

  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_12_01::Models::ProtectedItemResource.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, filter: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Provides the details of the backed up item. This is an asynchronous operation. To know the status of the operation, call the GetItemOperationResult API.

recovery services vault is present. item. be fetched. 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 item.

  • container_name (String) —

    Container name associated with the backed up

  • protected_item_name (String) —

    Backed up item name whose details are to

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

    OData filter options.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



71
72
73
 
# File 'lib/2016-12-01/generated/azure_mgmt_recovery_services_backup/protected_items.rb', line 71

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