Package com.azure.resourcemanager.dataprotection.models

Interface BackupInstances

public interface BackupInstances

Resource collection API of BackupInstances.

Method Summary

Modifier and Type	Method	Description
OperationJobExtendedInfo	adhocBackup(String vaultName, String resourceGroupName, String backupInstanceName, TriggerBackupRequest parameters)	Trigger adhoc backup.
OperationJobExtendedInfo	adhocBackup(String vaultName, String resourceGroupName, String backupInstanceName, TriggerBackupRequest parameters, com.azure.core.util.Context context)	Trigger adhoc backup.
BackupInstanceResource.DefinitionStages.Blank	define(String name)	Begins definition for a new BackupInstanceResource resource.
void	delete(String vaultName, String resourceGroupName, String backupInstanceName)	Delete a backup instance in a backup vault.
void	delete(String vaultName, String resourceGroupName, String backupInstanceName, com.azure.core.util.Context context)	Delete a backup instance in a backup vault.
void	deleteById(String id)	Delete a backup instance in a backup vault.
void	deleteByIdWithResponse(String id, com.azure.core.util.Context context)	Delete a backup instance in a backup vault.
BackupInstanceResource	get(String vaultName, String resourceGroupName, String backupInstanceName)	Gets a backup instance with name in a backup vault.
BackupInstanceResource	getById(String id)	Gets a backup instance with name in a backup vault.
com.azure.core.http.rest.Response<BackupInstanceResource>	getByIdWithResponse(String id, com.azure.core.util.Context context)	Gets a backup instance with name in a backup vault.
com.azure.core.http.rest.Response<BackupInstanceResource>	getWithResponse(String vaultName, String resourceGroupName, String backupInstanceName, com.azure.core.util.Context context)	Gets a backup instance with name in a backup vault.
com.azure.core.http.rest.PagedIterable<BackupInstanceResource>	list(String vaultName, String resourceGroupName)	Gets a backup instances belonging to a backup vault.
com.azure.core.http.rest.PagedIterable<BackupInstanceResource>	list(String vaultName, String resourceGroupName, com.azure.core.util.Context context)	Gets a backup instances belonging to a backup vault.
void	triggerRehydrate(String resourceGroupName, String vaultName, String backupInstanceName, AzureBackupRehydrationRequest parameters)	rehydrate recovery point for restore for a BackupInstance.
void	triggerRehydrate(String resourceGroupName, String vaultName, String backupInstanceName, AzureBackupRehydrationRequest parameters, com.azure.core.util.Context context)	rehydrate recovery point for restore for a BackupInstance.
OperationJobExtendedInfo	triggerRestore(String vaultName, String resourceGroupName, String backupInstanceName, AzureBackupRestoreRequest parameters)	Triggers restore for a BackupInstance.
OperationJobExtendedInfo	triggerRestore(String vaultName, String resourceGroupName, String backupInstanceName, AzureBackupRestoreRequest parameters, com.azure.core.util.Context context)	Triggers restore for a BackupInstance.
OperationJobExtendedInfo	validateForBackup(String vaultName, String resourceGroupName, ValidateForBackupRequest parameters)	Validate whether adhoc backup will be successful or not.
OperationJobExtendedInfo	validateForBackup(String vaultName, String resourceGroupName, ValidateForBackupRequest parameters, com.azure.core.util.Context context)	Validate whether adhoc backup will be successful or not.
OperationJobExtendedInfo	validateForRestore(String vaultName, String resourceGroupName, String backupInstanceName, ValidateRestoreRequestObject parameters)	Validates if Restore can be triggered for a DataSource.
OperationJobExtendedInfo	validateForRestore(String vaultName, String resourceGroupName, String backupInstanceName, ValidateRestoreRequestObject parameters, com.azure.core.util.Context context)	Validates if Restore can be triggered for a DataSource.

Method Detail

list

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

Gets a backup instances belonging to a backup vault.

Parameters:

vaultName - The name of the backup vault.

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

Returns:

a backup instances belonging to a backup vault.

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<BackupInstanceResource> list(String vaultName,
                                                                    String resourceGroupName,
                                                                    com.azure.core.util.Context context)

Gets a backup instances belonging to a backup vault.

Parameters:

vaultName - The name of the backup vault.

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

context - The context to associate with this operation.

Returns:

a backup instances belonging to a backup vault.

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

BackupInstanceResource get(String vaultName,
                           String resourceGroupName,
                           String backupInstanceName)

Gets a backup instance with name in a backup vault.

Parameters:

vaultName - The name of the backup vault.

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

backupInstanceName - The name of the backup instance.

Returns:

a backup instance with name in a backup vault.

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<BackupInstanceResource> getWithResponse(String vaultName,
                                                                          String resourceGroupName,
                                                                          String backupInstanceName,
                                                                          com.azure.core.util.Context context)

Gets a backup instance with name in a backup vault.

Parameters:

vaultName - The name of the backup vault.

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

backupInstanceName - The name of the backup instance.

context - The context to associate with this operation.

Returns:

a backup instance with name in a backup vault.

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.

delete

void delete(String vaultName,
            String resourceGroupName,
            String backupInstanceName)

Delete a backup instance in a backup vault.

Parameters:

vaultName - The name of the backup vault.

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

backupInstanceName - The name of the backup instance.

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.

delete

void delete(String vaultName,
            String resourceGroupName,
            String backupInstanceName,
            com.azure.core.util.Context context)

Delete a backup instance in a backup vault.

Parameters:

