Class: Azure::RecoveryServicesBackup::Mgmt::V2016_12_01::BackupEngines

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

Overview

Open API 2.0 Specs for Azure RecoveryServices Backup service

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ BackupEngines

Creates and initializes a new instance of the BackupEngines class.



21
22
23
 
# File 'lib/2016-12-01/generated/azure_mgmt_recovery_services_backup/backup_engines.rb', line 21

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ RecoveryServicesBackupClient (readonly) 



26
27
28
 
# File 'lib/2016-12-01/generated/azure_mgmt_recovery_services_backup/backup_engines.rb', line 26

def client
  @client
end

Instance Method Details

#get(vault_name, resource_group_name, backup_engine_name, filter: nil, skip_token: nil, custom_headers: nil) ⇒ BackupEngineBaseResource

Returns backup management server registered to Recovery Services Vault.

recovery services vault is present. will be added to the HTTP request.



148
149
150
151
 
# File 'lib/2016-12-01/generated/azure_mgmt_recovery_services_backup/backup_engines.rb', line 148

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

#get_async(vault_name, resource_group_name, backup_engine_name, filter: nil, skip_token: nil, custom_headers: nil) ⇒ Concurrent::Promise

Returns backup management server registered to Recovery Services Vault.

recovery services vault is present. to the HTTP request.



185
186
187
188
189
190
191
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
 
# File 'lib/2016-12-01/generated/azure_mgmt_recovery_services_backup/backup_engines.rb', line 185

def get_async(vault_name, resource_group_name, backup_engine_name, filter:nil, skip_token: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, 'backup_engine_name is nil' if backup_engine_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}/backupEngines/{backupEngineName}'

  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,'backupEngineName' => backup_engine_name},
      query_params: {'api-version' => @client.api_version,'$filter' => filter,'$skipToken' => skip_token},
      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::BackupEngineBaseResource.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, backup_engine_name, filter: nil, skip_token: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Returns backup management server registered to Recovery Services Vault.

recovery services vault is present. will be added to the HTTP request.



167
168
169
 
# File 'lib/2016-12-01/generated/azure_mgmt_recovery_services_backup/backup_engines.rb', line 167

def get_with_http_info(vault_name, resource_group_name, backup_engine_name, filter:nil, skip_token:nil, custom_headers:nil)
  get_async(vault_name, resource_group_name, backup_engine_name, filter:filter, skip_token:skip_token, custom_headers:custom_headers).value!
end

#list(vault_name, resource_group_name, filter: nil, skip_token: nil, custom_headers: nil) ⇒ Array<BackupEngineBaseResource>

Backup management servers registered to Recovery Services Vault. Returns a pageable list of servers.

recovery services vault is present. will be added to the HTTP request.



42
43
44
45
 
# File 'lib/2016-12-01/generated/azure_mgmt_recovery_services_backup/backup_engines.rb', line 42

def list(vault_name, resource_group_name, filter:nil, skip_token:nil, custom_headers:nil)
  first_page = list_as_lazy(vault_name, resource_group_name, filter:filter, skip_token:skip_token, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_as_lazy(vault_name, resource_group_name, filter: nil, skip_token: nil, custom_headers: nil) ⇒ BackupEngineBaseResourceList

Backup management servers registered to Recovery Services Vault. Returns a pageable list of servers.

recovery services vault is present. will be added to the HTTP request.

the response.



349
350
351
352
353
354
355
356
357
358
 
# File 'lib/2016-12-01/generated/azure_mgmt_recovery_services_backup/backup_engines.rb', line 349

def list_as_lazy(vault_name, resource_group_name, filter:nil, skip_token:nil, custom_headers:nil)
  response = list_async(vault_name, resource_group_name, filter:filter, skip_token:skip_token, custom_headers:custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_next_async(next_page_link, custom_headers:custom_headers)
    end
    page
  end
end

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

Backup management servers registered to Recovery Services Vault. Returns a pageable list of servers.

recovery services vault is present. to the HTTP request.



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
 
# File 'lib/2016-12-01/generated/azure_mgmt_recovery_services_backup/backup_engines.rb', line 79

def list_async(vault_name, resource_group_name, filter:nil, skip_token: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}/backupEngines'

  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,'$skipToken' => skip_token},
      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::BackupEngineBaseResourceList.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_next(next_page_link, custom_headers: nil) ⇒ BackupEngineBaseResourceList

Backup management servers registered to Recovery Services Vault. Returns a pageable list of servers.

to List operation. will be added to the HTTP request.



252
253
254
255
 
# File 'lib/2016-12-01/generated/azure_mgmt_recovery_services_backup/backup_engines.rb', line 252

def list_next(next_page_link, custom_headers:nil)
  response = list_next_async(next_page_link, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#list_next_async(next_page_link, custom_headers: nil) ⇒ Concurrent::Promise

Backup management servers registered to Recovery Services Vault. Returns a pageable list of servers.

to List operation. to the HTTP request.



283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
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
 
# File 'lib/2016-12-01/generated/azure_mgmt_recovery_services_backup/backup_engines.rb', line 283

def list_next_async(next_page_link, custom_headers:nil)
  fail ArgumentError, 'next_page_link is nil' if next_page_link.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 = '{nextLink}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      skip_encoding_path_params: {'nextLink' => next_page_link},
      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::BackupEngineBaseResourceList.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_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Backup management servers registered to Recovery Services Vault. Returns a pageable list of servers.

to List operation. will be added to the HTTP request.



268
269
270
 
# File 'lib/2016-12-01/generated/azure_mgmt_recovery_services_backup/backup_engines.rb', line 268

def list_next_with_http_info(next_page_link, custom_headers:nil)
  list_next_async(next_page_link, custom_headers:custom_headers).value!
end

#list_with_http_info(vault_name, resource_group_name, filter: nil, skip_token: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Backup management servers registered to Recovery Services Vault. Returns a pageable list of servers.

recovery services vault is present. will be added to the HTTP request.



61
62
63
 
# File 'lib/2016-12-01/generated/azure_mgmt_recovery_services_backup/backup_engines.rb', line 61

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