Class: Azure::RecoveryServicesBackup::Mgmt::V2016_06_01::ProtectionContainers

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

Overview

Open API 2.0 Specs for Azure RecoveryServices Backup service

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ ProtectionContainers

Creates and initializes a new instance of the ProtectionContainers class.

Parameters:

  • client —

    service class for accessing basic functionality.



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

def client
  @client
end

Instance Method Details

#get(vault_name, resource_group_name, fabric_name, container_name, custom_headers: nil) ⇒ ProtectionContainerResource

Gets details of the specific container registered to your Recovery Services vault.

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

  • fabric_name (String) —

    The fabric name associated with the container.

  • container_name (String) —

    The container name used for this GET

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

    A hash of custom headers that

Returns:

  • (ProtectionContainerResource) —

    operation results.



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

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

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

Gets details of the specific container registered to your Recovery Services vault.

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

  • fabric_name (String) —

    The fabric name associated with the container.

  • container_name (String) —

    The container name used for this GET

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
137
 
# File 'lib/2016-06-01/generated/azure_mgmt_recovery_services_backup/protection_containers.rb', line 82

def get_async(vault_name, resource_group_name, fabric_name, container_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?


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

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

Gets details of the specific container registered to your Recovery Services vault.

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

  • fabric_name (String) —

    The fabric name associated with the container.

  • container_name (String) —

    The container name used for this GET

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



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

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

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

Lists the containers registered to the Recovery Services vault.

with the Recovery Services vault. containers registered to the vault. providerType eq MAB, DPM, AzureBackupServer, AzureSql and status eq NotRegistered, Registered, Registering and friendlyName eq containername and 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 is used to sort or filter the

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

    A hash of custom headers that

Returns:

  • (ProtectionContainerResourceList) —

    operation results.



155
156
157
158
 
# File 'lib/2016-06-01/generated/azure_mgmt_recovery_services_backup/protection_containers.rb', line 155

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 containers registered to the Recovery Services vault.

with the Recovery Services vault. containers registered to the vault. providerType eq MAB, DPM, AzureBackupServer, AzureSql and status eq NotRegistered, Registered, Registering and friendlyName eq containername and 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 is used to sort or filter the

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
 
# File 'lib/2016-06-01/generated/azure_mgmt_recovery_services_backup/protection_containers.rb', line 196

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

  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::ProtectionContainerResourceList.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 containers registered to the Recovery Services vault.

with the Recovery Services vault. containers registered to the vault. providerType eq MAB, DPM, AzureBackupServer, AzureSql and status eq NotRegistered, Registered, Registering and friendlyName eq containername and 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 is used to sort or filter the

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



176
177
178
 
# File 'lib/2016-06-01/generated/azure_mgmt_recovery_services_backup/protection_containers.rb', line 176

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

#refresh(vault_name, resource_group_name, fabric_name, custom_headers: nil) ⇒ Object

Discovers the containers in the subscription that can be protected in a Recovery Services vault. This is an asynchronous operation. To learn the status of the operation, use the GetRefreshOperationResult API.

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

  • fabric_name (String) —

    The fabric name associated with the container.

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

    A hash of custom headers that



264
265
266
267
 
# File 'lib/2016-06-01/generated/azure_mgmt_recovery_services_backup/protection_containers.rb', line 264

def refresh(vault_name, resource_group_name, fabric_name, custom_headers:nil)
  response = refresh_async(vault_name, resource_group_name, fabric_name, custom_headers:custom_headers).value!
  nil
end

#refresh_async(vault_name, resource_group_name, fabric_name, custom_headers: nil) ⇒ Concurrent::Promise

Discovers the containers in the subscription that can be protected in a Recovery Services vault. This is an asynchronous operation. To learn the status of the operation, use the GetRefreshOperationResult API.

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

  • fabric_name (String) —

    The fabric name associated with the container.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



301
302
303
304
305
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
 
# File 'lib/2016-06-01/generated/azure_mgmt_recovery_services_backup/protection_containers.rb', line 301

def refresh_async(vault_name, resource_group_name, fabric_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?


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

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

#refresh_with_http_info(vault_name, resource_group_name, fabric_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Discovers the containers in the subscription that can be protected in a Recovery Services vault. This is an asynchronous operation. To learn the status of the operation, use the GetRefreshOperationResult API.

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

  • fabric_name (String) —

    The fabric name associated with the container.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



283
284
285
 
# File 'lib/2016-06-01/generated/azure_mgmt_recovery_services_backup/protection_containers.rb', line 283

def refresh_with_http_info(vault_name, resource_group_name, fabric_name, custom_headers:nil)
  refresh_async(vault_name, resource_group_name, fabric_name, custom_headers:custom_headers).value!
end

#unregister(resource_group_name, vault_name, identity_name, custom_headers: nil) ⇒ Object

Unregisters the given container from your Recovery Services vault.

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

Parameters:

  • resource_group_name (String) —

    The name of the resource group associated

  • vault_name (String) —

    The name of the Recovery Services vault.

  • identity_name (String) —

    Name of the protection container to unregister.

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

    A hash of custom headers that



358
359
360
361
 
# File 'lib/2016-06-01/generated/azure_mgmt_recovery_services_backup/protection_containers.rb', line 358

def unregister(resource_group_name, vault_name, identity_name, custom_headers:nil)
  response = unregister_async(resource_group_name, vault_name, identity_name, custom_headers:custom_headers).value!
  nil
end

#unregister_async(resource_group_name, vault_name, identity_name, custom_headers: nil) ⇒ Concurrent::Promise

Unregisters the given container from your Recovery Services vault.

with the Recovery Services vault. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group associated

  • vault_name (String) —

    The name of the Recovery Services vault.

  • identity_name (String) —

    Name of the protection container to unregister.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
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
 
# File 'lib/2016-06-01/generated/azure_mgmt_recovery_services_backup/protection_containers.rb', line 391

def unregister_async(resource_group_name, vault_name, identity_name, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'vault_name is nil' if vault_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, 'identity_name is nil' if identity_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}/registeredIdentities/{identityName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'vaultName' => vault_name,'identityName' => identity_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 == 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

#unregister_with_http_info(resource_group_name, vault_name, identity_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Unregisters the given container from your Recovery Services vault.

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

Parameters:

  • resource_group_name (String) —

    The name of the resource group associated

  • vault_name (String) —

    The name of the Recovery Services vault.

  • identity_name (String) —

    Name of the protection container to unregister.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



375
376
377
 
# File 'lib/2016-06-01/generated/azure_mgmt_recovery_services_backup/protection_containers.rb', line 375

def unregister_with_http_info(resource_group_name, vault_name, identity_name, custom_headers:nil)
  unregister_async(resource_group_name, vault_name, identity_name, custom_headers:custom_headers).value!
end