Package com.azure.resourcemanager.dataprotection.models

Interface BackupInstances

public interface BackupInstances
Resource collection API of BackupInstances.

  • Method Details

    • list

      com.azure.core.http.rest.PagedIterable<BackupInstanceResource> list(String resourceGroupName, String vaultName)
      Gets a backup instances belonging to a backup vault.
      Parameters:
      resourceGroupName - The name of the resource group where the backup vault is present.
      vaultName - The name of the backup vault.
      Returns:
      a backup instances belonging to a backup vault 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<BackupInstanceResource> list(String resourceGroupName, String vaultName, com.azure.core.util.Context context)
      Gets a backup instances belonging to a backup vault.
      Parameters:
      resourceGroupName - The name of the resource group where the backup vault is present.
      vaultName - The name of the backup vault.
      context - The context to associate with this operation.
      Returns:
      a backup instances belonging to a backup vault 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.

    • getWithResponse

      com.azure.core.http.rest.Response<BackupInstanceResource> getWithResponse(String resourceGroupName, String vaultName, String backupInstanceName, com.azure.core.util.Context context)
      Gets a backup instance with name in a backup vault.
      Parameters:
      resourceGroupName - The name of the resource group where the backup vault is present.
      vaultName - The name of the backup vault.
      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 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.

    • get

      BackupInstanceResource get(String resourceGroupName, String vaultName, String backupInstanceName)
      Gets a backup instance with name in a backup vault.
      Parameters:
      resourceGroupName - The name of the resource group where the backup vault is present.
      vaultName - The name of the backup vault.
      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.

    • delete

      void delete(String resourceGroupName, String vaultName, String backupInstanceName)
      Delete a backup instance in a backup vault.
      Parameters:
      resourceGroupName - The name of the resource group where the backup vault is present.
      vaultName - The name of the backup vault.
      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 resourceGroupName, String vaultName, String backupInstanceName, com.azure.core.util.Context context)
      Delete a backup instance in a backup vault.
      Parameters:
      resourceGroupName - The name of the resource group where the backup vault is present.
      vaultName - The name of the backup vault.
      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 resourceGroupName, String vaultName, String backupInstanceName, TriggerBackupRequest parameters)
      Trigger adhoc backup.
      Parameters:
      resourceGroupName - The name of the resource group where the backup vault is present.
      vaultName - The name of the backup vault.
      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 resourceGroupName, String vaultName, String backupInstanceName, TriggerBackupRequest parameters, com.azure.core.util.Context context)
      Trigger adhoc backup.
      Parameters:
      resourceGroupName - The name of the resource group where the backup vault is present.
      vaultName - The name of the backup vault.
      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 resourceGroupName, String vaultName, ValidateForBackupRequest parameters)
      Validate whether adhoc backup will be successful or not.
      Parameters:
      resourceGroupName - The name of the resource group where the backup vault is present.
      vaultName - The name of the backup vault.
      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 resourceGroupName, String vaultName, ValidateForBackupRequest parameters, com.azure.core.util.Context context)
      Validate whether adhoc backup will be successful or not.
      Parameters:
      resourceGroupName - The name of the resource group where the backup vault is present.
      vaultName - The name of the backup vault.
      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.

    • getBackupInstanceOperationResultWithResponse

      com.azure.core.http.rest.Response<BackupInstanceResource> getBackupInstanceOperationResultWithResponse(String resourceGroupName, String vaultName, String backupInstanceName, String operationId, com.azure.core.util.Context context)
      Get result of backup instance creation operation.
      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.
      operationId - The operationId parameter.
      context - The context to associate with this operation.
      Returns:
      result of backup instance creation operation 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.

    • getBackupInstanceOperationResult

      BackupInstanceResource getBackupInstanceOperationResult(String resourceGroupName, String vaultName, String backupInstanceName, String operationId)
      Get result of backup instance creation operation.
      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.
      operationId - The operationId parameter.
      Returns:
      result of backup instance creation 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)
      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 resourceGroupName, String vaultName, String backupInstanceName, AzureBackupRestoreRequest parameters)
      Triggers 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 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 resourceGroupName, String vaultName, String backupInstanceName, AzureBackupRestoreRequest parameters, com.azure.core.util.Context context)
      Triggers 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 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.

    • resumeBackups

      void resumeBackups(String resourceGroupName, String vaultName, String backupInstanceName)
      This operation will resume backups for backup instance.
      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.
      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.

    • resumeBackups

      void resumeBackups(String resourceGroupName, String vaultName, String backupInstanceName, com.azure.core.util.Context context)
      This operation will resume backups for backup instance.
      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.
      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.

    • resumeProtection

      void resumeProtection(String resourceGroupName, String vaultName, String backupInstanceName)
      This operation will resume protection for a stopped backup instance.
      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.
      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.

    • resumeProtection

      void resumeProtection(String resourceGroupName, String vaultName, String backupInstanceName, com.azure.core.util.Context context)
      This operation will resume protection for a stopped backup instance.
      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.
      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.

    • stopProtection

      void stopProtection(String resourceGroupName, String vaultName, String backupInstanceName)
      This operation will stop protection of a backup instance and data will be held forever.
      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.
      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.

    • stopProtection

      void stopProtection(String resourceGroupName, String vaultName, String backupInstanceName, com.azure.core.util.Context context)
      This operation will stop protection of a backup instance and data will be held forever.
      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.
      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.

    • suspendBackups

      void suspendBackups(String resourceGroupName, String vaultName, String backupInstanceName)
      This operation will stop backup for a backup instance and retains the backup data as per the policy (except latest Recovery point, which will be retained forever).
      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.
      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.

    • suspendBackups

      void suspendBackups(String resourceGroupName, String vaultName, String backupInstanceName, com.azure.core.util.Context context)
      This operation will stop backup for a backup instance and retains the backup data as per the policy (except latest Recovery point, which will be retained forever).
      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.
      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.

    • syncBackupInstance

      void syncBackupInstance(String resourceGroupName, String vaultName, String backupInstanceName, SyncBackupInstanceRequest parameters)
      Sync backup instance again in case of failure This action will retry last failed operation and will bring backup instance to valid state.
      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.

    • syncBackupInstance

      void syncBackupInstance(String resourceGroupName, String vaultName, String backupInstanceName, SyncBackupInstanceRequest parameters, com.azure.core.util.Context context)
      Sync backup instance again in case of failure This action will retry last failed operation and will bring backup instance to valid state.
      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.

    • validateForRestore

      OperationJobExtendedInfo validateForRestore(String resourceGroupName, String vaultName, String backupInstanceName, ValidateRestoreRequestObject parameters)
      Validates if Restore can be triggered for a DataSource.
      Parameters:
      resourceGroupName - The name of the resource group where the backup vault is present.
      vaultName - The name of the backup vault.
      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 resourceGroupName, String vaultName, String backupInstanceName, ValidateRestoreRequestObject parameters, com.azure.core.util.Context context)
      Validates if Restore can be triggered for a DataSource.
      Parameters:
      resourceGroupName - The name of the resource group where the backup vault is present.
      vaultName - The name of the backup vault.
      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 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.

    • 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 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.

    • 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.