From 5ba665ce203d659989bd9cae6f623c161153fd8a Mon Sep 17 00:00:00 2001 From: itechedit Date: Fri, 14 Oct 2022 12:26:55 -0700 Subject: [PATCH 1/9] edit pass: four-connect-synapse-link-sql-articles --- .../connect-synapse-link-sql-database-vnet.md | 85 ++++--- .../connect-synapse-link-sql-database.md | 139 ++++++----- ...nnect-synapse-link-sql-server-2022-vnet.md | 90 ++++--- .../connect-synapse-link-sql-server-2022.md | 228 +++++++++--------- 4 files changed, 291 insertions(+), 251 deletions(-) diff --git a/articles/synapse-analytics/synapse-link/connect-synapse-link-sql-database-vnet.md b/articles/synapse-analytics/synapse-link/connect-synapse-link-sql-database-vnet.md index f52fd6cdbc0f1..5576c41a0b54d 100644 --- a/articles/synapse-analytics/synapse-link/connect-synapse-link-sql-database-vnet.md +++ b/articles/synapse-analytics/synapse-link/connect-synapse-link-sql-database-vnet.md @@ -1,6 +1,6 @@ --- -title: Configure Synapse link for Azure SQL Database with network security (Preview) -description: Learn how to configure Synapse link for Azure SQL Database with network security (Preview). +title: Configure Azure Synapse Link for Azure SQL Database with network security (preview) +description: Learn how to configure Azure Synapse Link for Azure SQL Database with network security (preview). author: yexu ms.service: synapse-analytics ms.topic: how-to @@ -10,86 +10,93 @@ ms.author: yexu ms.reviewer: sngun, wiassaf --- -# Configure Synapse link for Azure SQL Database with network security (Preview) +# Configure Azure Synapse Link for Azure SQL Database with network security (preview) -This article provides a guide on configuring Azure Synapse Link for Azure SQL Database with network security. Before reading this documentation, You should have known how to create and start Synapse link for Azure SQL DB from [Get started with Azure Synapse Link for Azure SQL Database](connect-synapse-link-sql-database.md). +This article is a guide for configuring Azure Synapse Link for Azure SQL Database with network security. Before you begin, you should know how to create and start Azure Synapse Link for Azure SQL Database from [Get started with Azure Synapse Link for Azure SQL Database](connect-synapse-link-sql-database.md). > [!IMPORTANT] -> Azure Synapse Link for SQL is currently in PREVIEW. +> Azure Synapse Link for SQL is currently in preview. > See the [Supplemental Terms of Use for Microsoft Azure Previews](https://azure.microsoft.com/support/legal/preview-supplemental-terms/) for legal terms that apply to Azure features that are in beta, preview, or otherwise not yet released into general availability. -## Managed workspace Virtual Network without data exfiltration +## Create a managed workspace virtual network without data exfiltration -1. Create Synapse workspace with managed virtual network enabled. You will enable **managed virtual network** and select **No** to allow outbound traffic from the workspace to any target. You can learn more about managed virtual network from [this](../security/synapse-workspace-managed-vnet.md). +In this section, you create an Azure Synapse workspace with a managed virtual network enabled. You'll enable **managed virtual network**, and then select **No** to allow outbound traffic from the workspace to any target. For an overview, see [Azure Synapse Analytics managed virtual network](../security/synapse-workspace-managed-vnet.md). - :::image type="content" source="../media/connect-synapse-link-sql-database/create-synapse-workspace-allow-outbound-traffic.png" alt-text="Screenshot of creating synapse workspace allow outbound traffic."::: +:::image type="content" source="../media/connect-synapse-link-sql-database/create-synapse-workspace-allow-outbound-traffic.png" alt-text="Screenshot that shows how to create an Azure Synapse workspace that allows outbound traffic."::: -1. Navigate to your Synapse workspace on Azure portal, go to **Networking** tab to enable **Allow Azure Synapse Link for Azure SQL Database to bypass firewall rules**. +1. Sign in to the [Azure portal](https://portal.azure.com). - :::image type="content" source="../media/connect-synapse-link-sql-database/enable-bypass-firewall-rules.png" alt-text="Screenshot of enabling bypass firewall rules."::: +1. Go to your Azure Synapse workspace, select **Networking**, and then select the **Allow Azure Synapse Link for Azure SQL Database to bypass firewall rules** checkbox. -1. Launch Synapse Studio, navigate to **Manage**, click **Integration runtimes** and select **AutoResolvingIntegrationRuntime**. On the pop-up slide, you can click **Virtual network** tab, and enable **Interactive authoring**. + :::image type="content" source="../media/connect-synapse-link-sql-database/enable-bypass-firewall-rules.png" alt-text="Screenshot that shows how to enable bypassing firewall rules."::: - :::image type="content" source="../media/connect-synapse-link-sql-database/enable-interactive-authoring.png" alt-text="Screenshot of enabling interactive authoring."::: +1. Open Synapse Studio, go to **Manage**, select **Integration runtimes**, and then select **AutoResolvingIntegrationRuntime**. -1. Now you can create a link connection from **Integrate** tab to replicate data from Azure SQL DB to Synapse SQL pool. +1. In the pop-up window, select the **Virtual network** tab, and then enable **Interactive authoring**. - :::image type="content" source="../media/connect-synapse-link-sql-database/create-link.png" alt-text="Screenshot of creating a link."::: + :::image type="content" source="../media/connect-synapse-link-sql-database/enable-interactive-authoring.png" alt-text="Screenshot that shows how to enable interactive authoring."::: - :::image type="content" source="../media/connect-synapse-link-sql-database/create-link-sql-db.png" alt-text="Screenshot of creating link sql db."::: +1. From the **Integrate** pane, create a link connection to replicate data from your Azure SQL database to an Azure Synapse SQL pool. -1. Start your link connection + :::image type="content" source="../media/connect-synapse-link-sql-database/create-link.png" alt-text="Screenshot that shows how to create a link to an Azure Synapse SQL pool."::: - :::image type="content" source="../media/connect-synapse-link-sql-database/start-link.png" alt-text="Screenshot of starting link."::: + :::image type="content" source="../media/connect-synapse-link-sql-database/create-link-sql-db.png" alt-text="Screenshot that shows how to create a link connection from an Azure SQL database."::: +1. Start your link connection. -## Managed workspace Virtual Network with data exfiltration + :::image type="content" source="../media/connect-synapse-link-sql-database/start-link.png" alt-text="Screenshot of starting a link connection."::: -1. Create Synapse workspace with managed virtual network enabled. You will enable **managed virtual network** and select **Yes** to limit outbound traffic from the Managed workspace Virtual Network to targets through Managed private endpoints. You can learn more about managed virtual network from [this](../security/synapse-workspace-managed-vnet.md) +## Create a managed workspace virtual network with data exfiltration - :::image type="content" source="../media/connect-synapse-link-sql-database/create-synapse-workspace-disallow-outbound-traffic.png" alt-text="Screenshot of creating synapse workspace disallow outbound traffic."::: +In this section, you create an Azure Synapse workspace with managed virtual network enabled. You'll enable **managed virtual network** and select **Yes** to limit outbound traffic from the managed workspace virtual network to targets through managed private endpoints. For an overview, see [Azure Synapse Analytics managed virtual network](../security/synapse-workspace-managed-vnet.md). -1. Navigate to your Synapse workspace on Azure portal, go to **Networking** tab to enable **Allow Azure Synapse Link for Azure SQL Database to bypass firewall rules**. +:::image type="content" source="../media/connect-synapse-link-sql-database/create-synapse-workspace-disallow-outbound-traffic.png" alt-text="Screenshot that shows how to create an Azure Synapse workspace that disallows outbound traffic."::: - :::image type="content" source="../media/connect-synapse-link-sql-database/enable-bypass-firewall-rules.png" alt-text="Screenshot of enabling bypass firewall rules."::: +1. Sign in to the [Azure portal](https://portal.azure.com). -1. Launch Synapse Studio, navigate to **Manage**, click **Integration runtimes** and select **AutoResolvingIntegrationRuntime**. On the pop-up slide, you can click **Virtual network** tab, and enable **Interactive authoring**. +1. Go to your Azure Synapse workspace, select **Networking**, and then select the **Allow Azure Synapse Link for Azure SQL Database to bypass firewall rules** checkbox. - :::image type="content" source="../media/connect-synapse-link-sql-database/enable-interactive-authoring.png" alt-text="Screenshot of enabling interactive authoring."::: + :::image type="content" source="../media/connect-synapse-link-sql-database/enable-bypass-firewall-rules.png" alt-text="Screenshot that shows how to enable bypassing firewall rules."::: -1. Create a linked service connecting to Azure SQL DB with managed private endpoint enabled. +1. Open Synapse Studio, go to **Manage**, select **Integration runtimes**, and then select **AutoResolvingIntegrationRuntime**. - * Create a linked service connecting to Azure SQL DB. +1. In the pop-up window, select the **Virtual network** tab, and then enable **Interactive authoring**. + + :::image type="content" source="../media/connect-synapse-link-sql-database/enable-interactive-authoring.png" alt-text="Screenshot that shows how to enable interactive authoring."::: + +1. Create a linked service that connects to your Azure SQL database with a managed private endpoint enabled. + + a. Create a linked service connecting to your Azure SQL database. - :::image type="content" source="../media/connect-synapse-link-sql-database/new-sql-db-linked-service-pe.png" alt-text="Screenshot of new sql db linked service pe."::: + :::image type="content" source="../media/connect-synapse-link-sql-database/new-sql-db-linked-service-pe.png" alt-text="Screenshot of a new Azure SQL database linked service private endpoint."::: - * Create a managed private endpoint in linked service for Azure SQL DB. + b. Create a managed private endpoint in a linked service for the Azure SQL database. - :::image type="content" source="../media/connect-synapse-link-sql-database/new-sql-db-linked-service-pe1.png" alt-text="Screenshot of new sql db linked service pe1."::: + :::image type="content" source="../media/connect-synapse-link-sql-database/new-sql-db-linked-service-pe1.png" alt-text="Screenshot of a new Azure SQL database linked service private endpoint 1."::: - * Complete the managed private endpoint creation in the linked service for Azure SQL DB. + c. Complete the managed private endpoint creation in the linked service for the Azure SQL database. - :::image type="content" source="../media/connect-synapse-link-sql-database/new-sql-db-linked-service-pe2.png" alt-text="Screenshot of new sql db linked service pe2."::: + :::image type="content" source="../media/connect-synapse-link-sql-database/new-sql-db-linked-service-pe2.png" alt-text="Screenshot of a new Azure SQL database linked service private endpoint 2."::: - * Go to Azure portal of your SQL Server hosting Azure SQL DB as source store, approve the Private endpoint connections. + d. Go to the Azure portal for your SQL Server instance that hosts an Azure SQL database as a source store, and then approve the private endpoint connections. - :::image type="content" source="../media/connect-synapse-link-sql-database/new-sql-db-linked-service-pe3.png" alt-text="Screenshot of new sql db linked service pe3."::: + :::image type="content" source="../media/connect-synapse-link-sql-database/new-sql-db-linked-service-pe3.png" alt-text="Screenshot of a new Azure SQL database linked service private endpoint 3."::: -1. Now you can create a link connection from **Integrate** tab to replicate data from Azure SQL DB to Synapse SQL pool. +1. Now you can create a link connection from the **Integrate** pane to replicate data from your Azure SQL database to an Azure Synapse SQL pool. - :::image type="content" source="../media/connect-synapse-link-sql-database/create-link.png" alt-text="Screenshot of creating a link."::: + :::image type="content" source="../media/connect-synapse-link-sql-database/create-link.png" alt-text="Screenshot that shows how to create a link."::: - :::image type="content" source="../media/connect-synapse-link-sql-database/create-link-sql-db.png" alt-text="Screenshot of creating link sqldb."::: + :::image type="content" source="../media/connect-synapse-link-sql-database/create-link-sql-db.png" alt-text="Screenshot of creating a link to the SQL database."::: -1. Start your link connection +1. Start your link connection. - :::image type="content" source="../media/connect-synapse-link-sql-database/start-link.png" alt-text="Screenshot of starting link."::: + :::image type="content" source="../media/connect-synapse-link-sql-database/start-link.png" alt-text="Screenshot that shows how to start the link connection."::: ## Next steps -If you are using a different type of database, see how to: +If you're using a database other than an Azure SQL database, see: * [Configure Azure Synapse Link for Azure Cosmos DB](../../cosmos-db/configure-synapse-link.md?context=/azure/synapse-analytics/context/context) * [Configure Azure Synapse Link for Dataverse](/powerapps/maker/data-platform/azure-synapse-link-synapse?context=/azure/synapse-analytics/context/context) diff --git a/articles/synapse-analytics/synapse-link/connect-synapse-link-sql-database.md b/articles/synapse-analytics/synapse-link/connect-synapse-link-sql-database.md index 44276e6c5cfcd..a83c6b8ec4114 100644 --- a/articles/synapse-analytics/synapse-link/connect-synapse-link-sql-database.md +++ b/articles/synapse-analytics/synapse-link/connect-synapse-link-sql-database.md @@ -1,6 +1,6 @@ --- -title: Get started with Azure Synapse Link for Azure SQL Database (Preview) -description: Learn how to connect an Azure SQL database to an Azure Synapse workspace with Azure Synapse Link (Preview). +title: Get started with Azure Synapse Link for Azure SQL Database (preview) +description: Learn how to connect an Azure SQL database to an Azure Synapse workspace with Azure Synapse Link (preview). author: SnehaGunda ms.service: synapse-analytics ms.topic: how-to @@ -11,176 +11,187 @@ ms.author: sngun ms.reviewer: sngun, wiassaf --- -# Get started with Azure Synapse Link for Azure SQL Database (Preview) +# Get started with Azure Synapse Link for Azure SQL Database (preview) -This article provides a step-by-step guide for getting started with Azure Synapse Link for Azure SQL Database. For more information, see [Synapse Link for Azure SQL Database (Preview)](sql-database-synapse-link.md). +This article is a step-by-step guide for getting started with Azure Synapse Link for Azure SQL Database. For an overview of this feature, see [Azure Synapse Link for Azure SQL Database (preview)](sql-database-synapse-link.md). > [!IMPORTANT] -> Azure Synapse Link for SQL is currently in PREVIEW. +> Azure Synapse Link for SQL is currently in preview. > See the [Supplemental Terms of Use for Microsoft Azure Previews](https://azure.microsoft.com/support/legal/preview-supplemental-terms/) for legal terms that apply to Azure features that are in beta, preview, or otherwise not yet released into general availability. ## Prerequisites -* [Create a new Synapse workspace](https://portal.azure.com/#create/Microsoft.Synapse) to get Azure Synapse Link for SQL. The current tutorial is to create Synapse link for SQL in public network. The assumption is that you have checked "Disable Managed virtual network" and "Allow connections from all IP address" when creating Synapse workspace. If you want to configure Synapse link for Azure SQL Database with network security, please also refer to [Configure Synapse link for Azure SQL Database with network security](connect-synapse-link-sql-database-vnet.md). +* To get Azure Synapse Link for SQL, see [Create a new Azure Synapse workspace](https://portal.azure.com/#create/Microsoft.Synapse). The current tutorial is to create Azure Synapse Link for SQL in a public network. This article assumes that you selected **Disable Managed virtual network** and **Allow connections from all IP address** when you created an Azure Synapse workspace. If you want to configure Azure Synapse Link for Azure SQL Database with network security, also see [Configure Azure Synapse Link for Azure SQL Database with network security](connect-synapse-link-sql-database-vnet.md). -* For DTU-based provisioning, make sure your Azure SQL Database service is at least Standard tier with a minimum of 100 DTUs. Free, Basic, or Standard tiers with fewer than 100 DTUs provisioned are not supported. +* For database transaction unit (DTU)-based provisioning, make sure that your Azure SQL Database service is at least Standard tier with a minimum of 100 DTUs. Free, Basic, or Standard tiers with fewer than 100 DTUs provisioned are not supported. -## Configure your source Azure SQL Database +## Configure your source Azure SQL database -1. Go to Azure portal, navigate to your Azure SQL Server, select **Identity**, and then set **System assigned managed identity** to **On**. +1. Sign in to the [Azure portal](https://portal.azure.com). - :::image type="content" source="../media/connect-synapse-link-sql-database/set-identity-sql-database.png" alt-text="Screenshot of turning on system assigned managed identity."::: +1. Go to your Azure SQL logical server, select **Identity**, and then set **System assigned managed identity** to **On**. -1. Navigate to **Networking**, then check **Allow Azure services and resources to access this server**. + :::image type="content" source="../media/connect-synapse-link-sql-database/set-identity-sql-database.png" alt-text="Screenshot of turning on the system-assigned managed identity."::: - :::image type="content" source="../media/connect-synapse-link-sql-database/configure-network-firewall-sql-database.png" alt-text="Screenshot of configuring firewalls for your SQL DB using Azure portal."::: +1. Go to **Networking**, and then select the **Allow Azure services and resources to access this server** checkbox. -1. Using Microsoft SQL Server Management Studio (SSMS) or Azure Data Studio, connect to the Azure SQL Server. If you want to have your Synapse workspace connect to your Azure SQL Database using a managed identity, set the Azure Active Directory admin on Azure SQL Server, and use the same admin name to connect to Azure SQL Server with administrative privileges in order to have the privileges in step 5. + :::image type="content" source="../media/connect-synapse-link-sql-database/configure-network-firewall-sql-database.png" alt-text="Screenshot that shows how to configure firewalls for your SQL database by using the Azure portal."::: -1. Expand **Databases**, right select the database you created above, and select **New Query**. +1. Using Microsoft SQL Server Management Studio (SSMS) or Azure Data Studio, connect to the logical server. If you want to have your Azure Synapse workspace connect to your Azure SQL database by using a managed identity, set the Azure Active Directory admin permissions on the logical server, To have the privileges in step 6, use the same admin name to connect to the logical server with administrative privileges. - :::image type="content" source="../media/connect-synapse-link-sql-database/ssms-new-query.png" alt-text="Select your database and create a new query."::: +1. Expand **Databases**, right-click the database you've just created, and then select **New Query**. -1. If you want to have your Synapse workspace connect to your source Azure SQL Database using a [managed identity](../../active-directory/managed-identities-azure-resources/overview.md), run the following script to provide the managed identity permission to the source database. + :::image type="content" source="../media/connect-synapse-link-sql-database/ssms-new-query.png" alt-text="Screenshot that shows how to select your database and create a new query."::: - **You can skip this step** if you instead want to have your Synapse workspace connect to your source Azure SQL Database via SQL authentication. +1. If you want to have your Azure Synapse workspace connect to your source Azure SQL database by using a [managed identity](../../active-directory/managed-identities-azure-resources/overview.md), run the following script to provide the managed identity permission to the source database. + + **You can skip this step** if you instead want to have your Azure Synapse workspace connect to your source Azure SQL database via SQL authentication. ```sql CREATE USER FROM EXTERNAL PROVIDER; ALTER ROLE [db_owner] ADD MEMBER ; ``` -1. You can create a table with your own schema; the following is just an example for a `CREATE TABLE` query. You can also insert some rows into this table to ensure there's data to be replicated. +1. You can create a table with your own schema. The following code is just an example for a `CREATE TABLE` query. You can also insert some rows into this table to ensure that there's data to be replicated. ```sql CREATE TABLE myTestTable1 (c1 int primary key, c2 int, c3 nvarchar(50)) ``` -## Create your target Synapse SQL pool +## Create your target Azure Synapse SQL pool -1. Launch [Synapse Studio](https://web.azuresynapse.net/). +1. Open [Synapse Studio](https://web.azuresynapse.net/). -1. Open the **Manage** hub, navigate to **SQL pools**, and select **+ New**. +1. Go to the **Manage** hub, select **SQL pools**, and then select **New**. - :::image type="content" source="../media/connect-synapse-link-sql-database/studio-new-sql-pool.png" alt-text="Create a new SQL dedicated pool from Synapse Studio."::: + :::image type="content" source="../media/connect-synapse-link-sql-database/studio-new-sql-pool.png" alt-text="Screenshot that shows how to create a new SQL dedicated pool from Synapse Studio."::: 1. Enter a unique pool name, use the default settings, and create the dedicated pool. -1. You need to create a schema if your expected schema is not available in target Synapse SQL database. If your schema is dbo, you can skip this step. +1. You need to create a schema if your expected schema isn't available in the target Azure Synapse SQL database. If your schema is *database owner* (dbo), you can skip this step. ## Create the Azure Synapse Link connection -1. Open the **Integrate** hub, and select **+ Link connection(Preview)**. +1. On the left pane of the Azure portal, select **Integrate**. + +1. On the **Integrate** pane, select the plus sign (**+**), and then select **Link connection (Preview)**. - :::image type="content" source="../media/connect-synapse-link-sql-database/studio-new-link-connection.png" alt-text="Select a new link connection from Synapse Studio."::: + :::image type="content" source="../media/connect-synapse-link-sql-database/studio-new-link-connection.png" alt-text="Screenshot that shows how to select a new link connection from Synapse Studio."::: 1. Under **Source linked service**, select **New**. - :::image type="content" source="../media/connect-synapse-link-sql-database/studio-new-linked-service-dropdown.png" alt-text="Select a new linked service."::: + :::image type="content" source="../media/connect-synapse-link-sql-database/studio-new-linked-service-dropdown.png" alt-text="Screenshot that shows how to select a new linked service."::: -1. Enter the information for your source Azure SQL Database. +1. Enter the information for your source Azure SQL database. - * Select the subscription, server, and database corresponding to your Azure SQL Database. - * If you wish to connect your Synapse workspace to the source DB using the workspace's managed identity, set **Authentication type** to **Managed Identity**. - * If you wish to use SQL authentication instead and know the username/password to use, select **SQL Authentication** instead. + * Select the subscription, server, and database corresponding to your Azure SQL database. + * Do either of the following: + * To connect your Azure Synapse workspace to the source database by using the workspace's managed identity, set **Authentication type** to **Managed Identity**. + * To use SQL authentication instead, if you know the username and password to use, select **SQL Authentication**. - :::image type="content" source="../media/connect-synapse-link-sql-database/studio-new-linked-service.png" alt-text="Enter the server, database details to create a new linked service."::: + :::image type="content" source="../media/connect-synapse-link-sql-database/studio-new-linked-service.png" alt-text="Screenshot that shows how to enter the server and database details to create a new linked service."::: -1. Select **Test connection** to ensure the firewall rules are properly configured and the workspace can successfully connect to the source Azure SQL Database. +1. Select **Test connection** to ensure that the firewall rules are properly configured and the workspace can successfully connect to the source Azure SQL database. 1. Select **Create**. + > [!NOTE] - > The linked service that you create here is not dedicated to Azure Synapse Link for SQL - it can be used by any workspace user that has the appropriate permissions. Please take time to understand the scope of users who may have access to this linked service and its credentials. For more information on permissions in Azure Synapse workspaces, see [Azure Synapse workspace access control overview - Azure Synapse Analytics](../security/synapse-workspace-access-control-overview.md). + > The linked service that you create here isn't dedicated to Azure Synapse Link for SQL. It can be used by any workspace user who has the appropriate permissions. Take time to understand the scope of users who might have access to this linked service and its credentials. For more information about permissions in Azure Synapse workspaces, see [Azure Synapse workspace access control overview - Azure Synapse Analytics](../security/synapse-workspace-access-control-overview.md). -1. Select one or more source tables to replicate to your Synapse workspace and select **Continue**. +1. Select one or more source tables to replicate to your Azure Synapse workspace, and then select **Continue**. > [!NOTE] - > A given source table can only be enabled in at most one link connection at a time. + > A specified source table can be enabled in only one link connection at a time. -1. Select a target Synapse SQL database and pool. +1. Select a target Azure Synapse SQL database and pool. 1. Provide a name for your Azure Synapse Link connection, and select the number of cores for the [link connection compute](sql-database-synapse-link.md#link-connection). These cores will be used for the movement of data from the source to the target. > [!NOTE] - > We recommend starting low and increasing as needed. + > We recommend starting low and increasing the number of cores as needed. 1. Select **OK**. -1. With the new Azure Synapse Link connection open, you can update the target table name, distribution type and structure type. +1. With the new Azure Synapse Link connection open, you can update the target table name, distribution type, and structure type. > [!NOTE] - > * Consider heap table for structure type when your data contains varchar(max), nvarchar(max), and varbinary(max). - > * Make sure the schema in your Synapse dedicated SQL pool has already been created before you start the link connection. Azure Synapse Link for SQL will create tables automatically under your schema in the Synapse dedicated SQL pool. + > * Consider using *heap table* for the structure type when your data contains varchar(max), nvarchar(max), and varbinary(max). + > * Make sure that the schema in your Azure Synapse SQL dedicated pool has already been created before you start the link connection. Azure Synapse Link for SQL will create tables automatically under your schema in the Azure Synapse SQL dedicated pool. - :::image type="content" source="../media/connect-synapse-link-sql-database/studio-edit-link.png" alt-text="Edit Azure Synapse Link connection from Synapse Studio."::: + :::image type="content" source="../media/connect-synapse-link-sql-database/studio-edit-link.png" alt-text="Screenshot that shows where to edit the Azure Synapse Link connection from Synapse Studio."::: 1. Select **Publish all** to save the new link connection to the service. ## Start the Azure Synapse Link connection -1. Select **Start** and wait a few minutes for the data to be replicated. +Select **Start**, and then wait a few minutes for the data to be replicated. > [!NOTE] - > When being started, a link connection will start from a full initial load from your source database followed by incremental change feeds via the change feed feature in Azure SQL database. For more information, see [Azure Synapse Link for SQL change feed](/sql/sql-server/synapse-link/synapse-link-sql-server-change-feed). + > A link connection will start from a full initial load from your source database, followed by incremental change feeds via the change feed feature in Azure SQL Database. For more information, see [Azure Synapse Link for SQL change feed](/sql/sql-server/synapse-link/synapse-link-sql-server-change-feed). ## Monitor the status of the Azure Synapse Link connection -You may monitor the status of your Azure Synapse Link connection, see which tables are being initially copied over (Snapshotting), and see which tables are in continuous replication mode (Replicating). +You can monitor the status of your Azure Synapse Link connection, see which tables are being initially copied over (*snapshotting*), and see which tables are in continuous replication mode (*replicating*). -1. Navigate to the **Monitor** hub, and select **Link connections**. +1. Go to the **Monitor** hub, and then select **Link connections**. - :::image type="content" source="../media/connect-synapse-link-sql-database/studio-monitor-link-connections.png" alt-text="Monitor the status of Azure Synapse Link connection from the monitor hub."::: + :::image type="content" source="../media/connect-synapse-link-sql-database/studio-monitor-link-connections.png" alt-text="Screenshot that shows how to monitor the status of the Azure Synapse Link connection from the monitor hub."::: -1. Open the Azure Synapse Link connection you started and view the status of each table. +1. Open the Azure Synapse Link connection that you started, and view the status of each table. 1. Select **Refresh** on the monitoring view for your connection to observe any updates to the status. -## Query replicated data +## Query the replicated data -Wait for a few minutes, then check the target database has the expected table and data. You can also now explore the replicated tables in your target Synapse dedicated SQL pool. +Wait for a few minutes, and then check to ensure that the target database has the expected table and data. You can also now explore the replicated tables in your target Azure Synapse SQL dedicated pool. -1. In the **Data** hub, under **Workspace**, open your target database, and within **Tables**, right-click one of your target tables. +1. In the **Data** hub, under **Workspace**, open your target database. -1. Choose **New SQL script**, then **Select TOP 100 rows**. +1. Under **Tables**, right-click one of your target tables. -1. Run this query to view the replicated data in your target Synapse dedicated SQL pool. +1. Select **New SQL script**, and then select **Top 100 rows**. -1. You can also query the target database with SSMS (or other tools). Use the dedicated SQL endpoint for your workspace as the server name. This is typically `.sql.azuresynapse.net`. Add `Database=databasename@poolname` as another connection string parameter when connecting via SSMS (or other tools). +1. Run this query to view the replicated data in your target Azure Synapse SQL dedicated pool. -## Add/remove table in existing Azure Synapse Link connection +1. You can also query the target database by using SSMS or other tools. Use the SQL dedicated endpoint for your workspace as the server name. This name is usually `.sql.azuresynapse.net`. Add `Database=databasename@poolname` as an extra connection string parameter when you're connecting via SSMS or other tools. -You can add/remove tables on Synapse Studio as following: +## Add or remove a table in an existing Azure Synapse Link connection + +To add or remove tables in Synapse Studio, do the following: 1. Open the **Integrate Hub**. -1. Select the **Link connection** you want to edit and open it. +1. Select the link connection that you want to edit, and then open it. + +1. Do either of the following: -1. Select **+New** table to add tables on Synapse Studio or select the trash can icon to the right or a table to remove an existing table. You can add or remove tables when the link connection is running. + * To add a table, select **New**. + * To remove a table, select the trash can icon next to it. - :::image type="content" source="../media/connect-synapse-link-sql-server-2022/link-connection-add-remove-tables.png" alt-text="Screenshot of link connection to add table."::: + :::image type="content" source="../media/connect-synapse-link-sql-server-2022/link-connection-add-remove-tables.png" alt-text="Screenshot of the link connection pane for adding or removing tables."::: > [!NOTE] > You can directly add or remove tables when a link connection is running. ## Stop the Azure Synapse Link connection -You can stop the Azure Synapse Link connection in Synapse Studio as follows: +To stop the Azure Synapse Link connection in Synapse Studio, do the following: -1. Open the **Integrate Hub** of your Synapse workspace. +1. In your Azure Synapse workspace, open the **Integrate** hub. -1. Select the **Link connection** you want to edit and open it. +1. Select the link connection that you want to edit, and then open it. 1. Select **Stop** to stop the link connection, and it will stop replicating your data. - :::image type="content" source="../media/connect-synapse-link-sql-server-2022/stop-link-connection.png" alt-text="Screenshot of link connection to stop link."::: + :::image type="content" source="../media/connect-synapse-link-sql-server-2022/stop-link-connection.png" alt-text="Screenshot of the pane for stopping a link connection."::: > [!NOTE] - > If you restart a link connection after stopping it, it will start from a full initial load from your source database followed by incremental change feeds. + > If you restart a link connection after stopping it, it will start from a full initial load from your source database and incremental change feeds will follow. ## Next steps -If you are using a different type of database, see how to: +If you are using a database other than Azure SQL Database, see: * [Configure Azure Synapse Link for Azure Cosmos DB](../../cosmos-db/configure-synapse-link.md?context=/azure/synapse-analytics/context/context) * [Configure Azure Synapse Link for Dataverse](/powerapps/maker/data-platform/azure-synapse-link-synapse?context=/azure/synapse-analytics/context/context) diff --git a/articles/synapse-analytics/synapse-link/connect-synapse-link-sql-server-2022-vnet.md b/articles/synapse-analytics/synapse-link/connect-synapse-link-sql-server-2022-vnet.md index c1e4fa0a9806e..a963590f8ae39 100644 --- a/articles/synapse-analytics/synapse-link/connect-synapse-link-sql-server-2022-vnet.md +++ b/articles/synapse-analytics/synapse-link/connect-synapse-link-sql-server-2022-vnet.md @@ -1,6 +1,6 @@ --- -title: Configure Synapse link for SQL Server 2022 with network security (Preview) -description: Learn how to configure Synapse link for SQL Server 2022 with network security (Preview). +title: Configure Azure Synapse Link for SQL Server 2022 with network security (preview) +description: Learn how to configure Azure Synapse Link for SQL Server 2022 with network security (preview). author: yexu ms.service: synapse-analytics ms.topic: how-to @@ -10,90 +10,102 @@ ms.author: yexu ms.reviewer: sngun, wiassaf --- -# Configure Synapse link for SQL Server 2022 with network security (Preview) +# Configure Azure Synapse Link for SQL Server 2022 with network security (preview) -This article provides a guide on configuring Azure Synapse Link for SQL Server 2022 with network security. Before reading this documentation, You should have known how to create and start Synapse link for SQL Server 2022 from [Get started with Azure Synapse Link for SQL Server 2022](connect-synapse-link-sql-server-2022.md). +This article is a guide for configuring Azure Synapse Link for SQL Server 2022 with network security. Before you begin this process, you should know how to create and start Azure Synapse Link for SQL Server 2022. For information, see [Get started with Azure Synapse Link for SQL Server 2022](connect-synapse-link-sql-server-2022.md). > [!IMPORTANT] -> Azure Synapse Link for SQL is currently in PREVIEW. +> Azure Synapse Link for SQL is currently in preview. > See the [Supplemental Terms of Use for Microsoft Azure Previews](https://azure.microsoft.com/support/legal/preview-supplemental-terms/) for legal terms that apply to Azure features that are in beta, preview, or otherwise not yet released into general availability. -## Managed workspace Virtual Network without data exfiltration +## Create a managed workspace virtual network without data exfiltration -1. Create Synapse workspace with managed virtual network enabled. You will enable **managed virtual network** and select **No** to allow outbound traffic from the workspace to any target. You can learn more about managed virtual network from [this](../security/synapse-workspace-managed-vnet.md). +In this section, you create an Azure Synapse workspace with a managed virtual network enabled. You'll enable **managed virtual network**, and then select **No** to allow outbound traffic from the workspace to any target. For an overview, see [Azure Synapse Analytics managed virtual network](../security/synapse-workspace-managed-vnet.md). - :::image type="content" source="../media/connect-synapse-link-sql-database/create-synapse-workspace-allow-outbound-traffic.png" alt-text="Screenshot of creating synapse workspace allow outbound traffic."::: + :::image type="content" source="../media/connect-synapse-link-sql-database/create-synapse-workspace-allow-outbound-traffic.png" alt-text="Screenshot that shows how to create an Azure Synapse workspace that allows outbound traffic."::: -1. Navigate to your Synapse workspace on Azure portal, go to **Networking** tab to enable **Allow Azure Synapse Link for Azure SQL Database to bypass firewall rules**. +1. Sign in to the [Azure portal](https://portal.azure.com). - :::image type="content" source="../media/connect-synapse-link-sql-database/enable-bypass-firewall-rules.png" alt-text="Screenshot of enabling bypass firewall rules."::: +1. Go to your Azure Synapse workspace, select **Networking**, and then select the **Allow Azure Synapse Link for Azure SQL Database to bypass firewall rules** checkbox. -1. Launch Synapse Studio, navigate to **Manage**, click **Integration runtimes** and select **AutoResolvingIntegrationRuntime**. On the pop-up slide, you can click **Virtual network** tab, and enable **Interactive authoring**. + :::image type="content" source="../media/connect-synapse-link-sql-database/enable-bypass-firewall-rules.png" alt-text="Screenshot that shows how to enable bypassing firewall rules."::: - :::image type="content" source="../media/connect-synapse-link-sql-database/enable-interactive-authoring.png" alt-text="Screenshot of enabling interactive authoring."::: +1. Open Synapse Studio, go to **Manage**, select **Integration runtimes**, and then select **AutoResolvingIntegrationRuntime**. -1. Now you can create a link connection from **Integrate** tab to replicate data from SQL Server 2022 to Synapse SQL pool. +1. In the pop-up window, select the **Virtual network** tab, and then enable **Interactive authoring**. - :::image type="content" source="../media/connect-synapse-link-sql-database/create-link.png" alt-text="Screenshot of creating a link."::: + :::image type="content" source="../media/connect-synapse-link-sql-database/enable-interactive-authoring.png" alt-text="Screenshot that shows how to enable interactive authoring."::: - :::image type="content" source="../media/connect-synapse-link-sql-database/create-link-sql-server.png" alt-text="Screenshot of creating link sql server."::: +1. From the **Integrate** pane, create a link connection to replicate data from your SQL Server 2022 instance to the Azure Synapse SQL pool. -1. Start your link connection + :::image type="content" source="../media/connect-synapse-link-sql-database/create-link.png" alt-text="Screenshot that shows how to create a link to an Azure Synapse SQL pool."::: + + :::image type="content" source="../media/connect-synapse-link-sql-database/create-link-sql-server.png" alt-text="Screenshot that shows how to create a link connection from an Azure SQL Server 2022 instance."::: + +1. Start your link connection. + + :::image type="content" source="../media/connect-synapse-link-sql-database/start-link.png" alt-text="Screenshot of starting a link connection."::: + + +## Create a managed workspace virtual network with data exfiltration + +In this section, you create an Azure Synapse workspace with managed virtual network enabled. You'll enable **managed virtual network** and select **Yes** to limit outbound traffic from the managed workspace virtual network to targets through managed private endpoints. For an overview, see [Azure Synapse Analytics managed virtual network](../security/synapse-workspace-managed-vnet.md). - :::image type="content" source="../media/connect-synapse-link-sql-database/start-link.png" alt-text="Screenshot of starting a link."::: + :::image type="content" source="../media/connect-synapse-link-sql-database/create-synapse-workspace-disallow-outbound-traffic.png" alt-text="Screenshot that shows how to create an Azure Synapse workspace that disallows outbound traffic."::: +1. Sign in to the [Azure portal](https://portal.azure.com). -## Managed workspace Virtual Network with data exfiltration +1. Go to your Azure Synapse workspace, select **Networking**, and then select the **Allow Azure Synapse Link for Azure SQL Database to bypass firewall rules** checkbox. -1. Create Synapse workspace with managed virtual network enabled. You will enable **managed virtual network** and select **Yes** to limit outbound traffic from the Managed workspace Virtual Network to targets through Managed private endpoints. You can learn more about managed virtual network from [this](../security/synapse-workspace-managed-vnet.md) + :::image type="content" source="../media/connect-synapse-link-sql-database/enable-bypass-firewall-rules.png" alt-text="Screenshot that shows how to enable bypassing firewall rules."::: - :::image type="content" source="../media/connect-synapse-link-sql-database/create-synapse-workspace-disallow-outbound-traffic.png" alt-text="Screenshot of creating synapse workspace disallow outbound traffic."::: +1. Open Synapse Studio, go to **Manage**, select **Integration runtimes**, and then select **AutoResolvingIntegrationRuntime**. -1. Navigate to your Synapse workspace on Azure portal, go to **Networking** tab to enable **Allow Azure Synapse Link for Azure SQL Database to bypass firewall rules**. +1. In the pop-up window, select the **Virtual network** tab, and then enable **Interactive authoring**. - :::image type="content" source="../media/connect-synapse-link-sql-database/enable-bypass-firewall-rules.png" alt-text="Screenshot of enabling bypass firewall rules."::: + :::image type="content" source="../media/connect-synapse-link-sql-database/enable-interactive-authoring.png" alt-text="Screenshot that shows how to enable interactive authoring."::: -1. Launch Synapse Studio, navigate to **Manage**, click **Integration runtimes** and select **AutoResolvingIntegrationRuntime**. On the pop-up slide, you can click **Virtual network** tab, and enable **Interactive authoring**. +1. Create a linked service that connects to your SQL Server 2022 instance. - :::image type="content" source="../media/connect-synapse-link-sql-database/enable-interactive-authoring.png" alt-text="Screenshot of enabling interactive authoring."::: + To learn how, see the "Create a linked service for your source SQL Server 2022 database" section of [Get started with Azure Synapse Link for SQL Server 2022 (preview)](connect-synapse-link-sql-server-2022.md#create-linked-service-for-your-source-sql-server-2022). -1. Create a linked service connecting to SQL Server 2022. You can get more details from [this](connect-synapse-link-sql-server-2022.md#create-linked-service-for-your-source-sql-server-2022). +1. Add a role assignment to ensure that you've granted your Azure Synapse workspace managed identity permissions to your Azure Data Lake Storage Gen2 storage account that's used as the landing zone. -1. Add role assignment to make sure that you have granted your Synapse workspace managed identity permissions to ADLS Gen2 storage account used as the landing zone. You can get more details from [this](connect-synapse-link-sql-server-2022.md#create-linked-service-to-connect-to-your-landing-zone-on-azure-data-lake-storage-gen2). + To learn how, see the "Create a linked service to connect to your landing zone on Azure Data Lake Storage Gen2" section of [Get started with Azure Synapse Link for SQL Server 2022 (preview)](connect-synapse-link-sql-server-2022.md#create-linked-service-to-connect-to-your-landing-zone-on-azure-data-lake-storage-gen2). -1. Create a linked service connecting to ADLS Gen2 storage(landing zone) with managed private endpoint enabled. +1. Create a linked service that connects to your Azure Data Lake Storage Gen2 storage (landing zone) with managed private endpoint enabled. - * Create a managed private endpoint in linked service for ADLS Gen2 storage. + a. Create a managed private endpoint in the linked service for Azure Data Lake Storage Gen2 storage. - :::image type="content" source="../media/connect-synapse-link-sql-database/new-sql-server-linked-service-pe1.png" alt-text="Screenshot of new sql db linked service pe1."::: + :::image type="content" source="../media/connect-synapse-link-sql-database/new-sql-server-linked-service-pe1.png" alt-text="Screenshot of a new Azure SQL Server 2022 database linked service private endpoint 1."::: - * Complete the managed private endpoint creation in the linked service for ADLS Gen2 storage. + b. Complete the managed private endpoint creation in the linked service for Azure Data Lake Storage Gen2 storage. - :::image type="content" source="../media/connect-synapse-link-sql-database/new-sql-server-linked-service-pe2.png" alt-text="Screenshot of new sql db linked service pe2."::: + :::image type="content" source="../media/connect-synapse-link-sql-database/new-sql-server-linked-service-pe2.png" alt-text="Screenshot of a new Azure SQL Server 2022 database linked service private endpoint 2."::: - * Go to Azure portal of your ADLS Gen2 storage as landing zone, approve the Private endpoint connections. + * Go to the Azure portal for your Azure Data Lake Storage Gen2 storage as a landing zone, and then approve the private endpoint connections. - :::image type="content" source="../media/connect-synapse-link-sql-database/new-sql-server-linked-service-pe3.png" alt-text="Screenshot of new sql db linked service pe3."::: + :::image type="content" source="../media/connect-synapse-link-sql-database/new-sql-server-linked-service-pe3.png" alt-text="Screenshot of a new Azure SQL Server 2022 database linked service private endpoint 3."::: - * Complete the creation of linked service for ADLS Gen2 storage. + * Complete the creation of the linked service for Azure Data Lake Storage Gen2 storage. :::image type="content" source="../media/connect-synapse-link-sql-database/new-sql-server-linked-service-pe4.png" alt-text="Screenshot of new sql db linked service pe4."::: -1. Now you can create a link connection from **Integrate** tab to replicate data from SQL Server 2022 to Synapse SQL pool. +1. Now you can create a link connection from the **Integrate** pane to replicate data from your SQL Server 2022 instance to an Azure Synapse SQL pool. - :::image type="content" source="../media/connect-synapse-link-sql-database/create-link.png" alt-text="Screenshot of creating a link."::: + :::image type="content" source="../media/connect-synapse-link-sql-database/create-link.png" alt-text="Screenshot that shows how to create a link."::: - :::image type="content" source="../media/connect-synapse-link-sql-database/create-link-sql-server.png" alt-text="Screenshot of creating link sqldb."::: + :::image type="content" source="../media/connect-synapse-link-sql-database/create-link-sql-server.png" alt-text="Screenshot that shows how to create a link."::: 1. Start your link connection - :::image type="content" source="../media/connect-synapse-link-sql-database/start-link.png" alt-text="Screenshot of starting link."::: + :::image type="content" source="../media/connect-synapse-link-sql-database/start-link.png" alt-text="Screenshot that shows how to start the link connection."::: ## Next steps -If you are using a different type of database, see how to: +If you're using a database other than a SQL Server 2022 instance, see: * [Configure Azure Synapse Link for Azure Cosmos DB](../../cosmos-db/configure-synapse-link.md?context=/azure/synapse-analytics/context/context) * [Configure Azure Synapse Link for Dataverse](/powerapps/maker/data-platform/azure-synapse-link-synapse?context=/azure/synapse-analytics/context/context) diff --git a/articles/synapse-analytics/synapse-link/connect-synapse-link-sql-server-2022.md b/articles/synapse-analytics/synapse-link/connect-synapse-link-sql-server-2022.md index 6f2c5bfeb056d..cacf30220fd42 100644 --- a/articles/synapse-analytics/synapse-link/connect-synapse-link-sql-server-2022.md +++ b/articles/synapse-analytics/synapse-link/connect-synapse-link-sql-server-2022.md @@ -1,6 +1,6 @@ --- -title: Create Azure Synapse Link for SQL Server 2022 (Preview) -description: Learn how to create and connect a SQL Server 2022 instance to an Azure Synapse workspace with Azure Synapse Link (Preview). +title: Create Azure Synapse Link for SQL Server 2022 (preview) +description: Learn how to create and connect a SQL Server 2022 instance to an Azure Synapse workspace by using Azure Synapse Link (preview). author: SnehaGunda ms.service: synapse-analytics ms.topic: how-to @@ -11,263 +11,273 @@ ms.author: sngun ms.reviewer: sngun, wiassaf --- -# Get started with Azure Synapse Link for SQL Server 2022 (Preview) +# Get started with Azure Synapse Link for SQL Server 2022 (preview) -This article provides a step-by-step guide for getting started with Azure Synapse Link for SQL Server 2022. For more information, see [Azure Synapse Link for SQL Server 2022](sql-server-2022-synapse-link.md). +This article is a step-by-step guide for getting started with Azure Synapse Link for SQL Server 2022. For an overview, see [Azure Synapse Link for SQL Server 2022](sql-server-2022-synapse-link.md). > [!IMPORTANT] -> Azure Synapse Link for SQL is currently in PREVIEW. +> Azure Synapse Link for SQL is currently in preview. > See the [Supplemental Terms of Use for Microsoft Azure Previews](https://azure.microsoft.com/support/legal/preview-supplemental-terms/) for legal terms that apply to Azure features that are in beta, preview, or otherwise not yet released into general availability. ## Prerequisites -* [Create a new Synapse workspace](https://portal.azure.com/#create/Microsoft.Synapse) to get Azure Synapse Link for SQL. The current tutorial is to create Synapse link for SQL in public network. The assumption is that you have checked "Disable Managed virtual network" and "Allow connections from all IP address" when creating Synapse workspace. If you want to configure Synapse link for SQL Server 2022 with network security, please also refer to [this](connect-synapse-link-sql-server-2022-vnet.md). +* Before you begin, see [Create a new Azure Synapse workspace](https://portal.azure.com/#create/Microsoft.Synapse) to get Azure Synapse Link for SQL. The current tutorial is to create Azure Synapse Link for SQL in a public network. This article assumes that you selected **Disable Managed virtual network** and **Allow connections from all IP addresses** when you created an Azure Synapse workspace. If you want to configure Azure Synapse Link for SQL Server 2022 with network security, also see [Configure Azure Synapse Link for SQL Server 2022 with network security (preview)](connect-synapse-link-sql-server-2022-vnet.md). +* Create an Azure Data Lake Storage Gen2 account, which is different from the account you create with the Azure Synapse Analytics workspace. You'll use this account as the landing zone to stage the data submitted by SQL Server 2022. For more information, see [Create an Azure Data Lake Storage Gen2 account](../../storage/blobs/create-data-lake-storage-account.md). -* Create an Azure Data Lake Storage Gen2 account (different from the account created with the Azure Synapse Analytics workspace) used as the landing zone to stage the data submitted by SQL Server 2022. See [how to create a Azure Data Lake Storage Gen2 account](../../storage/blobs/create-data-lake-storage-account.md) article for more details. - - -* Make sure your database in SQL Server 2022 has a master key created. +* Make sure that your SQL Server 2022 database has a master key created. ```sql CREATE MASTER KEY ENCRYPTION BY PASSWORD = '' ``` -## Create your target Synapse dedicated SQL pool +## Create your target Azure Synapse SQL dedicated pool -1. Launch [Synapse Studio](https://ms.web.azuresynapse.net/). +1. Open [Synapse Studio](https://ms.web.azuresynapse.net/). -1. Open the **Manage** hub, navigate to **SQL pools**, and select **+ New**. +1. Open the **Manage** hub, go to **SQL pools**, and then select **New**. - :::image type="content" source="../media/connect-synapse-link-sql-database/studio-new-sql-pool.png" alt-text="Screenshot of creating a new SQL dedicated pool from Synapse Studio."::: + :::image type="content" source="../media/connect-synapse-link-sql-database/studio-new-sql-pool.png" alt-text="Screenshot that shows how to create a new Azure Synapse SQL dedicated pool from Synapse Studio."::: 1. Enter a unique pool name, use the default settings, and create the dedicated pool. -1. From the **Data** hub, under **Workspace**, you should see your new Synapse SQL database listed under **Databases**. From your new Synapse SQL database, select **New SQL script**, then **Empty script**. +1. From the **Data** hub, under **Workspace**, your new Azure Synapse SQL database should be listed under **Databases**. From your new Azure Synapse SQL database, select **New SQL script**, and then select **Empty script**. - :::image type="content" source="../media/connect-synapse-link-sql-server-2022/studio-new-empty-sql-script.png" alt-text="Screenshot of creating a new empty SQL script from Synapse Studio."::: + :::image type="content" source="../media/connect-synapse-link-sql-server-2022/studio-new-empty-sql-script.png" alt-text="Screenshot that shows how to create a new empty SQL script from Synapse Studio."::: -1. Paste the following script and select **Run** to create the master key for your target Synapse SQL database. +1. To create the master key for your target Azure Synapse SQL database, paste the following script, and then select **Run**. ```sql CREATE MASTER KEY ``` -## Create linked service for your source SQL Server 2022 +## Create a linked service for your source SQL Server 2022 database -1. Open the **Manage** hub, and navigate to **Linked services**. +1. Open the **Manage** hub, and go to **Linked services**. - :::image type="content" source="../media/connect-synapse-link-sql-server-2022/studio-linked-service-navigation.png" alt-text="Navigate to linked services from Synapse studio."::: + :::image type="content" source="../media/connect-synapse-link-sql-server-2022/studio-linked-service-navigation.png" alt-text="Go to linked services from Synapse Studio."::: -1. Press **+ New**, select **SQL Server** and select **Continue**. +1. Press **New**, select **SQL Server** and select **Continue**. - :::image type="content" source="../media/connect-synapse-link-sql-server-2022/studio-linked-service-select.png" alt-text="Create a SQL server linked service."::: + :::image type="content" source="../media/connect-synapse-link-sql-server-2022/studio-linked-service-select.png" alt-text="Screenshot that shows how to create a SQL server linked service."::: -1. Enter the **name** of linked service of SQL Server 2022. +1. In the **Name** box, enter the name of the linked service of SQL Server 2022. - :::image type="content" source="../media/connect-synapse-link-sql-server-2022/studio-linked-service-new.png" alt-text="Enter server and database names to connect."::: + :::image type="content" source="../media/connect-synapse-link-sql-server-2022/studio-linked-service-new.png" alt-text="Screenshot that shows where to enter the server and database names to connect."::: -1. When selecting the integration runtime, choose your **self-hosted integration runtime**. If your synapse workspace doesn't have self-hosted integration runtime available, create one. +1. When you're choosing the integration runtime, select your self-hosted integration runtime. If your Azure Synapse workspace doesn't have an available self-hosted integration runtime, create one. -1. Use the following steps to create a self-hosted integration runtime to connect to your source SQL Server 2022 (optional) +1. (Optional) To create a self-hosted integration runtime to connect to your source SQL Server 2022, do the following: - * Select **+New**. + a. Select **New**. - :::image type="content" source="../media/connect-synapse-link-sql-server-2022/create-new-integration-runtime.png" alt-text="Creating a new self-hosted integration runtime."::: + :::image type="content" source="../media/connect-synapse-link-sql-server-2022/create-new-integration-runtime.png" alt-text="Screenshot that shows how to create a new self-hosted integration runtime."::: - * Select **Self-hosted** and select **continue**. + b. Select **Self-hosted**, and then select **Continue**. - * Input the **name** of Self-hosted integration runtime and select **Create**. + c. In the **Name** box, enter the name of the self-hosted integration runtime, and then select **Create**. - :::image type="content" source="../media/connect-synapse-link-sql-server-2022/input-name-integration-runtime.png" alt-text="Enter a name for the self-hosted integration runtime."::: + :::image type="content" source="../media/connect-synapse-link-sql-server-2022/input-name-integration-runtime.png" alt-text="Screenshot that shows where to enter a name for the self-hosted integration runtime."::: - * Now a self-hosted integration runtime is available in your Synapse workspace. Follow the prompts in the UI to **download**, **install** and use the key to **register** your integration runtime agent on your windows machine, which has direct access on your SQL Server 2022. For more information, see [Create a self-hosted integration runtime - Azure Data Factory & Azure Synapse](../../data-factory/create-self-hosted-integration-runtime.md?context=%2Fazure%2Fsynapse-analytics%2Fcontext%2Fcontext&tabs=synapse-analytics#install-and-register-a-self-hosted-ir-from-microsoft-download-center) + d. Now a self-hosted integration runtime is available in your Azure Synapse workspace. Follow the prompts to download, install, and use the key to register your integration runtime agent on your Windows machine, which has direct access to your SQL Server 2022 instance. For more information, see [Create a self-hosted integration runtime - Azure Data Factory and Azure Synapse](../../data-factory/create-self-hosted-integration-runtime.md?context=%2Fazure%2Fsynapse-analytics%2Fcontext%2Fcontext&tabs=synapse-analytics#install-and-register-a-self-hosted-ir-from-microsoft-download-center). - :::image type="content" source="../media/connect-synapse-link-sql-server-2022/set-up-integration-runtime.png" alt-text="Download, install and register the integration runtime."::: + :::image type="content" source="../media/connect-synapse-link-sql-server-2022/set-up-integration-runtime.png" alt-text="Screenshot that shows where to download, install, and register the integration runtime."::: - * Select **Close**, and go to monitoring page to make sure your self-hosted integration runtime is running by selecting **refresh** to get the latest status of integration runtime. + e. Select **Close**. :::image type="content" source="../media/connect-synapse-link-sql-server-2022/integration-runtime-status.png" alt-text="Get the status of integration runtime."::: -1. Continue to input the rest information on your linked service including **SQL Server name**, **Database name**, **Authentication type**, **User name** and **Password** to connect to your SQL Server 2022. + f. Go to the monitoring page, and then ensure that your self-hosted integration runtime is running by selecting **Refresh** to get the latest status of integration runtime. + +1. Continue to enter the remaining information for your linked service, including **SQL Server name**, **Database name**, **Authentication type**, **User name**, and **Password** to connect to your SQL Server 2022 instance. > [!NOTE] - > We recommend that you enable encryption on this connection. To enable encryption, add the `Encrypt` property with a value of `true` as an Additional connection property, and also set the `Trust Server Certificate` property to either `true` or `false` - depending on your server configuration. For more information, see [Enable encrypted connections to the Database Engine](/sql/database-engine/configure-windows/enable-encrypted-connections-to-the-database-engine). + > We recommend that you enable encryption on this connection. To do so, add the `Encrypt` property with a value of `true` as an additional connection property. Also set the `Trust Server Certificate` property to either `true` or `false`, depending on your server configuration. For more information, see [Enable encrypted connections to the database engine](/sql/database-engine/configure-windows/enable-encrypted-connections-to-the-database-engine). -1. Select **Test Connection** to ensure your self-hosted integration runtime can access on your SQL Server. +1. Select **Test Connection** to ensure that your self-hosted integration runtime can access your SQL Server instance. -1. Select **Create**, and you'll have your new linked service connecting to SQL Server 2022 available in your workspace. +1. Select **Create**. - :::image type="content" source="../media/connect-synapse-link-sql-server-2022/view-linked-service-connection.png" alt-text="View the linked service connection."::: + Your new linked service will be connected to the SQL Server 2022 instance that's available in your workspace. + + :::image type="content" source="../media/connect-synapse-link-sql-server-2022/view-linked-service-connection.png" alt-text="Screenshot that shows where to view the linked service connection."::: > [!NOTE] - > The linked service that you create here is not dedicated to Azure Synapse Link for SQL - it can be used by any workspace user that has the appropriate permissions. Please take time to understand the scope of users who may have access to this linked service and its credentials. For more information on permissions in Azure Synapse workspaces, see [Azure Synapse workspace access control overview - Azure Synapse Analytics](../security/synapse-workspace-access-control-overview.md). + > The linked service that you create here isn't dedicated to Azure Synapse Link for SQL. It can be used by any workspace user who has the appropriate permissions. Take time to understand the scope of users who might have access to this linked service and its credentials. For more information about permissions in Azure Synapse workspaces, see [Azure Synapse workspace access control overview - Azure Synapse Analytics](../security/synapse-workspace-access-control-overview.md). -## Create linked service to connect to your landing zone on Azure Data Lake Storage Gen2 +## Create a linked service to connect to your landing zone on Azure Data Lake Storage Gen2 -1. Go to your created Azure Data Lake Storage Gen2 account, navigate to **Access Control (IAM)**, select **+Add**, and select **Add role assignment**. +1. Go to your newly created Azure Data Lake Storage Gen2 account, select **Access Control (IAM)**, select **Add**, and then select **Add role assignment**. - :::image type="content" source="../media/connect-synapse-link-sql-server-2022/adls-gen2-access-control.png" alt-text="Navigate to Access Control (IAM) of the Data Lake Storage Gen2 account."::: + :::image type="content" source="../media/connect-synapse-link-sql-server-2022/adls-gen2-access-control.png" alt-text="Screenshot of the 'Access Control (IAM)' pane of the Data Lake Storage Gen2 account."::: -1. Select **Storage Blob Data Contributor** for the selected role, choose **Managed identity** in Managed identity, and select your Synapse workspace in **Members**. This may take a few minutes to take effect to add role assignment. +1. Select **Storage Blob Data Contributor** for the chosen role, select **Managed identity** and then, under **Members**, select your Azure Synapse workspace. Adding this role assignment might take a few minutes. - :::image type="content" source="../media/connect-synapse-link-sql-server-2022/adls-gen2-assign-blob-data-contributor-role.png" alt-text="Add a role assignment."::: + :::image type="content" source="../media/connect-synapse-link-sql-server-2022/adls-gen2-assign-blob-data-contributor-role.png" alt-text="Screenshot that shows how to add a role assignment."::: > [!NOTE] - > Make sure that you have granted your Synapse workspace managed identity permissions to ADLS Gen2 storage account used as the landing zone. For more information, see how to [Grant permissions to managed identity in Synapse workspace - Azure Synapse Analytics](../security/how-to-grant-workspace-managed-identity-permissions.md#grant-the-managed-identity-permissions-to-adls-gen2-storage-account) + > Make sure that you've granted your Azure Synapse workspace managed identity permissions to the Azure Data Lake Storage Gen2 storage account that's used as the landing zone. For more information, see [Grant permissions to a managed identity in an Azure Synapse workspace - Azure Synapse Analytics](../security/how-to-grant-workspace-managed-identity-permissions.md#grant-the-managed-identity-permissions-to-adls-gen2-storage-account). + +1. Open the **Manage** hub in your Azure Synapse workspace, and go to **Linked services**. -1. Open the **Manage** hub in your Synapse workspace, and navigate to **Linked services**. + :::image type="content" source="../media/connect-synapse-link-sql-server-2022/studio-linked-service-navigation.png" alt-text="Screenshot that shows how to go to the linked service."::: - :::image type="content" source="../media/connect-synapse-link-sql-server-2022/studio-linked-service-navigation.png" alt-text="Navigate to the linked service."::: +1. Select **New**, and then select **Azure Data Lake Storage Gen2**. -1. Press **+ New** and select **Azure Data Lake Storage Gen2**. +1. Do the following: -1. Input the following settings: + a. In the **Name** box, enter the name of the linked service for your landing zone. - * Enter the **name** of linked service for your landing zone. + b. For **Authentication method**, enter **Managed Identity**. - * Input **Authentication method**, and it must be **Managed Identity**. + c. Select the **Storage account name**, which has already been created. - * Select the **Storage account name** which had already been created. +1. Select **Test Connection** to ensure that you can access your Azure Data Lake Storage Gen2 account. -1. Select **Test Connection** to ensure you get access on your Azure Data Lake Storage Gen2. +1. Select **Create**. -1. Select **Create** and you'll have your new linked service connecting to Azure Data Lake Storage Gen2. + Your new linked service will be connected to the Azure Data Lake Storage Gen2 account. - :::image type="content" source="../media/connect-synapse-link-sql-server-2022/storage-gen2-linked-service-created.png" alt-text="New linked service to Azure Data Lake Storage Gen2."::: + :::image type="content" source="../media/connect-synapse-link-sql-server-2022/storage-gen2-linked-service-created.png" alt-text="Screenshot that shows the new linked service to Azure Data Lake Storage Gen2."::: > [!NOTE] - > The linked service that you create here is not dedicated to Azure Synapse Link for SQL - it can be used by any workspace user that has the appropriate permissions. Please take time to understand the scope of users who may have access to this linked service and its credentials. For more information on permissions in Azure Synapse workspaces, see [Azure Synapse workspace access control overview - Azure Synapse Analytics](../security/synapse-workspace-access-control-overview.md). + > The linked service that you create here isn't dedicated to Azure Synapse Link for SQL. It can be used by any workspace user who has the appropriate permissions. Take time to understand the scope of users who might have access to this linked service and its credentials. For more information about permissions in Azure Synapse workspaces, see [Azure Synapse workspace access control overview - Azure Synapse Analytics](../security/synapse-workspace-access-control-overview.md). ## Create the Azure Synapse Link connection -1. From the Synapse studio, open the **Integrate** hub, and select **+Link connection(Preview)**. +1. From Synapse Studio, open the **Integrate** hub. - :::image type="content" source="../media/connect-synapse-link-sql-server-2022/new-link-connection.png" alt-text="New link connection."::: -1. Input your source database: +1. On the **Integrate** pane, select the plus sign (**+**), and then select **Link connection (Preview)**. - * Select Source type to **SQL Server**. + :::image type="content" source="../media/connect-synapse-link-sql-server-2022/new-link-connection.png" alt-text="Screenshot that shows the 'Link connection (Preview)' button."::: - * Select your source **linked service** to connect to your SQL Server 2022. +1. Enter your source database: - * Select **table names** from your SQL Server to be replicated to your Synapse SQL pool. + a. For **Source type**, select **SQL Server**. - * Select **Continue**. + b, For your source **Linked service**, select the service that connects to your SQL Server 2022 instance. - :::image type="content" source="../media/connect-synapse-link-sql-server-2022/input-source-database-details-link-connection.png" alt-text="Input source database details."::: + c. For **Table names**, select names from your SQL Server instance to be replicated to your Azure Synapse SQL pool. -1. Select a target database name from **Synapse SQL Dedicated Pools**. + d. Select **Continue**. + + :::image type="content" source="../media/connect-synapse-link-sql-server-2022/input-source-database-details-link-connection.png" alt-text="Screenshot that shows where to enter source database details."::: + +1. From **Synapse SQL Dedicated Pools**, select a target database name. 1. Select **Continue**. -1. Input your link connection settings: +1. Enter your link connection settings: - * Input your **link connection name**. + a. For **Link connection name**, enter the name. - * Select your **Core count** for the [link connection compute](sql-server-2022-synapse-link.md#link-connection). These cores will be used for the movement of data from the source to the target. We recommend starting from small number and increasing as needed. + b. For **Core count** for the [link connection compute](sql-server-2022-synapse-link.md#link-connection), enter the number of cores. These cores will be used for the movement of data from the source to the target. We recommend that you start with a small number and increase the count as needed. - * Configure your landing zone. Select your **linked service** connecting to your landing zone. + c. For **Linked service**, select the service that will connect to your landing zone. - * Input your ADLS Gen2 **container name or container/folder name** as landing zone folder path for staging the data. The container is required to be created first. + d. Enter your Azure Data Lake Storage Gen2 **container name or container/folder name** as a landing zone folder path for staging the data. The container must be created first. - * Input your ADLS Gen2 shared access signature (SAS) token. SAS token is required for SQL change feed to get access on landing zone. If your ADLS Gen2 doesn't have SAS token, you can create one by selecting **+Generate token**. + e. Input your Azure Data Lake Storage Gen2 shared access signature token. The token is required for the SQL change feed to access the landing zone. If your Azure Data Lake Storage Gen2 account doesn't have a shared access signature token, you can create one by selecting **Generate token**. - * Select **OK**. + f. Select **OK**. - :::image type="content" source="../media/connect-synapse-link-sql-server-2022/link-connection-compute-settings.png" alt-text="Input the link connection settings."::: + :::image type="content" source="../media/connect-synapse-link-sql-server-2022/link-connection-compute-settings.png" alt-text="Screenshot that shows where to enter the link connection settings."::: -1. With the new Azure Synapse Link connection open, you have chance to update the target table name, distribution type and structure type. +1. With the new Azure Synapse Link connection open, you can now update the target table name, distribution type, and structure type. > [!NOTE] - > * Consider heap table for structure type when your data contains varchar(max), nvarchar(max), and varbinary(max). - > * Make sure the schema in your Synapse SQL pool has already been created before you start the link connection. Azure Synapse Link will help you to create tables automatically under your schema in Azure Synapse SQL Pool. + > * Consider using *heap table* for the structure type when your data contains varchar(max), nvarchar(max), and varbinary(max). + > * Make sure that the schema in your Azure Synapse SQL dedicated pool has already been created before you start the link connection. Azure Synapse Link for SQL will create tables automatically under your schema in the Azure Synapse SQL pool. 1. Select **Publish all** to save the new link connection to the service. ## Start the Azure Synapse Link connection -1. Select **Start** and wait a few minutes for the data to be replicated. +1. Select **Start**, and then wait a few minutes for the data to be replicated. > [!NOTE] - > When being started, a link connection will start from a full initial load from your source database followed by incremental change feeds via the change feed feature in SQL Server 2022. For more information, see [Azure Synapse Link for SQL change feed](/sql/sql-server/synapse-link/synapse-link-sql-server-change-feed). + > A link connection will start from a full initial load from your source database, followed by incremental change feeds via the change feed feature in SQL Server 2022. For more information, see [Azure Synapse Link for SQL change feed](/sql/sql-server/synapse-link/synapse-link-sql-server-change-feed). ## Monitor Azure Synapse Link for SQL Server 2022 -You may monitor the status of your Azure Synapse Link connection, see which tables are being initially copied over (Snapshotting), and see which tables are in continuous replication mode (Replicating). - -1. Navigate to the **Monitor hub** of your Synapse workspace. +You can monitor the status of your Azure Synapse Link connection, see which tables are being initially copied over (*snapshotting*), and see which tables are in continuous replication mode (*replicating*). -1. Select **Link connections**. +1. Go to the **Monitor hub** of your Azure Synapse workspace, and then select **Link connections**. -1. Open the link connection you started and view the status of each table. +1. Open the link connection you started, and view the status of each table. 1. Select **Refresh** on the monitoring view for your connection to observe any updates to the status. :::image type="content" source="../media/connect-synapse-link-sql-server-2022/monitor-link-connection.png" alt-text="Monitor the linked connection."::: -## Query replicated data +## Query the replicated data + +Wait for a few minutes, and then check to ensure that the target database has the expected table and data. See the data available in your Azure Synapse SQL dedicated pool destination store. You can also now explore the replicated tables in your target Azure Synapse SQL dedicated pool. + +1. In the **Data** hub, under **Workspace**, open your target database. -Wait for a few minutes, then check the target database has the expected table and data. See the data available in your Synapse dedicated SQL pool destination store. You can also now explore the replicated tables in your target Synapse dedicated SQL pool. +1. Under **Tables**, right-click one of your target tables. -1. In the **Data** hub, under **Workspace**, open your target database, and within **Tables**, right-click one of your target tables. +1. Select **New SQL script**, and then select **Top 100 rows**. -1. Choose **New SQL script**, then **Select TOP 100 rows**. +1. Run this query to view the replicated data in your target Azure Synapse SQL dedicated pool. -1. Run this query to view the replicated data in your target Synapse dedicated SQL pool. +1. You can also query the target database by using Microsoft SQL Server Management Studio (SSMS) or other tools. Use the SQL dedicated endpoint for your workspace as the server name. This name is usually `.sql.azuresynapse.net`. Add `Database=databasename@poolname` as an extra connection string parameter when connecting via SSMS or other tools. -1. You can also query the target database with SSMS (or other tools). Use the dedicated SQL endpoint for your workspace as the server name. This is typically `.sql.azuresynapse.net`. Add `Database=databasename@poolname` as an extra connection string parameter when connecting via SSMS (or other tools). +## Add or remove a table in an existing Azure Synapse Link connection -## Add/remove table in existing Azure Synapse Link connection +To add or remove tables in Synapse Studio, do the following: -You can add/remove tables on Synapse Studio as follows: +1. In your Azure Synapse workspace, open the **Integrate** hub. -1. Open the **Integrate Hub**. +1. Select the link connection that you want to edit, and then open it. -1. Select the **Link connection** you want to edit and open it. +1. Do either of the following: -1. Select **+New** table to add tables on Synapse Studio or select the trash can icon to the right of a table to remove an existing table. You can add or remove tables when the link connection is running. + * To add a table, select **New**. + * To remove a table, select the trash can icon next to it. - :::image type="content" source="../media/connect-synapse-link-sql-server-2022/link-connection-add-remove-tables.png" alt-text="Link connection add table."::: + :::image type="content" source="../media/connect-synapse-link-sql-server-2022/link-connection-add-remove-tables.png" alt-text="Screenshot of the link connection pane for adding or removing tables."::: > [!NOTE] > You can directly add or remove tables when a link connection is running. ## Stop the Azure Synapse Link connection -You can stop the Azure Synapse Link connection on Synapse Studio as follows: +To stop the Azure Synapse Link connection in Synapse Studio, do the following: -1. Open the **Integrate Hub** of your Synapse workspace. +1. In your Azure Synapse workspace, open the **Integrate** hub. -1. Select the **Link connection** you want to edit and open it. +1. Select the link connection that you want to edit, and then open it. 1. Select **Stop** to stop the link connection, and it will stop replicating your data. - :::image type="content" source="../media/connect-synapse-link-sql-server-2022/stop-link-connection.png" alt-text="Link connection stop link."::: + :::image type="content" source="../media/connect-synapse-link-sql-server-2022/stop-link-connection.png" alt-text="Screenshot of the pane for stopping a link connection."::: > [!NOTE] - > If you restart a link connection after stopping it, it will start from a full initial load from your source database followed by incremental change feeds. + > If you restart a link connection after stopping it, it will start from a full initial load from your source database and incremental change feeds will follow. -## Rotate the SAS token for landing zone +## Rotate the shared access signature token for the landing zone -A SAS token is required for SQL change feed to get access to the landing zone and push data there. It has an expiration date so you need to rotate the SAS token before the expiration date. Otherwise, Azure Synapse Link will fail to replicate the data from SQL Server to the Synapse dedicated SQL pool. +A shared access signature token is required for the SQL change feed to get access to the landing zone and push data there. It has an expiration date, so you need to rotate the token before that date. Otherwise, Azure Synapse Link will fail to replicate the data from the SQL Server instance to the Azure Synapse SQL dedicated pool. -1. Open the **Integrate Hub** of your Synapse workspace. +1. In your Azure Synapse workspace, open the **Integrate** hub. -1. Select the **Link connection** you want to edit and open it. +1. Select the link connection that you want to edit, and then open it. 1. Select **Rotate token**. - :::image type="content" source="../media/connect-synapse-link-sql-server-2022/link-connection-locate-rotate-token.png" alt-text="Rotate S A S token."::: + :::image type="content" source="../media/connect-synapse-link-sql-server-2022/link-connection-locate-rotate-token.png" alt-text="Screenshot that shows where to rotate a shared access signature token."::: -1. Select **Generate automatically** or **Input manually** to get the new SAS token, and then select **OK**. +1. To get the new shared access signature token, select **Generate automatically** or **Input manually**, and then select **OK**. - :::image type="content" source="../media/connect-synapse-link-sql-server-2022/landing-zone-rotate-sas-token.png" alt-text="Get the new S A S token."::: + :::image type="content" source="../media/connect-synapse-link-sql-server-2022/landing-zone-rotate-sas-token.png" alt-text="Screenshot that shows how to get a new shared access signature token."::: ## Next steps -If you are using a different type of database, see how to: +If you're using a database other than SQL Server 2022, see: * [Configure Azure Synapse Link for Azure Cosmos DB](../../cosmos-db/configure-synapse-link.md?context=/azure/synapse-analytics/context/context) * [Configure Azure Synapse Link for Dataverse](/powerapps/maker/data-platform/azure-synapse-link-synapse?context=/azure/synapse-analytics/context/context) From 196ba7b75dc6ab297de9ce7bab64db658b1ead43 Mon Sep 17 00:00:00 2001 From: Jim Wells Date: Fri, 14 Oct 2022 12:54:21 -0700 Subject: [PATCH 2/9] Update connect-synapse-link-sql-server-2022-vnet.md --- .../connect-synapse-link-sql-server-2022-vnet.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/articles/synapse-analytics/synapse-link/connect-synapse-link-sql-server-2022-vnet.md b/articles/synapse-analytics/synapse-link/connect-synapse-link-sql-server-2022-vnet.md index a963590f8ae39..960d1c8056013 100644 --- a/articles/synapse-analytics/synapse-link/connect-synapse-link-sql-server-2022-vnet.md +++ b/articles/synapse-analytics/synapse-link/connect-synapse-link-sql-server-2022-vnet.md @@ -67,11 +67,11 @@ In this section, you create an Azure Synapse workspace with managed virtual netw 1. Create a linked service that connects to your SQL Server 2022 instance. - To learn how, see the "Create a linked service for your source SQL Server 2022 database" section of [Get started with Azure Synapse Link for SQL Server 2022 (preview)](connect-synapse-link-sql-server-2022.md#create-linked-service-for-your-source-sql-server-2022). + To learn how, see the "Create a linked service for your source SQL Server 2022 database" section of [Get started with Azure Synapse Link for SQL Server 2022 (preview)](connect-synapse-link-sql-server-2022.md#create-a-linked-service-for-your-source-sql-server-2022-database). 1. Add a role assignment to ensure that you've granted your Azure Synapse workspace managed identity permissions to your Azure Data Lake Storage Gen2 storage account that's used as the landing zone. - To learn how, see the "Create a linked service to connect to your landing zone on Azure Data Lake Storage Gen2" section of [Get started with Azure Synapse Link for SQL Server 2022 (preview)](connect-synapse-link-sql-server-2022.md#create-linked-service-to-connect-to-your-landing-zone-on-azure-data-lake-storage-gen2). + To learn how, see the "Create a linked service to connect to your landing zone on Azure Data Lake Storage Gen2" section of [Get started with Azure Synapse Link for SQL Server 2022 (preview)](connect-synapse-link-sql-server-2022.md#create-a-linked-service-to-connect-to-your-landing-zone-on-azure-data-lake-storage-gen2). 1. Create a linked service that connects to your Azure Data Lake Storage Gen2 storage (landing zone) with managed private endpoint enabled. @@ -95,7 +95,7 @@ In this section, you create an Azure Synapse workspace with managed virtual netw :::image type="content" source="../media/connect-synapse-link-sql-database/create-link.png" alt-text="Screenshot that shows how to create a link."::: - :::image type="content" source="../media/connect-synapse-link-sql-database/create-link-sql-server.png" alt-text="Screenshot that shows how to create a link."::: + :::image type="content" source="../media/connect-synapse-link-sql-database/create-link-sql-server.png" alt-text="Screenshot that shows how to create a link from the SQL Server 2022 instance."::: 1. Start your link connection From f0748d2823b5c489f4323f1700e6fed1b38aa06f Mon Sep 17 00:00:00 2001 From: Jim Wells Date: Fri, 14 Oct 2022 13:25:46 -0700 Subject: [PATCH 3/9] Update connect-synapse-link-sql-database.md --- .../connect-synapse-link-sql-database.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/articles/synapse-analytics/synapse-link/connect-synapse-link-sql-database.md b/articles/synapse-analytics/synapse-link/connect-synapse-link-sql-database.md index a83c6b8ec4114..ed9fe6e255271 100644 --- a/articles/synapse-analytics/synapse-link/connect-synapse-link-sql-database.md +++ b/articles/synapse-analytics/synapse-link/connect-synapse-link-sql-database.md @@ -52,7 +52,7 @@ This article is a step-by-step guide for getting started with Azure Synapse Link ALTER ROLE [db_owner] ADD MEMBER ; ``` -1. You can create a table with your own schema. The following code is just an example for a `CREATE TABLE` query. You can also insert some rows into this table to ensure that there's data to be replicated. +1. You can create a table with your own schema. The following code is just an example of a `CREATE TABLE` query. You can also insert some rows into this table to ensure that there's data to be replicated. ```sql CREATE TABLE myTestTable1 (c1 int primary key, c2 int, c3 nvarchar(50)) @@ -160,13 +160,13 @@ Wait for a few minutes, and then check to ensure that the target database has th To add or remove tables in Synapse Studio, do the following: -1. Open the **Integrate Hub**. +1. Open the **Integrate** hub. 1. Select the link connection that you want to edit, and then open it. 1. Do either of the following: - * To add a table, select **New**. + * To add a table, select **New table**. * To remove a table, select the trash can icon next to it. :::image type="content" source="../media/connect-synapse-link-sql-server-2022/link-connection-add-remove-tables.png" alt-text="Screenshot of the link connection pane for adding or removing tables."::: @@ -187,13 +187,13 @@ To stop the Azure Synapse Link connection in Synapse Studio, do the following: :::image type="content" source="../media/connect-synapse-link-sql-server-2022/stop-link-connection.png" alt-text="Screenshot of the pane for stopping a link connection."::: > [!NOTE] - > If you restart a link connection after stopping it, it will start from a full initial load from your source database and incremental change feeds will follow. + > If you restart a link connection after stopping it, it will start from a full initial load from your source database, and incremental change feeds will follow. ## Next steps -If you are using a database other than Azure SQL Database, see: +If you're using a database other than an Azure SQL database, see: * [Configure Azure Synapse Link for Azure Cosmos DB](../../cosmos-db/configure-synapse-link.md?context=/azure/synapse-analytics/context/context) * [Configure Azure Synapse Link for Dataverse](/powerapps/maker/data-platform/azure-synapse-link-synapse?context=/azure/synapse-analytics/context/context) * [Get started with Azure Synapse Link for SQL Server 2022](connect-synapse-link-sql-server-2022.md) -* [Get or set a managed identity for an Azure SQL Database logical server or managed instance](/sql/azure-sql/database/authentication-azure-ad-user-assigned-managed-identity.md#get-or-set-a-managed-identity-for-a-logical-server-or-managed-instance) \ No newline at end of file +* [Get or set a managed identity for an Azure SQL Database logical server or managed instance](/sql/azure-sql/database/authentication-azure-ad-user-assigned-managed-identity.md#get-or-set-a-managed-identity-for-a-logical-server-or-managed-instance) From 51fcdc658731657731a60cd04ff85aa4fa803def Mon Sep 17 00:00:00 2001 From: Jim Wells Date: Fri, 14 Oct 2022 13:35:55 -0700 Subject: [PATCH 4/9] Update connect-synapse-link-sql-database-vnet.md --- .../synapse-link/connect-synapse-link-sql-database-vnet.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/articles/synapse-analytics/synapse-link/connect-synapse-link-sql-database-vnet.md b/articles/synapse-analytics/synapse-link/connect-synapse-link-sql-database-vnet.md index 5576c41a0b54d..249f0d78c31aa 100644 --- a/articles/synapse-analytics/synapse-link/connect-synapse-link-sql-database-vnet.md +++ b/articles/synapse-analytics/synapse-link/connect-synapse-link-sql-database-vnet.md @@ -20,7 +20,7 @@ This article is a guide for configuring Azure Synapse Link for Azure SQL Databas ## Create a managed workspace virtual network without data exfiltration -In this section, you create an Azure Synapse workspace with a managed virtual network enabled. You'll enable **managed virtual network**, and then select **No** to allow outbound traffic from the workspace to any target. For an overview, see [Azure Synapse Analytics managed virtual network](../security/synapse-workspace-managed-vnet.md). +In this section, you create an Azure Synapse workspace with a managed virtual network enabled. For **Managed virtual network**, you'll select **Enable**, and for **Allow outbound data traffic only to approved targets**, you'll select **No**. For an overview, see [Azure Synapse Analytics managed virtual network](../security/synapse-workspace-managed-vnet.md). :::image type="content" source="../media/connect-synapse-link-sql-database/create-synapse-workspace-allow-outbound-traffic.png" alt-text="Screenshot that shows how to create an Azure Synapse workspace that allows outbound traffic."::: @@ -48,7 +48,7 @@ In this section, you create an Azure Synapse workspace with a managed virtual ne ## Create a managed workspace virtual network with data exfiltration -In this section, you create an Azure Synapse workspace with managed virtual network enabled. You'll enable **managed virtual network** and select **Yes** to limit outbound traffic from the managed workspace virtual network to targets through managed private endpoints. For an overview, see [Azure Synapse Analytics managed virtual network](../security/synapse-workspace-managed-vnet.md). +In this section, you create an Azure Synapse workspace with managed virtual network enabled. You'll enable **Managed virtual network**, and you'll select **Yes** to limit outbound traffic from the managed workspace virtual network to targets through managed private endpoints. For an overview, see [Azure Synapse Analytics managed virtual network](../security/synapse-workspace-managed-vnet.md). :::image type="content" source="../media/connect-synapse-link-sql-database/create-synapse-workspace-disallow-outbound-traffic.png" alt-text="Screenshot that shows how to create an Azure Synapse workspace that disallows outbound traffic."::: @@ -66,7 +66,7 @@ In this section, you create an Azure Synapse workspace with managed virtual netw 1. Create a linked service that connects to your Azure SQL database with a managed private endpoint enabled. - a. Create a linked service connecting to your Azure SQL database. + a. Create a linked service that connects to your Azure SQL database. :::image type="content" source="../media/connect-synapse-link-sql-database/new-sql-db-linked-service-pe.png" alt-text="Screenshot of a new Azure SQL database linked service private endpoint."::: From 21f67e2fee5801484881430c36a57f00deee271e Mon Sep 17 00:00:00 2001 From: Jim Wells Date: Fri, 14 Oct 2022 13:50:48 -0700 Subject: [PATCH 5/9] Update connect-synapse-link-sql-server-2022.md --- .../connect-synapse-link-sql-server-2022.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/articles/synapse-analytics/synapse-link/connect-synapse-link-sql-server-2022.md b/articles/synapse-analytics/synapse-link/connect-synapse-link-sql-server-2022.md index cacf30220fd42..e79366b2b1bd8 100644 --- a/articles/synapse-analytics/synapse-link/connect-synapse-link-sql-server-2022.md +++ b/articles/synapse-analytics/synapse-link/connect-synapse-link-sql-server-2022.md @@ -53,7 +53,7 @@ This article is a step-by-step guide for getting started with Azure Synapse Link ## Create a linked service for your source SQL Server 2022 database -1. Open the **Manage** hub, and go to **Linked services**. +1. Select the **Manage** hub button, and then select **Linked services**. :::image type="content" source="../media/connect-synapse-link-sql-server-2022/studio-linked-service-navigation.png" alt-text="Go to linked services from Synapse Studio."::: @@ -79,7 +79,9 @@ This article is a step-by-step guide for getting started with Azure Synapse Link :::image type="content" source="../media/connect-synapse-link-sql-server-2022/input-name-integration-runtime.png" alt-text="Screenshot that shows where to enter a name for the self-hosted integration runtime."::: - d. Now a self-hosted integration runtime is available in your Azure Synapse workspace. Follow the prompts to download, install, and use the key to register your integration runtime agent on your Windows machine, which has direct access to your SQL Server 2022 instance. For more information, see [Create a self-hosted integration runtime - Azure Data Factory and Azure Synapse](../../data-factory/create-self-hosted-integration-runtime.md?context=%2Fazure%2Fsynapse-analytics%2Fcontext%2Fcontext&tabs=synapse-analytics#install-and-register-a-self-hosted-ir-from-microsoft-download-center). + A self-hosted integration runtime is now available in your Azure Synapse workspace. + + d. Follow the prompts to download, install, and use the key to register your integration runtime agent on your Windows machine, which has direct access to your SQL Server 2022 instance. For more information, see [Create a self-hosted integration runtime - Azure Data Factory and Azure Synapse](../../data-factory/create-self-hosted-integration-runtime.md?context=%2Fazure%2Fsynapse-analytics%2Fcontext%2Fcontext&tabs=synapse-analytics#install-and-register-a-self-hosted-ir-from-microsoft-download-center). :::image type="content" source="../media/connect-synapse-link-sql-server-2022/set-up-integration-runtime.png" alt-text="Screenshot that shows where to download, install, and register the integration runtime."::: @@ -178,7 +180,7 @@ This article is a step-by-step guide for getting started with Azure Synapse Link d. Enter your Azure Data Lake Storage Gen2 **container name or container/folder name** as a landing zone folder path for staging the data. The container must be created first. - e. Input your Azure Data Lake Storage Gen2 shared access signature token. The token is required for the SQL change feed to access the landing zone. If your Azure Data Lake Storage Gen2 account doesn't have a shared access signature token, you can create one by selecting **Generate token**. + e. Enter your Azure Data Lake Storage Gen2 shared access signature token. The token is required for the SQL change feed to access the landing zone. If your Azure Data Lake Storage Gen2 account doesn't have a shared access signature token, you can create one by selecting **Generate token**. f. Select **OK**. @@ -235,7 +237,7 @@ To add or remove tables in Synapse Studio, do the following: 1. Do either of the following: - * To add a table, select **New**. + * To add a table, select **New table**. * To remove a table, select the trash can icon next to it. :::image type="content" source="../media/connect-synapse-link-sql-server-2022/link-connection-add-remove-tables.png" alt-text="Screenshot of the link connection pane for adding or removing tables."::: From 272e03aa30acc8b6a14b30e9ddcd20a4af0addbe Mon Sep 17 00:00:00 2001 From: Jim Wells Date: Fri, 14 Oct 2022 13:55:33 -0700 Subject: [PATCH 6/9] Update connect-synapse-link-sql-server-2022-vnet.md --- .../connect-synapse-link-sql-server-2022-vnet.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/articles/synapse-analytics/synapse-link/connect-synapse-link-sql-server-2022-vnet.md b/articles/synapse-analytics/synapse-link/connect-synapse-link-sql-server-2022-vnet.md index 960d1c8056013..8751830a7f3e1 100644 --- a/articles/synapse-analytics/synapse-link/connect-synapse-link-sql-server-2022-vnet.md +++ b/articles/synapse-analytics/synapse-link/connect-synapse-link-sql-server-2022-vnet.md @@ -36,7 +36,7 @@ In this section, you create an Azure Synapse workspace with a managed virtual ne :::image type="content" source="../media/connect-synapse-link-sql-database/enable-interactive-authoring.png" alt-text="Screenshot that shows how to enable interactive authoring."::: -1. From the **Integrate** pane, create a link connection to replicate data from your SQL Server 2022 instance to the Azure Synapse SQL pool. +1. On the **Integrate** pane, create a link connection to replicate data from your SQL Server 2022 instance to the Azure Synapse SQL pool. :::image type="content" source="../media/connect-synapse-link-sql-database/create-link.png" alt-text="Screenshot that shows how to create a link to an Azure Synapse SQL pool."::: @@ -83,11 +83,11 @@ In this section, you create an Azure Synapse workspace with managed virtual netw :::image type="content" source="../media/connect-synapse-link-sql-database/new-sql-server-linked-service-pe2.png" alt-text="Screenshot of a new Azure SQL Server 2022 database linked service private endpoint 2."::: - * Go to the Azure portal for your Azure Data Lake Storage Gen2 storage as a landing zone, and then approve the private endpoint connections. + c. Go to the Azure portal for your Azure Data Lake Storage Gen2 storage as a landing zone, and then approve the private endpoint connections. :::image type="content" source="../media/connect-synapse-link-sql-database/new-sql-server-linked-service-pe3.png" alt-text="Screenshot of a new Azure SQL Server 2022 database linked service private endpoint 3."::: - * Complete the creation of the linked service for Azure Data Lake Storage Gen2 storage. + d. Complete the creation of the linked service for Azure Data Lake Storage Gen2 storage. :::image type="content" source="../media/connect-synapse-link-sql-database/new-sql-server-linked-service-pe4.png" alt-text="Screenshot of new sql db linked service pe4."::: From 7891472162d491f0a1c9fcae3b2ed6e99838ad46 Mon Sep 17 00:00:00 2001 From: Jim Wells Date: Fri, 14 Oct 2022 14:02:54 -0700 Subject: [PATCH 7/9] Update connect-synapse-link-sql-database.md --- .../synapse-link/connect-synapse-link-sql-database.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/articles/synapse-analytics/synapse-link/connect-synapse-link-sql-database.md b/articles/synapse-analytics/synapse-link/connect-synapse-link-sql-database.md index ed9fe6e255271..c4efa0a0e2f3d 100644 --- a/articles/synapse-analytics/synapse-link/connect-synapse-link-sql-database.md +++ b/articles/synapse-analytics/synapse-link/connect-synapse-link-sql-database.md @@ -23,7 +23,7 @@ This article is a step-by-step guide for getting started with Azure Synapse Link * To get Azure Synapse Link for SQL, see [Create a new Azure Synapse workspace](https://portal.azure.com/#create/Microsoft.Synapse). The current tutorial is to create Azure Synapse Link for SQL in a public network. This article assumes that you selected **Disable Managed virtual network** and **Allow connections from all IP address** when you created an Azure Synapse workspace. If you want to configure Azure Synapse Link for Azure SQL Database with network security, also see [Configure Azure Synapse Link for Azure SQL Database with network security](connect-synapse-link-sql-database-vnet.md). -* For database transaction unit (DTU)-based provisioning, make sure that your Azure SQL Database service is at least Standard tier with a minimum of 100 DTUs. Free, Basic, or Standard tiers with fewer than 100 DTUs provisioned are not supported. +* For database transaction unit (DTU)-based provisioning, make sure that your Azure SQL Database service is at least Standard tier with a minimum of 100 DTUs. Free, Basic, or Standard tiers with fewer than 100 DTUs provisioned aren't supported. ## Configure your source Azure SQL database @@ -37,9 +37,9 @@ This article is a step-by-step guide for getting started with Azure Synapse Link :::image type="content" source="../media/connect-synapse-link-sql-database/configure-network-firewall-sql-database.png" alt-text="Screenshot that shows how to configure firewalls for your SQL database by using the Azure portal."::: -1. Using Microsoft SQL Server Management Studio (SSMS) or Azure Data Studio, connect to the logical server. If you want to have your Azure Synapse workspace connect to your Azure SQL database by using a managed identity, set the Azure Active Directory admin permissions on the logical server, To have the privileges in step 6, use the same admin name to connect to the logical server with administrative privileges. +1. Using Microsoft SQL Server Management Studio (SSMS) or Azure Data Studio, connect to the logical server. If you want to have your Azure Synapse workspace connect to your Azure SQL database by using a managed identity, set the Azure Active Directory admin permissions on the logical server. To apply the privileges in step 6, use the same admin name to connect to the logical server with administrative privileges. -1. Expand **Databases**, right-click the database you've just created, and then select **New Query**. +1. Expand **Databases**, right-click the database you've created, and then select **New Query**. :::image type="content" source="../media/connect-synapse-link-sql-database/ssms-new-query.png" alt-text="Screenshot that shows how to select your database and create a new query."::: From efcd1c0a6b15351ee2831b4fa8f249b1e8188ea9 Mon Sep 17 00:00:00 2001 From: Shawn Jackson Date: Tue, 25 Oct 2022 10:45:36 -0500 Subject: [PATCH 8/9] Update connect-synapse-link-sql-server-2022.md --- .../synapse-link/connect-synapse-link-sql-server-2022.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/articles/synapse-analytics/synapse-link/connect-synapse-link-sql-server-2022.md b/articles/synapse-analytics/synapse-link/connect-synapse-link-sql-server-2022.md index e79366b2b1bd8..22abdc61de7eb 100644 --- a/articles/synapse-analytics/synapse-link/connect-synapse-link-sql-server-2022.md +++ b/articles/synapse-analytics/synapse-link/connect-synapse-link-sql-server-2022.md @@ -196,10 +196,10 @@ This article is a step-by-step guide for getting started with Azure Synapse Link ## Start the Azure Synapse Link connection -1. Select **Start**, and then wait a few minutes for the data to be replicated. +Select **Start**, and then wait a few minutes for the data to be replicated. - > [!NOTE] - > A link connection will start from a full initial load from your source database, followed by incremental change feeds via the change feed feature in SQL Server 2022. For more information, see [Azure Synapse Link for SQL change feed](/sql/sql-server/synapse-link/synapse-link-sql-server-change-feed). +> [!NOTE] +> A link connection will start from a full initial load from your source database, followed by incremental change feeds via the change feed feature in SQL Server 2022. For more information, see [Azure Synapse Link for SQL change feed](/sql/sql-server/synapse-link/synapse-link-sql-server-change-feed). ## Monitor Azure Synapse Link for SQL Server 2022 From beb7dbb5f669557e949793bfec194347497ef976 Mon Sep 17 00:00:00 2001 From: Shawn Jackson Date: Tue, 25 Oct 2022 10:48:43 -0500 Subject: [PATCH 9/9] Update connect-synapse-link-sql-server-2022-vnet.md --- .../synapse-link/connect-synapse-link-sql-server-2022-vnet.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/articles/synapse-analytics/synapse-link/connect-synapse-link-sql-server-2022-vnet.md b/articles/synapse-analytics/synapse-link/connect-synapse-link-sql-server-2022-vnet.md index 8751830a7f3e1..f699b69671b4a 100644 --- a/articles/synapse-analytics/synapse-link/connect-synapse-link-sql-server-2022-vnet.md +++ b/articles/synapse-analytics/synapse-link/connect-synapse-link-sql-server-2022-vnet.md @@ -97,7 +97,7 @@ In this section, you create an Azure Synapse workspace with managed virtual netw :::image type="content" source="../media/connect-synapse-link-sql-database/create-link-sql-server.png" alt-text="Screenshot that shows how to create a link from the SQL Server 2022 instance."::: -1. Start your link connection +1. Start your link connection. :::image type="content" source="../media/connect-synapse-link-sql-database/start-link.png" alt-text="Screenshot that shows how to start the link connection.":::