20221207 combine PRs, new instructions for dedicated SQL pool cross-tenant restore

Author: WilliamDAssafMSFT

articles/synapse-analytics/backuprestore/restore-sql-pool.md

@@ -6,9 +6,9 @@ manager: joannapea
 ms.service: synapse-analytics
 ms.topic: how-to
 ms.subservice: sql
-ms.date: 10/07/2022
+ms.date: 12/07/2022
 ms.author: stevehow
-ms.reviewer: joanpo
+ms.reviewer: joanpo, wiassaf
 ms.custom: seo-lt-2019, engagement-fy23
 ---
 
@@ -36,7 +36,7 @@ In this article, you learn how to restore an existing dedicated SQL pool in Azur
 
    * If the dedicated SQL pool doesn't have any automatic restore points, wait a few hours, or create a user defined restore point before restoring. For User-Defined Restore Points, select an existing one or create a new one.
 
-   * If you want to restore a dedicated SQL pool from a different workspace, select **New dedicated SQL pool** from your current workspace. Under the **Additional settings** tab find the **Use existing data** and select the **Restore point** option. As shown in the above screenshot, you can then select the **Server or workspace** name from which you can restore.
+   * If you want to restore a dedicated SQL pool from a different workspace, select **New dedicated SQL pool** from your current workspace. Under the **Additional settings** tab, find the **Use existing data** and select the **Restore point** option. As shown in the above screenshot, you can then select the **Server or workspace** name from which you can restore.
 
    * If you are restoring a geo-backup, select the workspace located in the source region and the dedicated SQL pool you want to restore.
 
@@ -210,72 +210,90 @@ $RestoredDatabase.status
 
 When performing a cross-tenant-subscription restore, a dedicated SQL pool in an Azure Synapse workspace can only restore directly to a standalone dedicated SQL pool (formerly SQL DW). If it is required to restore a dedicated SQL pool in an Azure Synapse workspace to a workspace in the destination subscription across a different tenant, an additional restore step is required.
 
-For cross-tenant-subscription restore, the user must have a 'GUEST' account with either the 'Owner' or 'Contributor' access permissions to the destination tenant to which the dedicated SQL pool (formerly SQL DW) will be restored to.
+For cross-tenant-subscription restore, the user must have a '(Guest)' account with either the 'Owner' or 'Contributor' access permissions to the destination tenant to which the dedicated SQL pool (formerly SQL DW) will be restored to.
 
-The Powershell script for cross tenant restore works the in the same way as cross-subscription restore when the user is given 'GUEST' access to the destination tenant. As a best practice it is advised to also use the destination Tenant ID along with the destination subscription ID.
+The following PowerShell script for cross-tenant restore works in the same way as a cross-subscription restore when the user is given '(Guest)' access to the destination tenant.
 
 Steps:
 
