Class: Azure::RecoveryServicesBackup::Mgmt::V2016_12_01::ProtectionContainers

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2016-12-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-12-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-12-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.

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

    Name of the fabric where the container belongs.

  • container_name (String) —

    Name of the container whose details need to be

  • 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-12-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.

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

    Name of the fabric where the container belongs.

  • container_name (String) —

    Name of the container whose details need to be

  • 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-12-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_12_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.

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

    Name of the fabric where the container belongs.

  • container_name (String) —

    Name of the container whose details need to be

  • 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-12-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

#inquire(vault_name, resource_group_name, fabric_name, container_name, filter: nil, custom_headers: nil) ⇒ Object

Inquires all the protectable item in the given container that can be protected.

Inquires all the protectable items that are protectable under the given container.

recovery services vault is present. to be triggered. 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 container.

  • container_name (String) —

    Name of the container in which inquiry needs

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

    OData filter options.

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

    A hash of custom headers that



388
389
390
391
 
# File 'lib/2016-12-01/generated/azure_mgmt_recovery_services_backup/protection_containers.rb', line 388

def inquire(vault_name, resource_group_name, fabric_name, container_name, filter:nil, custom_headers:nil)
  response = inquire_async(vault_name, resource_group_name, fabric_name, container_name, filter:filter, custom_headers:custom_headers).value!
  nil
end

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

Inquires all the protectable item in the given container that can be protected.

Inquires all the protectable items that are protectable under the given container.

recovery services vault is present. to be triggered. 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 container.

  • container_name (String) —

    Name of the container in which inquiry needs

  • 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.



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
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
 
# File 'lib/2016-12-01/generated/azure_mgmt_recovery_services_backup/protection_containers.rb', line 435

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


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

  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,'$filter' => filter},
      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

#inquire_with_http_info(vault_name, resource_group_name, fabric_name, container_name, filter: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Inquires all the protectable item in the given container that can be protected.

Inquires all the protectable items that are protectable under the given container.

recovery services vault is present. to be triggered. 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 container.

  • container_name (String) —

    Name of the container in which inquiry needs

  • 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.



412
413
414
 
# File 'lib/2016-12-01/generated/azure_mgmt_recovery_services_backup/protection_containers.rb', line 412

def inquire_with_http_info(vault_name, resource_group_name, fabric_name, container_name, filter:nil, custom_headers:nil)
  inquire_async(vault_name, resource_group_name, fabric_name, container_name, filter:filter, custom_headers:custom_headers).value!
end

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

Discovers all the containers in the subscription that can be backed up to Recovery Services Vault. This is an asynchronous operation. To know the status of the operation, call GetRefreshOperationResult API.

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

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

    OData filter options.

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

    A hash of custom headers that



497
498
499
500
 
# File 'lib/2016-12-01/generated/azure_mgmt_recovery_services_backup/protection_containers.rb', line 497

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

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

Discovers all the containers in the subscription that can be backed up to Recovery Services Vault. This is an asynchronous operation. To know the status of the operation, call GetRefreshOperationResult API.

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

  • 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.



538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
 
# File 'lib/2016-12-01/generated/azure_mgmt_recovery_services_backup/protection_containers.rb', line 538

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


  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,'$filter' => filter},
      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, filter: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Discovers all the containers in the subscription that can be backed up to Recovery Services Vault. This is an asynchronous operation. To know the status of the operation, call GetRefreshOperationResult API.

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

  • 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.



518
519
520
 
# File 'lib/2016-12-01/generated/azure_mgmt_recovery_services_backup/protection_containers.rb', line 518

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

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

Registers the container with Recovery Services vault. This is an asynchronous operation. To track the operation status, use location header to call get latest status of the operation.

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

  • container_name (String) —

    Name of the container to be registered.

  • parameters (ProtectionContainerResource) —

    Request body for operation

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

    A hash of custom headers that

Returns:

  • (ProtectionContainerResource) —

    operation results.



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

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

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

Registers the container with Recovery Services vault. This is an asynchronous operation. To track the operation status, use location header to call get latest status of the operation.

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

  • container_name (String) —

    Name of the container to be registered.

  • parameters (ProtectionContainerResource) —

    Request body for operation

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
255
256
257
258
259
260
261
262
 
# File 'lib/2016-12-01/generated/azure_mgmt_recovery_services_backup/protection_containers.rb', line 199

def register_async(vault_name, resource_group_name, fabric_name, container_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, '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::ProtectionContainerResource.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}'

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

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

Registers the container with Recovery Services vault. This is an asynchronous operation. To track the operation status, use location header to call get latest status of the operation.

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

  • container_name (String) —

    Name of the container to be registered.

  • parameters (ProtectionContainerResource) —

    Request body for operation

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



178
179
180
 
# File 'lib/2016-12-01/generated/azure_mgmt_recovery_services_backup/protection_containers.rb', line 178

def register_with_http_info(vault_name, resource_group_name, fabric_name, container_name, parameters, custom_headers:nil)
  register_async(vault_name, resource_group_name, fabric_name, container_name, parameters, custom_headers:custom_headers).value!
end

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

Unregisters the given container from your Recovery Services Vault. This is an asynchronous operation. To determine whether the backend service has finished processing the request, call Get Container Operation Result API.

recovery services vault is present. unregistered from 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 where the

  • fabric_name (String) —

    Name of the fabric where the container belongs.

  • container_name (String) —

    Name of the container which needs to be

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

    A hash of custom headers that



280
281
282
283
 
# File 'lib/2016-12-01/generated/azure_mgmt_recovery_services_backup/protection_containers.rb', line 280

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

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

Unregisters the given container from your Recovery Services Vault. This is an asynchronous operation. To determine whether the backend service has finished processing the request, call Get Container Operation Result API.

recovery services vault is present. unregistered from 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 where the

  • fabric_name (String) —

    Name of the fabric where the container belongs.

  • container_name (String) —

    Name of the container which needs to be

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
 
# File 'lib/2016-12-01/generated/azure_mgmt_recovery_services_backup/protection_containers.rb', line 323

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

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

Unregisters the given container from your Recovery Services Vault. This is an asynchronous operation. To determine whether the backend service has finished processing the request, call Get Container Operation Result API.

recovery services vault is present. unregistered from 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 where the

  • fabric_name (String) —

    Name of the fabric where the container belongs.

  • container_name (String) —

    Name of the container which needs to be

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



302
303
304
 
# File 'lib/2016-12-01/generated/azure_mgmt_recovery_services_backup/protection_containers.rb', line 302

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