Package com.azure.resourcemanager.recoveryservicesbackup.models

Interface BackupEngines

public interface BackupEngines

Resource collection API of BackupEngines.

Method Summary

Modifier and Type	Method	Description
BackupEngineBaseResource	get(String vaultName, String resourceGroupName, String backupEngineName)	Returns backup management server registered to Recovery Services Vault.
com.azure.core.http.rest.Response<BackupEngineBaseResource>	getWithResponse(String vaultName, String resourceGroupName, String backupEngineName, String filter, String skipToken, com.azure.core.util.Context context)	Returns backup management server registered to Recovery Services Vault.
com.azure.core.http.rest.PagedIterable<BackupEngineBaseResource>	list(String vaultName, String resourceGroupName)	Backup management servers registered to Recovery Services Vault.
com.azure.core.http.rest.PagedIterable<BackupEngineBaseResource>	list(String vaultName, String resourceGroupName, String filter, String skipToken, com.azure.core.util.Context context)	Backup management servers registered to Recovery Services Vault.

Method Detail

list

com.azure.core.http.rest.PagedIterable<BackupEngineBaseResource> list(String vaultName,
                                                                      String resourceGroupName)

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

Parameters:

vaultName - The name of the recovery services vault.

resourceGroupName - The name of the resource group where the recovery services vault is present.

Returns:

list of BackupEngineBase resources as paginated response with PagedIterable.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

list

com.azure.core.http.rest.PagedIterable<BackupEngineBaseResource> list(String vaultName,
                                                                      String resourceGroupName,
                                                                      String filter,
                                                                      String skipToken,
                                                                      com.azure.core.util.Context context)

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

Parameters:

vaultName - The name of the recovery services vault.

resourceGroupName - The name of the resource group where the recovery services vault is present.

filter - OData filter options.

skipToken - skipToken Filter.

context - The context to associate with this operation.

Returns:

list of BackupEngineBase resources as paginated response with PagedIterable.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

get

BackupEngineBaseResource get(String vaultName,
                             String resourceGroupName,
                             String backupEngineName)

Returns backup management server registered to Recovery Services Vault.

Parameters:

vaultName - The name of the recovery services vault.

resourceGroupName - The name of the resource group where the recovery services vault is present.

backupEngineName - Name of the backup management server.

Returns:

the base backup engine class.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getWithResponse

com.azure.core.http.rest.Response<BackupEngineBaseResource> getWithResponse(String vaultName,
                                                                            String resourceGroupName,
                                                                            String backupEngineName,
                                                                            String filter,
                                                                            String skipToken,
                                                                            com.azure.core.util.Context context)

Returns backup management server registered to Recovery Services Vault.

Parameters:

vaultName - The name of the recovery services vault.

resourceGroupName - The name of the resource group where the recovery services vault is present.

backupEngineName - Name of the backup management server.

filter - OData filter options.

skipToken - skipToken Filter.

context - The context to associate with this operation.

Returns:

the base backup engine class along with Response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.