Manage Your Storage
The archiving functionality is available for the following content sources: Teams & Groups, SharePoint Online, OneDrive, File System, and Google Drive. You can archive content to designated storage locations for a specified retention period.
File System limitations: Soft delete is not supported; the following storage types are not supported: AvePoint Storage, Google Cloud Storage, and Dropbox.
If your organization’s subscription for AvePoint Opus has AvePoint storage enabled, a default storage location AvePoint storage will be available for use. AvePoint storage is hosted by AvePoint on Microsoft Azure Blob Storage or Google Cloud Storage, and has a minimum retention period of 90 days. This storage location resides in the same data center that was selected during your registration to AvePoint Online Services, and its configuration cannot be modified. For the available data centers, refer to Microsoft Azure Cloud Platform and Google Cloud Platform.
You also have the option to use your own storage locations. Opus currently supports the following storage types for BYOS: Amazon S3, Amazon S3-Compatible Storage, Dropbox, FTP, Google Cloud Storage, Microsoft Azure Blob Storage, and SFTP. To ensure optimal performance, AvePoint recommends setting up your storage locations in the same data center as your AvePoint Online Services tenant, as transferring data between different data centers can lead to increased costs and reduced efficiency. For the available data centers, refer to Microsoft Azure Cloud Platform and Google Cloud Platform.
By default, AvePoint Opus compresses and encrypts the archived content. The compression level is preset and cannot be adjusted, while encryption is configured via encryption profiles in AvePoint Online Services. For detailed instructions on encryption profiles, refer to Manage Encryption Profiles.
Create a Custom Storage Location
Refer to the following steps to create a custom storage location:
-
On the Global storage settings page, click Create.
-
Storage location name – Enter a name for this storage location.
-
Description – Enter an optional description for future reference.
-
Storage type – Select a storage type.
-
Storage configuration – Refer to the sections below to complete the detailed settings for the storage type you selected above.
-
Retain archived data – Choose whether to retain the archived data in the storage location using retention rules. If you enable this setting, a scheduled Prune archived data job will prune the archived data that meets the configured retention rules.
Delete the related stubs from the original locations – Choose whether to delete the related stubs from the original locations after the archived data has been deleted from the storage location. This checkbox is selected by default.
*Note: Stubs cannot be deleted from the original locations if they have been renamed or moved to new locations.
Delete the related jobs from Job monitor – Choose whether to delete the related jobs from Job monitor after the archived data has been deleted from the storage location.
Soft delete – You can also select Soft delete and specify a period below if you want to retain the data before permanent deletion to prevent accidental data loss. Soft deleted data can be restored within the retention period if needed.
Keep data for __ __ before permanent deletion – Keep the data for the defined period of time (days, weeks, months, or years).
*Note: Please contact AvePoint Support to enable this feature in the backend if you want to use it. It is unavailable for AvePoint Storage.
- **Change the access** **tier** – This option will be available if you are using your own Microsoft Azure Blob Storage as the storage location. It allows you to change the access tier of the archived data when the retention period has ended.
- **Move data to another storage location** – Select this option if you want to move the archived data to another storage location when the retention period has ended. You need to select a new storage location and set the corresponding retention rules on how to prune the archived data in this new storage location.
- **By** **modified time** – If you are using your own Microsoft Azure Blob Storage as the storage location, you can choose to retain archived data (documents and document versions only) by their modified time.
Prerequisites for this functionality: your organization’s subscription for AvePoint Opus has **Bring your own storage** (BYOS) enabled, and you have contacted AvePoint Support to enable this feature in the backend.
Complete the following settings to set retention rules on how to prune the archived data:
1. **Keep data for __ __** – Keep the archived data for the defined period of time (days, weeks, months, or years).
2. **Delete data** – When the retention period has ended, the archived data will be deleted from the storage location. Additionally, you can choose whether to **Delete the related stubs from the original locations**; this checkbox is selected by default.
7. Click Save to create the storage location.
After creating a storage location, you can click the storage location name to open the storage location for viewing or updating.
To delete a storage location, select the storage location, click Delete, and then click OK in the confirmation window to confirm your operation.
Storage Configuration - Amazon S3
Configure the following settings:
*Note: It is not recommended to activate the archive access tier if you are using S3 Intelligent-Tiering. Activating the archive access tier will cause data object files that have not yet been accessed for 90 days to be archived, and Opus cannot access the archived data in your Amazon S3 storage.
- **Bucket name** – Enter the bucket name you wish to access.
**Note the** **following**:
- The entered name must match an existing bucket. If no bucket is available, refer to [Creating a bucket](https://docs.aws.amazon.com/AmazonS3/latest/userguide/create-bucket-overview.html) to create one.
> ***Note**: For optimal compatibility, Amazon recommends that you avoid using periods (.) in bucket names. For naming guidelines, refer to [General purpose bucket naming rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html#automatically-created-buckets).
- Ensure the bucket policy in Amazon S3 storage applied to your account contains the following required permissions:
- **Read**: Get Object
- **List**: ListBucket
- **Write**: DeleteObject; PutObject; DeleteObjectVersion
- **Access key ID** – Enter the corresponding access key ID to access the specified bucket. You can view the **Access key ID** from your AWS account.
- **Secret access key** – Enter the corresponding secret key ID to access the specified bucket. You can view the **Secret access key** from your AWS account.
- **Storage region** – Select the storage region of this bucket from the drop-down list. The available regions are:
- **Asia Pacific (Mumbai)**
- **Asia Pacific (Seoul)**
- **Asia Pacific (Singapore)**
- **Asia Pacific (Sydney)**
- **Asia Pacific (Tokyo)**
- **Canada (Central)**
- **EU (Frankfurt)**
- **EU (Ireland)**
- **EU (London)**
- **South America (Sao Paulo)**
- **US East (N. Virginia)**
- **US East (Ohio)**
- **US West (Northern California)**
- **US West (Oregon)**
- **Customized region**
- **Advanced** – Enter the following extended parameters in the text box if necessary. If you have multiple parameters to enter, press **Enter** on your keyboard to separate the parameters.
Refer to the instructions below to add parameters:
- **RetryInterval** – Customize the retry interval when the network connection is interrupted. Enter any positive integer between 0 and 2147483646 (the unit is millisecond). For example, RetryInterval=30000 means that it will attempt to reconnect every 30000 milliseconds.
If you do not configure this parameter, the value is 30000 milliseconds by default.
- **RetryCount** – Customize the reconnection times after the network connection is interrupted. Enter any positive integer between 0 and 2147483646. For example, RetryCount=6 represents when the network connection is interrupted, it can reconnect at most 6 times.
If you do not configure this parameter, the value is 6 by default.
- **enablessl=true** – Configure to enable SSL for the backups stored on this physical device.
- **CustomizedRegion** – Configure the customized region of the physical device. For example, enter **CustomizedRegion=s3-us-gov-west-1.amazonaws.com** to configure the GovCloud account.
Storage Configuration - Amazon S3-Compatible Storage
Configure the following settings:
- **Bucket name** – Enter the bucket name you wish to access.
**Note the** **following**:
- The entered name must match an existing bucket. If no bucket is available, refer to [Creating a bucket](https://docs.aws.amazon.com/AmazonS3/latest/userguide/create-bucket-overview.html) to create one.
> ***Note**: For optimal compatibility, Amazon recommends that you avoid using periods (.) in bucket names. For naming guidelines, refer to [General purpose bucket naming rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html#automatically-created-buckets).
- Ensure the bucket policy in Amazon S3-Compatible Storage applied to your account contains the following required permissions:
- **Read**: Get Object
- **List**: ListBucket
- **Write**: DeleteObject; PutObject; DeleteObjectVersion
- **Access key ID** – Enter the corresponding access key ID to access the specified bucket.
- **Secret access key** – Enter the corresponding secret key ID to access the specified bucket.
- **Endpoint** – Enter the URL used to connect to the place where you want to store the data.
> ***Note**: The URL must begin with “http://” or “https://”.
- **Advanced** – Enter the following extended parameters in the text box if necessary. If you have multiple parameters to enter, press **Enter** on your keyboard to separate the parameters.
Refer to the instructions below to add parameters:
- **RetryInterval** – Customize the retry interval when the network connection is interrupted. Enter any positive integer between 0 and 2147483646 (the unit is millisecond). For example, RetryInterval=30000 means that it will attempt to reconnect every 30000 milliseconds.
If you do not configure this parameter, the value is 30000 milliseconds by default.
- **RetryCount** – Customize the reconnection times after the network connection is interrupted. Enter any positive integer between 0 and 2147483646. For example, RetryCount=6 represents when the network connection is interrupted, it can reconnect at most 6 times.
If you do not configure this parameter, the value is 6 by default.
Storage Configuration - Dropbox
Complete the following settings:
- **Root** **folder** **name** – Enter a name for the root folder, which will be created in Dropbox and used to store the data.
- **Token secret** – Click **Retrieve** **token**. Enter the email address and the password of the Dropbox account in the pop-up window to log into Dropbox, and then the token will appear in this pop-up window. Enter the token that appeared in the **Token secret** text box.
- **Advanced** – Enter the following extended parameters in the text box if necessary. If you have multiple parameters to enter, press **Enter** on your keyboard to separate the parameters.
Refer to the instructions below to add parameters:
- **RetryInterval** – Customize the retry interval when the network connection is interrupted. You are allowed to enter any positive integer between 0 and 2147483646 (the unit is in milliseconds). For example, RetryInterval=30000 means that it will attempt to reconnect every 30000 milliseconds.
If you do not configure this parameter, the value is 30000 milliseconds by default.
- **RetryCount** – Customize the reconnection times after the network connection is interrupted. You are allowed to enter any positive integer between 0 and 2147483646. For example, RetryCount=10 represents when the network connection is interrupted, it can reconnect at most 10 times.
If you do not configure this parameter, the value is 6 by default.
Storage Configuration - FTP
Complete the following settings:
- **Host** – Enter the IP address of the FTP server.
- **Port** – Enter the port to use to connect to this FTP server.
- **Folder** – Enter the folder where exported data will be stored on the FTP server.
- **Username** – Enter the username to use to connect to this FTP server.
- **Password** – Enter the password of the specified username.
- **Advanced** – Enter the following extended parameters in the text box if necessary. If you have multiple parameters to enter, press **Enter** on the keyboard to separate the parameters.
Refer to the instructions below to add parameters:
- **RetryInterval** – Customize the retry interval when the network connection is interrupted. You are allowed to enter any positive integer between 0 and 2147483646 (the unit is second). For example, RetryInterval=30 means that it will attempt to reconnect every 30 seconds.
If you do not configure this parameter, the value is 30 seconds by default.
- **RetryCount** – Customize the reconnection times after the network connection is interrupted. You are allowed to enter any positive integer between 0 and 2147483646. For example, RetryCount=60 represents when the network connection is interrupted, it can reconnect at most 60 times.
If you do not configure this parameter, the value is 6 by default.
- **IsRetry** – If you want to try again when Opus failed to write the data in the physical device.
- If you enter **IsRetry=true**, it will try again when Opus failed to write the data in the physical device.
- If you enter **IsRetry=false**, it will not try again when Opus failed to write the data in the physical device.
Storage Configuration - Google Cloud Storage
Complete the following settings:
- **Service** **account** **email** – Enter the email address of a service account that has the permission to access your bucket.
- **Private** **key** – Enter a private key that is associated with the service account.
- **Project** **ID** – Enter the ID of a project that is associated with your bucket.
- **Bucket** **name** – Enter a bucket name.
- **Advanced** – Enter the following extended parameters in the text box if necessary. If you have multiple parameters to enter, press **Enter** on your keyboard to separate the parameters.
- **Projection** – Customize the projections that can be specified as options in various operations. You can set this value to **Full** if you want to include all properties, or set this value to **NoAcl** if you want to omit the ACL (Access Control List) property.
- **PredefinedAcl** – Customize a pre-defined ACL of the bucket for simple access control scenarios. The following values are available for this parameter:
- **AuthenticatedRead** – This value represents that the object owner gets owner access and all authenticated users get reader access.
- **Private** – This value represents that the object owner gets owner access.
- **ProjectPrivate** – This value represents that the object owner gets owner access, and project team members get access according to their roles.
- **PublicRead** – This value represents that the object owner gets owner access, and all users get reader access.
- **PublicReadWrite** – This value represents that the object owner gets owner access, and all users get writer access.
- **PredefinedDefaultObjectAcl** – Customize predefined access control lists (ACLs) that can be specified when creating or updating objects. The following values are available for this parameter:
- **AuthenticatedRead** – This value represents that the object owner gets owner access and all authenticated users get reader access.
- **BucketOwnerFullControl** – This value represents that the object owner gets owner access and all authenticated users get reader access.
- **BucketOwnerRead** – This value represents that the object owner gets owner access and project team owners get reader access.
- **Private** – This value represents that the object owner gets owner access.
- **ProjectPrivate** – This value represents that the object owner gets owner access and project team members get access according to their roles.
- **PublicRead** – This value represents that the object owner gets owner access and all users get reader access.
- **Prefix** – Set this value to the string which the bucket name starts with.
Storage Configuration - Azure Blob Storage
Complete the following settings:
- **Access point** – Enter the URL for the Blob Storage Service. The default URL is *http://blob.core.windows.net*.
- **Container name** – Enter the container name you wish to access.
- **Account name** – Enter the corresponding account name to access the specified container.
- **Account key** – Enter the corresponding account key to access the specified container.
- **Advanced** – Enter the following extended parameters in the text box if necessary. If you have multiple parameters to enter, press **Enter** on your keyboard to separate the parameters.
Refer to the instructions below to add parameters:
- **RetryInterval** – Customize the retry interval when the network connection is interrupted. You are allowed to enter any positive integer between 0 and 2147483646 (the unit is millisecond). For example, RetryInterval=30000 means that it will attempt to reconnect every 30000 milliseconds.
If you do not configure this parameter, the value is 30000 milliseconds by default.
- **RetryCount** – Customize the reconnection times after the network connection is interrupted. You are allowed to enter any positive integer between 0 and 2147483646. For example, RetryCount=10 represents when the network connection is interrupted, it can reconnect at most 10 times.
If you do not configure this parameter, the value is 6 by default.
Storage Configuration - SFTP
Complete the following settings:
- **Host** – Enter the IP address or host name of the SFTP server.
- **Port** – Enter the port of the SFTP server.
- **Root folder** – Enter the folder where exported data will be stored on the SFTP server.
- **Username** – Enter the username of the account that can use SFTP.
- **Password** – Enter the corresponding password of the user used to access the root folder.
> ***Note**: The password is the highest priority. If the password is not provided, the system will check the private key and private key password.
- **Private key file** – If the SFTP server supports the private key file, click **Browse** to upload a private key file.
- **Private key password** – Enter the corresponding password of the uploaded private key file.
- **Advanced** – Enter the following extended parameters in the text box if necessary. If you have multiple parameters to enter, press **Enter** on the keyboard to separate the parameters.
Refer to the instructions below to add parameters:
- **RetryInterval** – Customize the retry interval when the network connection is interrupted. Enter any positive integer between 0 and 2147483646 (the unit is millisecond). For example, RetryInterval=30000 means that it will attempt to reconnect every 30000 milliseconds.
If you do not configure this parameter, the value is 30000 milliseconds by default.
- **RetryCount** – Customize the reconnection times after the network connection is interrupted. Enter any positive integer between 0 and 2147483646. For example, RetryCount=6 represents when the network connection is interrupted, it can reconnect at most 6 times.
If you do not configure this parameter, the value is 6 by default.
Set Default Storage
Regardless of whether you choose Bring your own storage (BYOS) or AvePoint storage for your AvePoint Opus subscription, you are required to set a default storage. This default storage is used to store the index of archived data. To set a storage location as the default, select the desired storage location, click Set default, and then click OK in the confirmation window to confirm your operation. Once set, a Default tag will appear next to the storage location name.
Allow AvePoint Agent Servers to Access Your Storage Account
If you are using or plan to use your own storage device, read the instructions in this section carefully and complete the settings as needed. Otherwise, you can skip this topic.
When you are using your own storage device, you may have set up the storage firewall to only allow trusted clients for security concerns. To ensure that AvePoint Opus can access your storage, complete the settings as required in the following conditions:
*Note: If you are using a trial subscription and the storage account you want to use in the trial has a firewall enabled, read the conditions below and contact AvePoint Support for the corresponding reserved IP addresses or ARM vNet IDs.
- If you are using Microsoft Azure storage, refer to the following:
- **If your storage account is in the same data center as the one you use to sign up for AvePoint Online Services or your storage account is in its** [paired region](https://learn.microsoft.com/en-us/azure/reliability/cross-region-replication-azure#azure-paired-regions), you must add the Azure Resource Manager (ARM) vNet subnets where the AvePoint agents are running on to your storage networking.
You can find additional details in this Microsoft article: [Grant access from a virtual network](https://docs.microsoft.com/en-us/azure/storage/common/storage-network-security?toc=%2Fazure%2Fvirtual-network%2Ftoc.json&tabs=azure-portal#grant-access-from-a-virtual-network), and get the subnet ID of AvePoint Opus for your data center from [Download ARM Vnet IDs](https://cdn.avepoint.com/assets/webhelp/avepoint-online-services/index.htm#!Documents/downloadarmvnetids.htm). For detailed instructions on adding ARM virtual networks, please contact AvePoint Support for assistance.
- **Other than the condition above**, you need to add the reserved IP addresses to the Azure storage firewall.
For detailed instructions, refer to [Download a List of Reserved IP Addresses](https://cdn.avepoint.com/assets/webhelp/avepoint-online-services/index.htm#!Documents/downloadalistofreservedipaddresses.htm) and [Add Reserved IP Addresses](https://cdn.avepoint.com/assets/webhelp/avepoint-online-services/index.htm#!Documents/addreservedipaddresses.htm).
- If you are using Amazon S3 in Southeast Asia (Singapore) data center, you need to add all the reserved IP addresses and specific VPC ID to the bucket policy. For details, refer to the **Add Reserved IP Addresses and VPC ID to Amazon S3 Bucket Policy** section in [Allow AvePoint Agent Servers to Access Your Storage Account](https://cdn.avepoint.com/assets/webhelp/avepoint-cloud-backup-for-microsoft365/index.htm#!Documents/allowavepointagentserverstoaccessyourstorageaccount.htm).
- If you are using a storage type other than Microsoft Azure storage and Amazon S3, you must add the reserved IP addresses to your storage firewall.
For detailed instructions, refer to [Download a List of Reserved IP Addresses](https://cdn.avepoint.com/assets/webhelp/avepoint-online-services/index.htm#!Documents/downloadalistofreservedipaddresses.htm) and [Add Reserved IP Addresses](https://cdn.avepoint.com/assets/webhelp/avepoint-online-services/index.htm#!Documents/addreservedipaddresses.htm).
