Restore-AzStorageContainer
Restores a previously deleted Azure storage blob container.
Note
This is the previous version of our documentation. Please consult the most recent version for up-to-date information.
Syntax
Restore-AzStorageContainer
[-Name] <String>
[-VersionId] <String>
[-Context <IStorageContext>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
The Restore-AzStorageContainer cmdlet restores a previously deleted Azure storage blob container. This cmdlet only works after enabled Container softdelete with Enable-AzStorageBlobDeleteRetentionPolicy.
Examples
Example 1: List containers include deleted containers, and restore all deleted containers with pipeline
PS C:\> Get-AzStorageContainer -IncludeDeleted -Context $ctx | ? { $_.IsDeleted } | Restore-AzStorageContainer
Storage Account Name: storageaccountname
Name PublicAccess LastModified IsDeleted VersionId
---- ------------ ------------ --------- ---------
container1 Off
container2 OffThis command lists all containers include deleted containers, filter out all the deleted containers, then restore all deleted container to the same container name with pipeline.
Example 2: Restore a single deleted container
PS C:\> Get-AzStorageContainer -IncludeDeleted -Context $ctx | ? { $_.IsDeleted }
Storage Account Name: storageaccountname
Name PublicAccess LastModified IsDeleted VersionId
---- ------------ ------------ --------- ---------
container1 8/28/2020 10:18:13 AM +00:00 True 01D685BC91A88F22
container2 9/4/2020 12:52:37 PM +00:00 True 01D67D248986B6DA
PS C:\> Restore-AzStorageContainer -Name container1 -VersionId 01D685BC91A88F22 -Context $ctx
Storage Account Name: storageaccountname
Name PublicAccess LastModified IsDeleted VersionId
---- ------------ ------------ --------- ---------
container1 OffThis first command lists all containers and filter out deleted containers. The secondary command restores a deleted container by manually input the parameters.
Parameters
Prompts you for confirmation before running the cmdlet.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Azure Storage Context Object
| Type: | IStorageContext |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
The credentials, account, tenant, and subscription used for communication with Azure.
| Type: | IAzureContextContainer |
| Aliases: | AzureRmContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
The name of the previously deleted container.
| Type: | String |
| Aliases: | N, Container, DeletedContainerName |
| Position: | 0 |
| Default value: | None |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
The version of the previously deleted container.
| Type: | String |
| Aliases: | DeletedContainerVersion, |
| Position: | 1 |
| Default value: | None |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
Shows what would happen if the cmdlet runs. The cmdlet is not run.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |