Class: Azure::RecoveryServicesBackup::Mgmt::V2017_07_01::ProtectionIntentOperations

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2017-07-01/generated/azure_mgmt_recovery_services_backup/protection_intent_operations.rb

Overview

Open API 2.0 Specs for Azure RecoveryServices Backup service

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ ProtectionIntentOperations

Creates and initializes a new instance of the ProtectionIntentOperations class.

Parameters:

  • client —

    service class for accessing basic functionality.



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

def client
  @client
end

Instance Method Details

#create_or_update(vault_name, resource_group_name, fabric_name, intent_object_name, parameters, custom_headers: nil) ⇒ ProtectionIntentResource

Create Intent for Enabling backup of an item. This is a synchronous 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 backup item.

  • intent_object_name (String) —

    Intent object name.

  • parameters (ProtectionIntentResource) —

    resource backed up item

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

    A hash of custom headers that

Returns:

  • (ProtectionIntentResource) —

    operation results.



156
157
158
159
 
# File 'lib/2017-07-01/generated/azure_mgmt_recovery_services_backup/protection_intent_operations.rb', line 156

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

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

Create Intent for Enabling backup of an item. This is a synchronous 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 backup item.

  • intent_object_name (String) —

    Intent object name.

  • parameters (ProtectionIntentResource) —

    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.



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
255
256
257
258
 
# File 'lib/2017-07-01/generated/azure_mgmt_recovery_services_backup/protection_intent_operations.rb', line 195

def create_or_update_async(vault_name, resource_group_name, fabric_name, intent_object_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, 'intent_object_name is nil' if intent_object_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::V2017_07_01::Models::ProtectionIntentResource.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}/backupProtectionIntent/{intentObjectName}'

  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,'intentObjectName' => intent_object_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
      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::V2017_07_01::Models::ProtectionIntentResource.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, fabric_name, intent_object_name, parameters, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Create Intent for Enabling backup of an item. This is a synchronous 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 backup item.

  • intent_object_name (String) —

    Intent object name.

  • parameters (ProtectionIntentResource) —

    resource backed up item

  • 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/2017-07-01/generated/azure_mgmt_recovery_services_backup/protection_intent_operations.rb', line 176

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

#validate(azure_region, parameters, custom_headers: nil) ⇒ PreValidateEnableBackupResponse

It will validate followings

  1. Vault capacity

  2. VM is already protected

  3. Any VM related configuration passed in properties.

request on Virtual Machine will be added to the HTTP request.

Parameters:

  • azure_region (String) —

    Azure region to hit Api

  • parameters (PreValidateEnableBackupRequest) —

    Enable backup validation

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

    A hash of custom headers that

Returns:

  • (PreValidateEnableBackupResponse) —

    operation results.



42
43
44
45
 
# File 'lib/2017-07-01/generated/azure_mgmt_recovery_services_backup/protection_intent_operations.rb', line 42

def validate(azure_region, parameters, custom_headers:nil)
  response = validate_async(azure_region, parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#validate_async(azure_region, parameters, custom_headers: nil) ⇒ Concurrent::Promise

It will validate followings

  1. Vault capacity

  2. VM is already protected

  3. Any VM related configuration passed in properties.

request on Virtual Machine to the HTTP request.

Parameters:

  • azure_region (String) —

    Azure region to hit Api

  • parameters (PreValidateEnableBackupRequest) —

    Enable backup validation

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



79
80
81
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
138
139
 
# File 'lib/2017-07-01/generated/azure_mgmt_recovery_services_backup/protection_intent_operations.rb', line 79

def validate_async(azure_region, parameters, custom_headers:nil)
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, 'azure_region is nil' if azure_region.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'parameters is nil' if parameters.nil?


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?

  # Serialize Request
  request_mapper = Azure::RecoveryServicesBackup::Mgmt::V2017_07_01::Models::PreValidateEnableBackupRequest.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}/providers/Microsoft.RecoveryServices/locations/{azureRegion}/backupPreValidateProtection'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'azureRegion' => azure_region,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:post, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 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::V2017_07_01::Models::PreValidateEnableBackupResponse.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

#validate_with_http_info(azure_region, parameters, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

It will validate followings

  1. Vault capacity

  2. VM is already protected

  3. Any VM related configuration passed in properties.

request on Virtual Machine will be added to the HTTP request.

Parameters:

  • azure_region (String) —

    Azure region to hit Api

  • parameters (PreValidateEnableBackupRequest) —

    Enable backup validation

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



61
62
63
 
# File 'lib/2017-07-01/generated/azure_mgmt_recovery_services_backup/protection_intent_operations.rb', line 61

def validate_with_http_info(azure_region, parameters, custom_headers:nil)
  validate_async(azure_region, parameters, custom_headers:custom_headers).value!
end