Class: Azure::RecoveryServicesBackup::Mgmt::V2016_06_01::ProtectionPolicies

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

Overview

Open API 2.0 Specs for Azure RecoveryServices Backup service

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ ProtectionPolicies

Creates and initializes a new instance of the ProtectionPolicies class.

Parameters:

  • client —

    service class for accessing basic functionality.

[View source]

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

def client
  @client
end

Instance Method Details

#create_or_update(vault_name, resource_group_name, policy_name, resource_protection_policy, custom_headers: nil) ⇒ ProtectionPolicyResource

Creates or modifies a backup policy. This is an asynchronous operation. Use the GetPolicyOperationResult API to Get the operation status.

with the Recovery Services vault. backup policy. 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

  • policy_name (String) —

    The backup policy to be created.

  • resource_protection_policy (ProtectionPolicyResource) —

    The resource

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

    A hash of custom headers that

Returns:

  • (ProtectionPolicyResource) —

    operation results.

[View source]

153
154
155
156
 
# File 'lib/2016-06-01/generated/azure_mgmt_recovery_services_backup/protection_policies.rb', line 153

def create_or_update(vault_name, resource_group_name, policy_name, resource_protection_policy, custom_headers:nil)
  response = create_or_update_async(vault_name, resource_group_name, policy_name, resource_protection_policy, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#create_or_update_async(vault_name, resource_group_name, policy_name, resource_protection_policy, custom_headers: nil) ⇒ Concurrent::Promise

Creates or modifies a backup policy. This is an asynchronous operation. Use the GetPolicyOperationResult API to Get the operation status.

with the Recovery Services vault. backup policy. 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

  • policy_name (String) —

    The backup policy to be created.

  • resource_protection_policy (ProtectionPolicyResource) —

    The resource

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.

[View source]

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
249
250
251
252
253
254
 
# File 'lib/2016-06-01/generated/azure_mgmt_recovery_services_backup/protection_policies.rb', line 192

def create_or_update_async(vault_name, resource_group_name, policy_name, resource_protection_policy, 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, 'policy_name is nil' if policy_name.nil?
  fail ArgumentError, 'resource_protection_policy is nil' if resource_protection_policy.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_06_01::Models::ProtectionPolicyResource.mapper()
  request_content = @client.serialize(request_mapper,  resource_protection_policy)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupPolicies/{policyName}'

  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,'policyName' => policy_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 == 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::RecoveryServicesBackup::Mgmt::V2016_06_01::Models::ProtectionPolicyResource.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

#create_or_update_with_http_info(vault_name, resource_group_name, policy_name, resource_protection_policy, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Creates or modifies a backup policy. This is an asynchronous operation. Use the GetPolicyOperationResult API to Get the operation status.

with the Recovery Services vault. backup policy. 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

  • policy_name (String) —

    The backup policy to be created.

  • resource_protection_policy (ProtectionPolicyResource) —

    The resource

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.

[View source]

173
174
175
 
# File 'lib/2016-06-01/generated/azure_mgmt_recovery_services_backup/protection_policies.rb', line 173

def create_or_update_with_http_info(vault_name, resource_group_name, policy_name, resource_protection_policy, custom_headers:nil)
  create_or_update_async(vault_name, resource_group_name, policy_name, resource_protection_policy, custom_headers:custom_headers).value!
end

#delete(vault_name, resource_group_name, policy_name, custom_headers: nil) ⇒ Object

Deletes the specified backup policy from your Recovery Services vault. This is an asynchronous operation. Use the GetPolicyOperationResult API to Get the operation status.

with the Recovery Services vault. 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

  • policy_name (String) —

    The name of the backup policy to be deleted.

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

    A hash of custom headers that

[View source]

269
270
271
272
 
# File 'lib/2016-06-01/generated/azure_mgmt_recovery_services_backup/protection_policies.rb', line 269

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

#delete_async(vault_name, resource_group_name, policy_name, custom_headers: nil) ⇒ Concurrent::Promise

Deletes the specified backup policy from your Recovery Services vault. This is an asynchronous operation. Use the GetPolicyOperationResult API to Get the operation status.

with the Recovery Services vault. 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

  • policy_name (String) —

    The name of the backup policy 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.

[View source]

306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'lib/2016-06-01/generated/azure_mgmt_recovery_services_backup/protection_policies.rb', line 306

def delete_async(vault_name, resource_group_name, policy_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, 'policy_name is nil' if policy_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}/backupPolicies/{policyName}'

  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,'policyName' => policy_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 == 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, policy_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Deletes the specified backup policy from your Recovery Services vault. This is an asynchronous operation. Use the GetPolicyOperationResult API to Get the operation status.

with the Recovery Services vault. 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

  • policy_name (String) —

    The name of the backup policy to be deleted.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.

[View source]

288
289
290
 
# File 'lib/2016-06-01/generated/azure_mgmt_recovery_services_backup/protection_policies.rb', line 288

def delete_with_http_info(vault_name, resource_group_name, policy_name, custom_headers:nil)
  delete_async(vault_name, resource_group_name, policy_name, custom_headers:custom_headers).value!
end

#get(vault_name, resource_group_name, policy_name, custom_headers: nil) ⇒ ProtectionPolicyResource

Gets the details of the backup policy associated with the Recovery Services vault. This is an asynchronous operation. Use the GetPolicyOperationResult API to Get the operation status.

with the Recovery Services vault. 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

  • policy_name (String) —

    The backup policy name used in this GET

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

    A hash of custom headers that

Returns:

  • (ProtectionPolicyResource) —

    operation results.

[View source]

43
44
45
46
 
# File 'lib/2016-06-01/generated/azure_mgmt_recovery_services_backup/protection_policies.rb', line 43

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

#get_async(vault_name, resource_group_name, policy_name, custom_headers: nil) ⇒ Concurrent::Promise

Gets the details of the backup policy associated with the Recovery Services vault. This is an asynchronous operation. Use the GetPolicyOperationResult API to Get the operation status.

with the Recovery Services vault. 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

  • policy_name (String) —

    The backup policy name used in this GET

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.

[View source]

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
134
135
136
 
# File 'lib/2016-06-01/generated/azure_mgmt_recovery_services_backup/protection_policies.rb', line 82

def get_async(vault_name, resource_group_name, policy_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, 'policy_name is nil' if policy_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}/backupPolicies/{policyName}'

  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,'policyName' => policy_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::RecoveryServicesBackup::Mgmt::V2016_06_01::Models::ProtectionPolicyResource.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, policy_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets the details of the backup policy associated with the Recovery Services vault. This is an asynchronous operation. Use the GetPolicyOperationResult API to Get the operation status.

with the Recovery Services vault. 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

  • policy_name (String) —

    The backup policy name used in this GET

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.

[View source]

63
64
65
 
# File 'lib/2016-06-01/generated/azure_mgmt_recovery_services_backup/protection_policies.rb', line 63

def get_with_http_info(vault_name, resource_group_name, policy_name, custom_headers:nil)
  get_async(vault_name, resource_group_name, policy_name, custom_headers:custom_headers).value!
end

#list(vault_name, resource_group_name, filter: nil, custom_headers: nil) ⇒ ProtectionPolicyResourceList

Lists the backup policies associated with the Recovery Services vault. The API provides parameters to Get scoped results.

with the Recovery Services vault. of backup policies. backupManagementType eq MAB, DPM, AzureBackupServer, AzureSql. 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

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

    The following equation can be used to filter the list

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

    A hash of custom headers that

Returns:

  • (ProtectionPolicyResourceList) —

    operation results.

[View source]

367
368
369
370
 
# File 'lib/2016-06-01/generated/azure_mgmt_recovery_services_backup/protection_policies.rb', line 367

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

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

Lists the backup policies associated with the Recovery Services vault. The API provides parameters to Get scoped results.

with the Recovery Services vault. of backup policies. backupManagementType eq MAB, DPM, AzureBackupServer, AzureSql. 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

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

    The following equation can be used to filter the list

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.

[View source]

406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
 
# File 'lib/2016-06-01/generated/azure_mgmt_recovery_services_backup/protection_policies.rb', line 406

def list_async(vault_name, resource_group_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?


  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}/backupPolicies'

  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},
      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::ProtectionPolicyResourceList.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, filter: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists the backup policies associated with the Recovery Services vault. The API provides parameters to Get scoped results.

with the Recovery Services vault. of backup policies. backupManagementType eq MAB, DPM, AzureBackupServer, AzureSql. 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

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

    The following equation can be used to filter the list

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.

[View source]

387
388
389
 
# File 'lib/2016-06-01/generated/azure_mgmt_recovery_services_backup/protection_policies.rb', line 387

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