Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
Restore-AzSqlInstanceDatabase
- Module:
- Az.Sql Module
Restores an Azure SQL Managed Instance database.
Syntax
PointInTimeSameInstanceRestoreInstanceDatabaseFromInputParameters (Default)
Restore-AzSqlInstanceDatabase
[-ResourceGroupName] <String>
[-InstanceName] <String>
[-Name] <String>
-PointInTime <DateTime>
-TargetInstanceDatabaseName <String>
[-FromPointInTimeBackup]
[-SubscriptionId <String>]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
PointInTimeSameInstanceRestoreInstanceDatabaseFromAzureSqlManagedDatabaseModelInstanceDefinition
Restore-AzSqlInstanceDatabase
[-InputObject] <AzureSqlManagedDatabaseBaseModel>
-PointInTime <DateTime>
-TargetInstanceDatabaseName <String>
[-FromPointInTimeBackup]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
PointInTimeSameInstanceRestoreInstanceDatabaseFromAzureResourceId
Restore-AzSqlInstanceDatabase
[-ResourceId] <String>
-PointInTime <DateTime>
-TargetInstanceDatabaseName <String>
[-FromPointInTimeBackup]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
PointInTimeCrossInstanceRestoreInstanceDatabaseFromInputParameters
Restore-AzSqlInstanceDatabase
[-ResourceGroupName] <String>
[-InstanceName] <String>
[-Name] <String>
-PointInTime <DateTime>
-TargetInstanceDatabaseName <String>
-TargetInstanceName <String>
-TargetResourceGroupName <String>
[-FromPointInTimeBackup]
[-SubscriptionId <String>]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
PointInTimeCrossInstanceRestoreInstanceDatabaseFromAzureSqlManagedDatabaseModelInstanceDefinition
Restore-AzSqlInstanceDatabase
[-InputObject] <AzureSqlManagedDatabaseBaseModel>
-PointInTime <DateTime>
-TargetInstanceDatabaseName <String>
-TargetInstanceName <String>
-TargetResourceGroupName <String>
[-FromPointInTimeBackup]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
PointInTimeCrossInstanceRestoreInstanceDatabaseFromAzureResourceId
Restore-AzSqlInstanceDatabase
[-ResourceId] <String>
-PointInTime <DateTime>
-TargetInstanceDatabaseName <String>
-TargetInstanceName <String>
-TargetResourceGroupName <String>
[-FromPointInTimeBackup]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
PointInTimeDeletedDatabasesSameInstanceRestoreInstanceDatabaseFromInputParameters
Restore-AzSqlInstanceDatabase
[-ResourceGroupName] <String>
[-InstanceName] <String>
[-Name] <String>
[-DeletionDate] <DateTime>
-PointInTime <DateTime>
-TargetInstanceDatabaseName <String>
[-FromPointInTimeBackup]
[-SubscriptionId <String>]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
PointInTimeDeletedDatabasesCrossInstanceRestoreInstanceDatabaseFromInputParameters
Restore-AzSqlInstanceDatabase
[-ResourceGroupName] <String>
[-InstanceName] <String>
[-Name] <String>
[-DeletionDate] <DateTime>
-PointInTime <DateTime>
-TargetInstanceDatabaseName <String>
-TargetInstanceName <String>
-TargetResourceGroupName <String>
[-FromPointInTimeBackup]
[-SubscriptionId <String>]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
PointInTimeCrossSubscriptionRestoreFromNameAndResourceGroup
Restore-AzSqlInstanceDatabase
[-ResourceGroupName] <String>
[-InstanceName] <String>
[-Name] <String>
-SubscriptionId <String>
-PointInTime <DateTime>
-TargetInstanceDatabaseName <String>
-TargetInstanceName <String>
-TargetResourceGroupName <String>
-TargetSubscriptionId <String>
[-FromPointInTimeBackup]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
PointInTimeCrossSubscriptionRestoreFromInputObjectParameter
Restore-AzSqlInstanceDatabase
[-InputObject] <AzureSqlManagedDatabaseBaseModel>
-PointInTime <DateTime>
-TargetInstanceDatabaseName <String>
-TargetInstanceName <String>
-TargetResourceGroupName <String>
-TargetSubscriptionId <String>
[-FromPointInTimeBackup]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
PointInTimeCrossSubscriptionRestoreFromResourceIdParameter
Restore-AzSqlInstanceDatabase
[-ResourceId] <String>
-PointInTime <DateTime>
-TargetInstanceDatabaseName <String>
-TargetInstanceName <String>
-TargetResourceGroupName <String>
-TargetSubscriptionId <String>
[-FromPointInTimeBackup]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
PointInTimeDeletedCrossSubscriptionRestoreFromNameAndResourceGroup
Restore-AzSqlInstanceDatabase
[-ResourceGroupName] <String>
[-InstanceName] <String>
[-Name] <String>
[-DeletionDate] <DateTime>
-SubscriptionId <String>
-PointInTime <DateTime>
-TargetInstanceDatabaseName <String>
-TargetInstanceName <String>
-TargetResourceGroupName <String>
-TargetSubscriptionId <String>
[-FromPointInTimeBackup]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
GeoRestoreFromGeoBackupSetNameFromGeoBackupObjectParameter
Restore-AzSqlInstanceDatabase
[-GeoBackupObject] <AzureSqlRecoverableManagedDatabaseModel>
-TargetInstanceDatabaseName <String>
-TargetInstanceName <String>
-TargetResourceGroupName <String>
[-FromGeoBackup]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
GeoRestoreFromGeoBackupSetNameFromResourceIdParameter
Restore-AzSqlInstanceDatabase
[-ResourceId] <String>
-TargetInstanceDatabaseName <String>
-TargetInstanceName <String>
-TargetResourceGroupName <String>
[-FromGeoBackup]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
GeoRestoreFromGeoBackupSetNameFromNameAndResourceGroupParameter
Restore-AzSqlInstanceDatabase
[-ResourceGroupName] <String>
[-InstanceName] <String>
[-Name] <String>
-TargetInstanceDatabaseName <String>
-TargetInstanceName <String>
-TargetResourceGroupName <String>
[-FromGeoBackup]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
LongTermRetentionBackupRestoreParameter
Restore-AzSqlInstanceDatabase
[-ResourceId] <String>
-TargetInstanceDatabaseName <String>
-TargetInstanceName <String>
-TargetResourceGroupName <String>
[-FromLongTermRetentionBackup]
[-SubscriptionId <String>]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Restore-AzSqlInstanceDatabase cmdlet restores an instance database from a geo-redundant backup, a point in time in a live database, or a long term retention backup. The restored database is created as a new instance database.
Examples
Example 1: Restore an instance database from a point in time
Restore-AzSqlInstanceDatabase -Name "Database01" -InstanceName "managedInstance1" -ResourceGroupName "ResourceGroup01" -PointInTime UTCDateTime -TargetInstanceDatabaseName "Database01_restored"
The command restores the instance database Database01 from the specified point-in-time backup to the instance database named Database01_restored.
Example 2: Restore an instance database from a point in time to another instance on different resource group
Restore-AzSqlInstanceDatabase -Name "Database01" -InstanceName "managedInstance1" -ResourceGroupName "ResourceGroup01" -PointInTime UTCDateTime -TargetInstanceDatabaseName "Database01_restored" -TargetInstanceName "managedInstance1" -TargetResourceGroupName "ResourceGroup02"
The command restores the instance database Database01 on instance managedInstance1 on resource group ResourceGroup01 from the specified point-in-time backup to the instance database named Database01_restored on instance managedInstance2 on resource group ResourceGroup02.
Example 3: Geo-Restore an instance database
$GeoBackup = Get-AzSqlInstanceDatabaseGeoBackup -ResourceGroupName "ResourceGroup01" -InstanceName "managedInstance1" -Name "Database01"
$GeoBackup | Restore-AzSqlInstanceDatabase -FromGeoBackup -TargetInstanceDatabaseName "Database01_restored" -TargetInstanceName "managedInstance2" -TargetResourceGroupName "ResourceGroup02"
The first command gets the geo-redundant backup for the database named Database01, and then stores it in the $GeoBackup variable. The second command restores the backup in $GeoBackup to the instance database named Database01_restored.
Example 4: Restore a deleted instance database from a point in time
$deletedDatabase = Get-AzSqlDeletedInstanceDatabaseBackup -ResourceGroupName "ResourceGroup01" -InstanceName "managedInstance1" -DatabaseName "DB1"
Restore-AzSqlInstanceDatabase -FromPointInTimeBackup -Name $deletedDatabase.Name -InstanceName $deletedDatabase.ManagedInstanceName -ResourceGroupName $deletedDatabase.ResourceGroupName -DeletionDate $deletedDatabase.DeletionDate -PointInTime UTCDateTime -TargetInstanceDatabaseName "Database01_restored"
The first command gets the deleted instance databases named 'DB1' on Instance 'managedInstance1'. The second command restores the fetched database, from the specified point-in-time backup to the instance database named Database01_restored.
Example 5: Restore a deleted instance database from a point in time
$deletedDatabase = Get-AzSqlDeletedInstanceDatabaseBackup -ResourceGroupName "ResourceGroup01" -InstanceName "managedInstance1" -DatabaseName "DB1"
Restore-AzSqlInstanceDatabase -FromPointInTimeBackup -InputObject $deletedDatabase[0] -PointInTime UTCDateTime -TargetInstanceDatabaseName "Database01_restored"
The first command gets the deleted instance databases named 'DB1' on Instance 'managedInstance1'. The second command restores the fetched database, from the specified point-in-time backup to the instance database named Database01_restored using input object.
Example 6: Restore a database from LTR backup.
Restore-AzSqlInstanceDatabase -FromLongTermRetentionBackup -ResourceId "/subscriptions/f46521f3-5bb0-4eea-a3c2-c2d5987df96b/resourceGroups/testResourceGroup/providers/Microsoft.Sql/locations/southeastasia/longTermRetentionManagedInstances/testInstance/longTermRetentionDatabases/test/longTermRetentionManagedInstanceBackups/15be823c-7e2c-49d8-819f-a3fdcad92215;132268250550000000" -TargetInstanceDatabaseName "restoreTarget" -TargetInstanceName "testInstance" -TargetResourceGroupName "testResourceGroup"
Location : southeastasia
Tags :
Collation : SQL_Latin1_General_CP1_CI_AS
Status : Online
RestorePointInTime :
DefaultSecondaryLocation : northeurope
CatalogCollation :
CreateMode :
StorageContainerUri :
StorageContainerSasToken :
SourceDatabaseId :
FailoverGroupId :
RecoverableDatabaseId :
RestorableDroppedDatabaseId :
LongTermRetentionBackupResourceId :
ResourceGroupName : testResourceGroup
ManagedInstanceName : testInstance
Name : restoreTarget
CreationDate : 3/4/2020 8:12:56 AM
EarliestRestorePoint : 3/4/2020 8:14:29 AM
Id : /subscriptions/f46521f3-5bb0-4eea-a3c2-c2d5987df96b/resourceGroups/testResourceGroup/providers/Microsoft.Sql/managedInstances/testInstance/databases/restoreTarget
Restores LTR backup with the given resource ID (which can be found by running Get-AzSqlInstanceDatabaseLongTermRetentionBackup).
Example 7. Restore database from different subscription
Restore-AzSqlInstanceDatabase -FromPointInTimeBackup `
-SubscriptionId "sourceSubscriptionID" `
-ResourceGroupName "sourceRGName" `
-InstanceName "sourceManagedInstanceName" `
-Name "sourceDatabaseName" `
-PointInTime $pointInTime `
-TargetInstanceDatabaseName "targetDatabaseName" `
-TargetInstanceName "targetManagedInstanceName" `
-TargetResourceGroupName "targetResourceGroupName" `
-TargetSubscriptionId "targetSubscriptionId"
The command restores database backup from instance in one subscription to database targetDatabaseName on instance targetManagedInstanceName to different subscription targetSubscriptionId.
Example 8. Restore database from different subscription using source object and pipping
Set-AzContext -SubscriptionId "sourceSubscriptionId"
$sourceDatabase = Get-AzSqlInstanceDatabase -Name "sourceDatabaseName" -InstanceName "sourceManagedInstanceName" -ResourceGroupName "sourceRGName"
Set-AzContext -SubscriptionId "targetSubscriptionId"
$sourceDatabase | Restore-AzSqlInstanceDatabase -FromPointInTimeBackup `
-PointInTime $pointInTime `
-TargetInstanceDatabaseName "targetDatabaseName" `
-TargetInstanceName "targetManagedInstanceName" `
-TargetResourceGroupName "targetResourceGroupName" `
-TargetSubscriptionId "targetSubscriptionId"
First command gets source managed database object and stores in variable sourceDatabase. Second command executes restore from source to the given target database using point in time restore.
Parameters
-AsJob
Run cmdlet in the background
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure
Parameter properties
| Type: | IAzureContextContainer |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
Parameter sets
-DeletionDate
The deletion date of deleted database.
Parameter properties
| Type: | DateTime |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-FromGeoBackup
Restore from a geo backup.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-FromLongTermRetentionBackup
Restore from a Long Term Retention backup.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-FromPointInTimeBackup
Restore from a point-in-time backup.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-GeoBackupObject
The recoverable instance database object to restore
Parameter properties
| Type: | AzureSqlRecoverableManagedDatabaseModel |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | RecoverableInstanceDatabase |
Parameter sets
-InputObject
The Instance Database object to restore
Parameter properties
| Type: | AzureSqlManagedDatabaseBaseModel |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | InstanceDatabase |
Parameter sets
-InstanceName
The instance name.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | SourceInstanceName |
Parameter sets
-Name
The instance database name to restore.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | InstanceDatabaseName, SourceInstanceDatabaseName |
Parameter sets
-PointInTime
The point in time to restore the database to.
Parameter properties
| Type: | DateTime |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ResourceGroupName
The name of the resource group.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | SourceResourceGroupName |
Parameter sets
-ResourceId
The resource id of Instance Database object to restore
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-SubscriptionId
Source subscription id.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | SourceSubscriptionId |
Parameter sets
-TargetInstanceDatabaseName
The name of the target instance database to restore to.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-TargetInstanceName
The name of the target instance to restore to. If not specified, the target instance is the same as the source instance.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-TargetResourceGroupName
The name of the target resource group to restore to. If not specified, the target resource group is the same as the source resource group.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-TargetSubscriptionId
The name of the target subscription id to restore to.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
Parameter sets
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
AzureSqlManagedDatabaseBaseModel
AzureSqlRecoverableManagedDatabaseModel
String
Outputs
AzureSqlManagedDatabaseModel
Azure PowerShell
Feedback
Was this page helpful?