Class: Azure::RecoveryServicesBackup::Mgmt::V2016_06_01::BackupEngines

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

Parameters:

  • client —

    service class for accessing basic functionality.



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

def client
  @client
end

Instance Method Details

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

The backup management servers registered to a Recovery Services vault. This returns a pageable list of servers.

with the Recovery Services vault. management server. backupManagementType { AzureIaasVM, 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) —

    Use this filter to choose the specific backup

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

    The Skip Token filter.

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

    A hash of custom headers that

Returns:

  • (Array<BackupEngineBaseResource>) —

    operation results.



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

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

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

The backup management servers registered to a Recovery Services vault. This returns a pageable list of servers.

with the Recovery Services vault. management server. backupManagementType { AzureIaasVM, MAB, DPM, AzureBackupServer, AzureSql }. will be added to the HTTP request.

the response.

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) —

    Use this filter to choose the specific backup

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

    The Skip Token filter.

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

    A hash of custom headers that

Returns:

  • (BackupEngineBaseResourceList) —

    which provide lazy access to pages of



250
251
252
253
254
255
256
257
258
259
 
# File 'lib/2016-06-01/generated/azure_mgmt_recovery_services_backup/backup_engines.rb', line 250

def get_as_lazy(vault_name, resource_group_name, filter:nil, skip_token:nil, custom_headers:nil)
  response = get_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|
      get_next_async(next_page_link, custom_headers:custom_headers)
    end
    page
  end
end

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

The backup management servers registered to a Recovery Services vault. This returns a pageable list of servers.

with the Recovery Services vault. management server. backupManagementType { AzureIaasVM, 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) —

    Use this filter to choose the specific backup

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

    The Skip Token filter.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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

def get_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_06_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

#get_next(next_page_link, custom_headers: nil) ⇒ BackupEngineBaseResourceList

The backup management servers registered to a Recovery Services vault. This returns a pageable list of servers.

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

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful call

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

    A hash of custom headers that

Returns:

  • (BackupEngineBaseResourceList) —

    operation results.



151
152
153
154
 
# File 'lib/2016-06-01/generated/azure_mgmt_recovery_services_backup/backup_engines.rb', line 151

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

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

The backup management servers registered to a Recovery Services vault. This returns a pageable list of servers.

to List operation. to the HTTP request.

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful call

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



182
183
184
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
 
# File 'lib/2016-06-01/generated/azure_mgmt_recovery_services_backup/backup_engines.rb', line 182

def get_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_06_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

#get_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

The backup management servers registered to a Recovery Services vault. This returns a pageable list of servers.

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

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful call

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



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

def get_next_with_http_info(next_page_link, custom_headers:nil)
  get_next_async(next_page_link, custom_headers:custom_headers).value!
end

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

The backup management servers registered to a Recovery Services vault. This returns a pageable list of servers.

with the Recovery Services vault. management server. backupManagementType { AzureIaasVM, 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) —

    Use this filter to choose the specific backup

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

    The Skip Token filter.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



65
66
67
 
# File 'lib/2016-06-01/generated/azure_mgmt_recovery_services_backup/backup_engines.rb', line 65

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