vaultName - The name of the backup vault.

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

backupInstanceName - The name of the backup instance.

context - The context to associate with this operation.

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.

adhocBackup

OperationJobExtendedInfo adhocBackup(String vaultName,
                                     String resourceGroupName,
                                     String backupInstanceName,
                                     TriggerBackupRequest parameters)

Trigger adhoc backup.

Parameters:

vaultName - The name of the backup vault.

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

backupInstanceName - The name of the backup instance.

parameters - Request body for operation.

Returns:

operationJobExtendedInfo.

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.

adhocBackup

OperationJobExtendedInfo adhocBackup(String vaultName,
                                     String resourceGroupName,
                                     String backupInstanceName,
                                     TriggerBackupRequest parameters,
                                     com.azure.core.util.Context context)

Trigger adhoc backup.

Parameters:

vaultName - The name of the backup vault.

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

backupInstanceName - The name of the backup instance.

parameters - Request body for operation.

context - The context to associate with this operation.

Returns:

operationJobExtendedInfo.

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.

validateForBackup

OperationJobExtendedInfo validateForBackup(String vaultName,
                                           String resourceGroupName,
                                           ValidateForBackupRequest parameters)

Validate whether adhoc backup will be successful or not.

Parameters:

vaultName - The name of the backup vault.

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

parameters - Request body for operation.

Returns:

operationJobExtendedInfo.

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.

validateForBackup

OperationJobExtendedInfo validateForBackup(String vaultName,
                                           String resourceGroupName,
                                           ValidateForBackupRequest parameters,
                                           com.azure.core.util.Context context)

Validate whether adhoc backup will be successful or not.

Parameters:

vaultName - The name of the backup vault.

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

parameters - Request body for operation.

context - The context to associate with this operation.

Returns:

operationJobExtendedInfo.

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.

triggerRehydrate

void triggerRehydrate(String resourceGroupName,
                      String vaultName,
                      String backupInstanceName,
                      AzureBackupRehydrationRequest parameters)

rehydrate recovery point for restore for a BackupInstance.

Parameters:

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

vaultName - The name of the backup vault.

backupInstanceName - The backupInstanceName parameter.

parameters - Request body for operation.

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.

triggerRehydrate

void triggerRehydrate(String resourceGroupName,
                      String vaultName,
                      String backupInstanceName,
                      AzureBackupRehydrationRequest parameters,
                      com.azure.core.util.Context context)

rehydrate recovery point for restore for a BackupInstance.

Parameters:

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

vaultName - The name of the backup vault.

backupInstanceName - The backupInstanceName parameter.

parameters - Request body for operation.

context - The context to associate with this operation.

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.

triggerRestore

OperationJobExtendedInfo triggerRestore(String vaultName,
                                        String resourceGroupName,
                                        String backupInstanceName,
                                        AzureBackupRestoreRequest parameters)

Triggers restore for a BackupInstance.

Parameters:

vaultName - The name of the backup vault.

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

backupInstanceName - The name of the backup instance.

parameters - Request body for operation.

Returns:

operationJobExtendedInfo.

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.

triggerRestore

OperationJobExtendedInfo triggerRestore(String vaultName,
                                        String resourceGroupName,
                                        String backupInstanceName,
                                        AzureBackupRestoreRequest parameters,
                                        com.azure.core.util.Context context)

Triggers restore for a BackupInstance.

Parameters:

vaultName - The name of the backup vault.

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

backupInstanceName - The name of the backup instance.

parameters - Request body for operation.

context - The context to associate with this operation.

Returns:

operationJobExtendedInfo.

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.

validateForRestore

OperationJobExtendedInfo validateForRestore(String vaultName,
                                            String resourceGroupName,
                                            String backupInstanceName,
                                            ValidateRestoreRequestObject parameters)

Validates if Restore can be triggered for a DataSource.

Parameters:

vaultName - The name of the backup vault.

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

backupInstanceName - The name of the backup instance.

parameters - Request body for operation.

Returns:

operationJobExtendedInfo.

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.

validateForRestore

OperationJobExtendedInfo validateForRestore(String vaultName,
                                            String resourceGroupName,
                                            String backupInstanceName,
                                            ValidateRestoreRequestObject parameters,
                                            com.azure.core.util.Context context)

Validates if Restore can be triggered for a DataSource.

Parameters:

vaultName - The name of the backup vault.

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

backupInstanceName - The name of the backup instance.

parameters - Request body for operation.

context - The context to associate with this operation.

Returns:

operationJobExtendedInfo.

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.

getById

BackupInstanceResource getById(String id)

Gets a backup instance with name in a backup vault.

Parameters:

id - the resource ID.

Returns:

a backup instance with name in a backup vault.

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.

getByIdWithResponse

com.azure.core.http.rest.Response<BackupInstanceResource> getByIdWithResponse(String id,
                                                                              com.azure.core.util.Context context)

Gets a backup instance with name in a backup vault.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

Returns:

a backup instance with name in a backup vault.

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.

deleteById

void deleteById(String id)

Delete a backup instance in a backup vault.

Parameters:

id - the resource ID.

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.

deleteByIdWithResponse

void deleteByIdWithResponse(String id,
                            com.azure.core.util.Context context)

Delete a backup instance in a backup vault.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

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.

define

BackupInstanceResource.DefinitionStages.Blank define(String name)

Begins definition for a new BackupInstanceResource resource.

Parameters:

name - resource name.

Returns:

the first stage of the new BackupInstanceResource definition.