Package com.azure.resourcemanager.dataprotection.models

Interface BackupInstanceResource

public interface BackupInstanceResource
An immutable client-side representation of BackupInstanceResource.

  • Method Details

    • id

      String id()
      Gets the id property: Fully qualified resource Id for the resource.
      Returns:
      the id value.

    • name

      String name()
      Gets the name property: The name of the resource.
      Returns:
      the name value.

    • type

      String type()
      Gets the type property: The type of the resource.
      Returns:
      the type value.

    • tags

      Map<String,String> tags()
      Gets the tags property: Proxy Resource tags.
      Returns:
      the tags value.

    • systemData

      com.azure.core.management.SystemData systemData()
      Gets the systemData property: Metadata pertaining to creation and last modification of the resource.
      Returns:
      the systemData value.

    • properties

      BackupInstance properties()
      Gets the properties property: BackupInstanceResource properties.
      Returns:
      the properties value.

    • resourceGroupName

      String resourceGroupName()
      Gets the name of the resource group.
      Returns:
      the name of the resource group.

    • innerModel

      BackupInstanceResourceInner innerModel()
      Gets the inner com.azure.resourcemanager.dataprotection.fluent.models.BackupInstanceResourceInner object.
      Returns:
      the inner object.

    • update

      BackupInstanceResource.Update update()
      Begins update for the BackupInstanceResource resource.
      Returns:
      the stage of resource update.

    • refresh

      BackupInstanceResource refresh()
      Refreshes the resource to sync with Azure.
      Returns:
      the refreshed resource.

    • refresh

      BackupInstanceResource refresh(com.azure.core.util.Context context)
      Refreshes the resource to sync with Azure.
      Parameters:
      context - The context to associate with this operation.
      Returns:
      the refreshed resource.

    • adhocBackup

      OperationJobExtendedInfo adhocBackup(TriggerBackupRequest parameters)
      Trigger adhoc backup.
      Parameters:
      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(TriggerBackupRequest parameters, com.azure.core.util.Context context)
      Trigger adhoc backup.
      Parameters:
      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(AzureBackupRehydrationRequest parameters)
      rehydrate recovery point for restore for a BackupInstance.
      Parameters:
      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(AzureBackupRehydrationRequest parameters, com.azure.core.util.Context context)
      rehydrate recovery point for restore for a BackupInstance.
      Parameters:
      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(AzureBackupRestoreRequest parameters)
      Triggers restore for a BackupInstance.
      Parameters:
      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(AzureBackupRestoreRequest parameters, com.azure.core.util.Context context)
      Triggers restore for a BackupInstance.
      Parameters:
      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()
      This operation will resume backups for backup instance.
      Throws:
      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(com.azure.core.util.Context context)
      This operation will resume backups for backup instance.
      Parameters:
      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()
      This operation will resume protection for a stopped backup instance.
      Throws:
      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(com.azure.core.util.Context context)
      This operation will resume protection for a stopped backup instance.
      Parameters:
      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()
      This operation will stop protection of a backup instance and data will be held forever.
      Throws:
      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(com.azure.core.util.Context context)
      This operation will stop protection of a backup instance and data will be held forever.
      Parameters:
      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()
      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).
      Throws:
      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(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:
      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(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:
      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(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:
      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(ValidateRestoreRequestObject parameters)
      Validates if Restore can be triggered for a DataSource.
      Parameters:
      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(ValidateRestoreRequestObject parameters, com.azure.core.util.Context context)
      Validates if Restore can be triggered for a DataSource.
      Parameters:
      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.