-1.	Open a PowerShell terminal.
-2.	Update Az.Sql Module to 3.8.0 (or greater) if needed
-3.	Connect to your Azure account and list all the subscriptions associated with your account along with its Tenant ID.
-4.	Select the subscription that contains the SQL pool to be restored.
-5.	List the restore points for the dedicated SQL pool.
-6.	Pick the desired restore point using the RestorePointCreationDate.
-7.	Create a ‘Guest’ account with either ‘Owner’ or ‘Contributor’ permissions.
-8.	Select the destination subscription along with the corresponding Tenant ID to which the SQL pool should be restored.
-9.	Restore the dedicated SQL pool to the desired restore point using Restore-AzSqlDatabase PowerShell cmdlet.
-10.	Verify that the restored dedicated SQL pool (formerly SQL DW) is online.
-11.	If the desired destination is a Synapse Workspace, uncomment the code to perform the additional restore step.
-  a.	Create a restore point for the newly created data warehouse.
-  b.	Retrieve the last restore point created by using the Select -Last 1 syntax.
-  c.	Perform the restore to the desired Azure Synapse workspace.
+1.    Open a PowerShell terminal.
+1.    Update Az.Sql Module to 3.8.0 (or greater) using `Update-Module`.
+1.    Connect to your Azure account using `Connect-AzAccount`. 
+1.    List all the subscriptions associated with your account along with its Tenant ID. Select the subscription that contains the dedicated SQL pool to be restored.
+1.    List the restore points for the dedicated SQL pool using `Get-AzSynapseSqlPoolRestorePoint`.
+1.    Pick the desired restore point, setting the variable `$PointInTime`.
+1.    In the destination tenant, make sure your user has guest access with either 'Owner' or 'Contributor' permissions.
+1.    Select the destination subscription along with the corresponding Tenant ID to which the dedicated SQL pool should be restored.
+1.    Restore the dedicated SQL pool to the desired restore point using `Restore-AzSqlDatabase`.
+1.    Verify that the restored dedicated SQL pool (formerly SQL DW) is online.
+1.    If the desired destination is a Synapse workspace, uncomment the code to perform the additional restore step.
+    1. Create a restore point for the newly created data warehouse.
+    1. Retrieve the last restore point created by using the `Select -Last 1` syntax.
+    1. Perform the restore to the desired Azure Synapse workspace.
+
 
 ```powershell
-$SubscriptionName="<YourSubscriptionName>"
-$TenantID= ”<Your Tenant ID>”
-$TargetSubscriptionName= ”<YourTargetSubscriptionName>”
-$TargetTenantID= ”Your Target Tenant ID>”
-$ResourceGroupName="<YourResourceGroupName>"
-$WorkspaceName="<YourWorkspaceNameWithoutURLSuffixSeeNote>“ # Without sql.azuresynapse.net
-#$TargetResourceGroupName="<YourTargetResourceGroupName>" # uncomment to restore to a different workspace.
-#$TargetWorkspaceName="<YourtargetWorkspaceNameWithoutURLSuffixSeeNote>"  
-$SQLPoolName="<YourDatabaseName>"
-$NewSQLPoolName="<YourDatabaseName>"
+$SourceTenantID="<YourSourceTenantID>"  # like '00000000-0000-0000-0000-000000000000' 
+$SourceSubscriptionName="<YourSubscriptionName>"
+$SourceResourceGroupName="<YourResourceGroupName>"
+$SourceWorkspaceName="<YourServerNameWithoutURLSuffixSeeNote>"  # Without sql.azuresynapse.net
+$SourceSQLPoolName="<YourDatabaseName>"
+$TargetTenantID="<YourTargetTenantID>" # like '00000000-0000-0000-0000-000000000000' 
+$TargetSubscriptionName="<YourTargetSubscriptionName>"
+$TargetResourceGroupName="<YourTargetResourceGroupName>"
+$TargetServerName="<YourTargetServerNameWithoutURLSuffixSeeNote>"  # Without sql.azuresynapse.net
+$TargetDatabaseName="<YourDatabaseName>"
+#$TargetWorkspaceName="<YourTargetWorkspaceName>" # uncomment if restore to an Azure Synapse workspace is required
+
+# Update Az.Sql module to the latest version (3.8.0 or above)
+# Update-Module -Name Az.Sql
 
 Connect-AzAccount
 Get-AzSubscription
-Select-AzSubscription -SubscriptionName $SubscriptionName
+Select-AzSubscription -SubscriptionName $SourceSubscriptionName 
+
+# Set content to the source subscription and tenant
+Set-AzContext -Subscription $SourceSubscriptionName -Tenant $SourceTenantID
 
 # list all restore points
-Get-AzSynapseSqlPoolRestorePoint -ResourceGroupName $ResourceGroupName -WorkspaceName $WorkspaceName -Name $SQLPoolName
+Get-AzSynapseSqlPoolRestorePoint -ResourceGroupName $SourceResourceGroupName -WorkspaceName $SourceWorkspaceName -Name $SourceSQLPoolName
 # Pick desired restore point using RestorePointCreationDate "xx/xx/xxxx xx:xx:xx xx"
 $PointInTime="<RestorePointCreationDate>"
 
 # Get the specific SQL pool to restore
-$SQLPool = Get-AzSynapseSqlPool -ResourceGroupName $ResourceGroupName -WorkspaceName $WorkspaceName -Name $SQLPoolName
+$SQLPool = Get-AzSynapseSqlPool -ResourceGroupName $SourceResourceGroupName -WorkspaceName $SourceWorkspaceName -Name $SourceSQLPoolName
 # Transform Synapse SQL pool resource ID to SQL database ID because currently the restore command only accepts the SQL database ID format.
 $DatabaseID = $SQLPool.Id -replace "Microsoft.Synapse", "Microsoft.Sql" `
     -replace "workspaces", "servers" `
     -replace "sqlPools", "databases"
 
-#Switch the context to the Subscription name and tenant ID to which the database would be restored to
-Set-AzContext -Subscription 'MySubscriptionName' -Tenant '00000000-0000-0000-0000-000000000000' 
+# Switch context to the destination subscription and tenant
+Set-AzContext -Subscription $TargetSubscriptionName -Tenant $TargetTenantID
 
-# Restore database from a restore point
-$RestoredDatabase = Restore-AzSynapseSqlPool –FromRestorePoint -RestorePoint $PointInTime -ResourceGroupName $SQLPool.ResourceGroupName `
-    -WorkspaceName $SQLPool.WorkspaceName -TargetSqlPoolName $NewSQLPoolName –ResourceId $DatabaseID -PerformanceLevel DW100c
-
-
-# Use the following command to restore to a different workspace
-#$TargetResourceGroupName = $SQLPool.ResourceGroupName # for restoring to different workspace in same resourcegroup 
-#$RestoredDatabase = Restore-AzSynapseSqlPool –FromRestorePoint -RestorePoint $PointInTime -ResourceGroupName $TargetResourceGroupName `
-#    -WorkspaceName $TargetWorkspaceName -TargetSqlPoolName $NewSQLPoolName –ResourceId $DatabaseID -PerformanceLevel DW100c
+# Restore database from a desired restore point of the source database to the target server in the desired subscription
+$RestoredDatabase = Restore-AzSqlDatabase –FromPointInTimeBackup –PointInTime $PointInTime -ResourceGroupName $TargetResourceGroupName `
+    -ServerName $TargetServerName -TargetDatabaseName $TargetDatabaseName –ResourceId $DatabaseID
 
 # Verify the status of restored database
 $RestoredDatabase.status
 
- ```
+# uncomment below cmdlets to perform one more restore to push the dedicated SQL pool to an existing workspace in the destination subscription
+
+# # Create restore point
+# New-AzSqlDatabaseRestorePoint -ResourceGroupName $RestoredDatabase.ResourceGroupName -ServerName $RestoredDatabase.ServerName `
+#     -DatabaseName $RestoredDatabase.DatabaseName -RestorePointLabel "UD-001"
+
+# # Gets the last restore point of the dedicated SQL pool (formerly SQL DW) (will use the RestorePointCreationDate property)
+# $RestorePoint = Get-AzSqlDatabaseRestorePoint -ResourceGroupName $RestoredDatabase.ResourceGroupName -ServerName $RestoredDatabase.ServerName `
+#     -DatabaseName $RestoredDatabase.DatabaseName | Select -Last 1
+
+# # Restore to destination synapse workspace
+# # Set performance level as desired
+# $FinalRestore = Restore-AzSynapseSqlPool –FromRestorePoint -RestorePoint $RestorePoint.RestorePointCreationDate -ResourceGroupName $TargetResourceGroupName `
+#     -WorkspaceName $TargetWorkspaceName -TargetSqlPoolName $TargetDatabaseName –ResourceId $RestoredDatabase.ResourceID -PerformanceLevel DW100c 
+
+```
+
 
 ## Troubleshooting
 A restore operation can result in a deployment failure based on a "RequestTimeout" exception. 
@@ -290,3 +308,4 @@ This timeout can be ignored. Review the dedicated SQL pool page in the Azure por
 
 - [Create a restore point](sqlpool-create-restore-point.md)
 - [Restore-AzSqlDatabase](/powershell/module/az.sql/restore-azsqldatabase?toc=/azure/synapse-analytics/sql-data-warehouse/toc.json&bc=/azure/synapse-analytics/sql-data-warehouse/breadcrumb/toc.json)
+- [What's the difference between Azure Synapse (formerly SQL DW) and Azure Synapse Analytics Workspace](https://techcommunity.microsoft.com/t5/azure-synapse-analytics-blog/what-s-the-difference-between-azure-synapse-formerly-sql-dw-and/ba-p/3597772)