| title | titleSuffix | description | author | ms.service | ms.topic | ms.date | ms.author | ms.reviewer | ms.devlang | ms.custom |
|---|---|---|---|---|---|---|---|---|---|---|
Archive a blob | Azure Storage | Learn how to create a blob in the archive tier, or move an existing blob to the archive tier. | normesta | azure-blob-storage | how-to | 11/28/2023 | normesta | fryu | powershell | devx-track-azurepowershell, devx-track-azurecli |
The archive tier is an offline tier for storing blob data that is rarely accessed. The archive tier offers the lowest storage costs, but higher data retrieval costs and latency compared to the online tiers (hot and cool). Data must remain in the archive tier for at least 180 days or be subject to an early deletion charge. For more information about the archive tier, see Archive access tier.
While a blob is in the archive tier, it can't be read or modified. To read or download a blob in the archive tier, you must first rehydrate it to an online tier, either hot or cool. Data in the archive tier can take up to 15 hours to rehydrate, depending on the priority you specify for the rehydration operation. For more information about blob rehydration, see Overview of blob rehydration from the archive tier.
Caution
A blob in the archive tier is offline. That is, it cannot be read or modified until it is rehydrated. The rehydration process can take several hours and has associated costs. Before you move data to the archive tier, consider whether taking blob data offline may affect your workflows.
You can use the Azure portal, PowerShell, Azure CLI, or one of the Azure Storage client libraries to manage data archiving.
To archive one ore more blob on upload, create the blob directly in the archive tier.
To archive a blob or set of blobs on upload from the Azure portal, follow these steps:
Navigate to the target container.
Select the Upload button.
Select the file or files to upload.
Expand the Advanced section, and set the Access tier to Archive.
Select the Upload button.
:::image type="content" source="media/archive-blob/upload-blobs-archive-portal.png" alt-text="Screenshot showing how to upload blobs to the archive tier in the Azure portal.":::
To archive a blob or set of blobs on upload with PowerShell, call the Set-AzStorageBlobContent command, as shown in the following example. Remember to replace the placeholder values in brackets with your own values:
$rgName = <resource-group> $storageAccount = <storage-account> $containerName = <container> # Get context object $ctx = New-AzStorageContext -StorageAccountName $storageAccount -UseConnectedAccount # Create new container. New-AzStorageContainer -Name $containerName -Context $ctx # Upload a single file named blob1.txt to the archive tier. Set-AzStorageBlobContent -Container $containerName ` -File "blob1.txt" ` -Blob "blob1.txt" ` -Context $ctx ` -StandardBlobTier Archive # Upload the contents of a sample-blobs directory to the archive tier, recursively. Get-ChildItem -Path "C:\sample-blobs" -File -Recurse | Set-AzStorageBlobContent -Container $containerName ` -Context $ctx ` -StandardBlobTier Archive To archive a single blob on upload with Azure CLI, call the az storage blob upload command, as shown in the following example. Remember to replace the placeholder values in brackets with your own values:
az storage blob upload \ --account-name <storage-account> \ --container-name <container> \ --name <blob> \ --file <file> \ --tier Archive \ --auth-mode login To archive a set of blobs on upload with Azure CLI, call the az storage blob upload-batch command, as shown in the following example. Remember to replace the placeholder values in brackets with your own values:
az storage blob upload-batch \ --destination <container> \ --source <source-directory> \ --account-name <storage-account> \ --tier Archive \ --auth-mode login To archive a single blob on upload with AzCopy, call the azcopy copy command. Provide a local file as the source and the target blob URI as the destination, and specify the archive tier as the target tier, as shown in the following example. Remember to replace the placeholder values in brackets with your own values:
Note
This example encloses path arguments with single quotes (''). Use single quotes in all command shells except for the Windows Command Shell (cmd.exe). If you're using a Windows Command Shell (cmd.exe), enclose path arguments with double quotes ("") instead of single quotes ('').
This example excludes the SAS token because it assumes that you've provided authorization credentials by using Microsoft Entra ID. See the Get started with AzCopy article to learn about the ways that you can provide authorization credentials to the storage service.
azcopy copy 'C:\temp\myTextFile.txt' 'https://<storage-account>.blob.core.windows.net/<container>/myTextFile-archived.txt' --blob-type BlockBlob --block-blob-tier Archive For other examples, see Upload files to Azure Blob storage by using AzCopy.
You can move an existing blob to the archive tier in one of two ways:
You can change a blob's tier with the Set Blob Tier operation. Set Blob Tier moves a single blob from one tier to another.
Keep in mind that when you move a blob to the archive tier with Set Blob Tier, then you can't read or modify the blob's data until you rehydrate the blob. If you may need to read or modify the blob's data before the early deletion interval has elapsed, then consider using a Copy Blob operation to create a copy of the blob in the archive tier.
You can copy a blob in an online tier to the archive tier with the Copy Blob operation. You can call the Copy Blob operation to copy a blob from an online tier (hot or cool) to the archive tier. The source blob remains in the online tier, and you can continue to read or modify its data in the online tier.
Use the Set Blob Tier operation to move a blob from the Hot or cool tier to the archive tier. The Set Blob Tier operation is best for scenarios where you won't need to access the archived data before the early deletion interval has elapsed.
The Set Blob Tier operation changes the tier of a single blob. To move a set of blobs to the archive tier with optimum performance, Microsoft recommends performing a bulk archive operation. The bulk archive operation sends a batch of Set Blob Tier calls to the service in a single transaction. For more information, see Bulk archive.
To move an existing blob to the archive tier in the Azure portal, follow these steps:
Navigate to the blob's container.
Select the blob to archive.
Select the Change tier button.
Select Archive from the Access tier dropdown.
Select Save.
:::image type="content" source="media/archive-blob/set-blob-tier-archive-portal.png" alt-text="Screenshot showing how to set a blob's tier to Archive in the Azure portal":::
To change a blob's tier from hot or cool to Archive with PowerShell, use the blob's BlobClient property to return a .NET reference to the blob, then call the SetAccessTier method on that reference. Remember to replace placeholders in angle brackets with your own values:
# Initialize these variables with your values. $rgName = "<resource-group>" $accountName = "<storage-account>" $containerName = "<container>" $blobName = "<blob>" # Get the storage account context $ctx = (Get-AzStorageAccount ` -ResourceGroupName $rgName ` -Name $accountName).Context # Change the blob's access tier to Archive. $blob = Get-AzStorageBlob -Container $containerName -Blob $blobName -Context $ctx $blob.BlobClient.SetAccessTier("Archive", $null) To change a blob's tier from hot or cool to Archive with Azure CLI, call the az storage blob set-tier command. Remember to replace placeholders in angle brackets with your own values:
az storage blob set-tier \ --account-name <storage-account> \ --container-name <container> \ --name <blob> \ --tier Archive \ --auth-mode login To change a blob's tier from hot or cool to Archive, use the azcopy set-properties command and set the -block-blob-tier parameter to archive.
Important
The ability to change a blob's tier by using AzCopy is currently in PREVIEW. See the Supplemental Terms of Use for Microsoft Azure Previews for legal terms that apply to Azure features that are in beta, preview, or otherwise not yet released into general availability.
Note
This example encloses path arguments with single quotes (''). Use single quotes in all command shells except for the Windows Command Shell (cmd.exe). If you're using a Windows Command Shell (cmd.exe), enclose path arguments with double quotes ("") instead of single quotes ('').
This example excludes the SAS token because it assumes that you've provided authorization credentials by using Microsoft Entra ID. See the Get started with AzCopy article to learn about the ways that you can provide authorization credentials to the storage service.
azcopy set-properties 'https://<storage-account-name>.blob.core.windows.net/<container-name>/<blob-name>' --block-blob-tier=archive To change the access tier for all blobs in a virtual directory, refer to the virtual directory name instead of the blob name, and then append --recursive=true to the command.
azcopy set-properties 'https://<storage-account-name>.blob.core.windows.net/<container-name>/myvirtualdirectory' --block-blob-tier=archive --recursive=true Use the Copy Blob operation to copy a blob from the hot or cool tier to the archive tier. The source blob remains in the hot or cool tier, while the destination blob is created in the archive tier.
A Copy Blob operation is best for scenarios where you may need to read or modify the archived data before the early deletion interval has elapsed. You can access the source blob's data without needing to rehydrate the archived blob.
N/A
To copy a blob from an online tier to the archive tier with PowerShell, call the Start-AzStorageBlobCopy command and specify the archive tier. Remember to replace placeholders in angle brackets with your own values:
# Initialize these variables with your values. $rgName = "<resource-group>" $accountName = "<storage-account>" $srcContainerName = "<source-container>" $destContainerName = "<dest-container>" $srcBlobName = "<source-blob>" $destBlobName = "<dest-blob>" # Get the storage account context $ctx = (Get-AzStorageAccount ` -ResourceGroupName $rgName ` -Name $accountName).Context # Copy the source blob to a new destination blob in archive tier. Start-AzStorageBlobCopy -SrcContainer $srcContainerName ` -SrcBlob $srcBlobName ` -DestContainer $destContainerName ` -DestBlob $destBlobName ` -StandardBlobTier Archive ` -Context $ctx To copy a blob from an online tier to the archive tier with Azure CLI, call the az storage blob copy start command and specify the archive tier. Remember to replace placeholders in angle brackets with your own values:
az storage blob copy start \ --source-container <source-container> \ --source-blob <source-blob> \ --destination-container <dest-container> \ --destination-blob <dest-blob> \ --account-name <storage-account> \ --tier Archive \ --auth-mode login To copy a blob from an online tier to the archive tier with AzCopy, specify the URI for the source blob and the URI for the destination blob. The destination blob should have a different name from the source blob, and shouldn't already exist.
Note
This example encloses path arguments with single quotes (''). Use single quotes in all command shells except for the Windows Command Shell (cmd.exe). If you're using a Windows Command Shell (cmd.exe), enclose path arguments with double quotes ("") instead of single quotes ('').
This example excludes the SAS token because it assumes that you've provided authorization credentials by using Microsoft Entra ID. See the Get started with AzCopy article to learn about the ways that you can provide authorization credentials to the storage service.
Remember to replace placeholders in angle brackets with your own values:
azcopy copy 'https://<source-account>.blob.core.windows.net/sample-container/blob1.txt' 'https://<dest-account>.blob.core.windows.net/sample-container/blob1-archived.txt' --blob-type BlockBlob --block-blob-tier Archive To move blobs to the archive tier in a container or a folder, enumerate blobs and call the Set Blob Tier operation on each one. The following example shows how to perform this operation:
N/A
# Initialize these variables with your values. $rgName = "<resource-group>" $accountName = "<storage-account>" $containerName = "<container>" $folderName = "<folder>/" $ctx = (Get-AzStorageAccount -ResourceGroupName $rgName -Name $accountName).Context $blobCount = 0 $Token = $Null $MaxReturn = 5000 do { $Blobs = Get-AzStorageBlob -Context $ctx -Container $containerName -Prefix $folderName -MaxCount $MaxReturn -ContinuationToken $Token if($Blobs -eq $Null) { break } #Set-StrictMode will cause Get-AzureStorageBlob returns result in different data types when there is only one blob if($Blobs.GetType().Name -eq "AzureStorageBlob") { $Token = $Null } else { $Token = $Blobs[$Blobs.Count - 1].ContinuationToken; } $Blobs | ForEach-Object { if($_.BlobType -eq "BlockBlob") { $_.BlobClient.SetAccessTier("Archive", $null) } } } While ($Token -ne $Null) az storage blob list --account-name $accountName --account-key $key \ --container-name $containerName --prefix $folderName \ --query "[?properties.blobTier == 'Cool'].name" --output tsv \ | xargs -I {} -P 10 \ az storage blob set-tier --account-name $accountName --account-key $key \ --container-name $containerName --tier Archive --name "{}" N/A
When moving a large number of blobs to the archive tier, use a batch operation for optimal performance. A batch operation sends multiple API calls to the service with a single request. The suboperations supported by the Blob Batch operation include Delete Blob and Set Blob Tier.
To archive blobs with a batch operation, use one of the Azure Storage client libraries. The following code example shows how to perform a basic batch operation with the .NET client library:
:::code language="csharp" source="~/azure-storage-snippets/blobs/howto/dotnet/dotnet-v12/AccessTiers.cs" id="Snippet_BulkArchiveContainerContents":::
For an in-depth sample application that shows how to change tiers with a batch operation, see AzBulkSetBlobTier.
You can optimize costs for blob data that is rarely accessed by creating lifecycle management policies that automatically move blobs to the archive tier when they haven't been accessed or modified for a specified period of time. After you configure a lifecycle management policy, Azure Storage runs it once per day. For more information about lifecycle management policies, see Optimize costs by automatically managing the data lifecycle.
You can use the Azure portal, PowerShell, Azure CLI, or an Azure Resource Manager template to create a lifecycle management policy. For simplicity, this section shows how to create a lifecycle management policy in the Azure portal only. For more examples showing how to create lifecycle management policies, see Configure a lifecycle management policy.
Caution
Before you use a lifecycle management policy to move data to the archive tier, verify that that data does not need to be deleted or moved to another tier for at least 180 days. Data that is deleted or moved to a different tier before the 180 day period has elapsed is subject to an early deletion fee.
Also keep in mind that data in the archive tier must be rehydrated before it can be read or modified. Rehydrating a blob from the archive tier can take several hours and has associated costs.
To create a lifecycle management policy to archive blobs in the Azure portal, follow these steps:
Navigate to your storage account in the portal.
Under Data management, locate the Lifecycle management settings.
Select the Add a rule button.
On the Details tab, specify a name for your rule.
Specify the rule scope: either Apply rule to all blobs in your storage account, or Limit blobs with filters.
Select the types of blobs for which the rule is to be applied, and specify whether to include blob snapshots or versions.
:::image type="content" source="media/archive-blob/lifecycle-policy-details-tab-portal.png" alt-text="Screenshot showing how to configure a lifecycle management policy - Details tab.":::
Depending on your selections, you can configure rules for base blobs (current versions), previous versions, or blob snapshots. Specify one of two conditions to check for:
- Objects were last modified some number of days ago.
- Objects were created some number of days ago.
- Objects were last accessed some number of days ago.
Only one of these conditions can be applied to move a particular type of object to the archive tier per rule. For example, if you define an action that archives base blobs if they haven't been modified for 90 days, then you can't also define an action that archives base blobs if they haven't been accessed for 90 days. Similarly, you can define one action per rule with either of these conditions to archive previous versions, and one to archive snapshots.
Next, specify the number of days to elapse after the object is modified or accessed.
Specify that the object is to be moved to the archive tier after the interval has elapsed.
[!div class="mx-imgBorder"]
If you chose to limit the blobs affected by the rule with filters, you can specify a filter, either with a blob prefix or blob index match.
If you rehydrate a blob by changing its tier, this rule will move the blob back to the archive tier if the last modified time, creation time, or last access time is beyond the threshold set for the policy.
If you selected the Last modified rule condition, you can prevent this from happening by selecting Skip blobs that have been rehydrated in the last, and then entering the number of days you want a rehydrated blob to be excluded from this rule.
[!div class="mx-imgBorder"]
Note
This option appears only if you selected the Last modified rule condition.
Select the Add button to add the rule to the policy.
After you create the lifecycle management policy, you can view the JSON for the policy on the Lifecycle management page by switching from List view to Code view.
Here's the JSON for the simple lifecycle management policy created in the images shown above:
{ "rules": [ { "enabled": true, "name": "sample-archive-rule", "type": "Lifecycle", "definition": { "actions": { "baseBlob": { "tierToArchive": { "daysAfterLastAccessTimeGreaterThan": 90, "daysAfterLastTierChangeGreaterThan": 7 } } }, "filters": { "blobTypes": [ "blockBlob" ] } } } ] }