Skip to content

Commit 4a0e028

Browse files
authored
Merge pull request #297295 from Lucky-Wang16/0331-Add_migration_advisor
Add connector upgrade advisor doc
2 parents 385966d + d94adc5 commit 4a0e028

11 files changed

+87
-0
lines changed

articles/data-factory/TOC.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1404,6 +1404,8 @@ items:
14041404
href: connector-deprecation-plan.md
14051405
- name: Connector upgrade FAQ
14061406
href: connector-deprecation-frequently-asked-questions.md
1407+
- name: Connector upgrade advisor
1408+
href: connector-upgrade-advisor.md
14071409
- name: Whitepapers
14081410
href: whitepapers.md
14091411
- name: FAQ
Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
---
2+
title: Connector upgrade advisor in Azure Data Factory and Azure Synapse Analytics
3+
description: This article describes Connector upgrade advisor in Azure Data Factory and Azure Synapse Analytics.
4+
author: KrishnakumarRukmangathan
5+
ms.author: krirukm
6+
ms.service: azure-data-factory
7+
ms.subservice: data-movement
8+
ms.topic: concept-article
9+
ms.custom: references_regions
10+
ms.date: 03/31/2025
11+
---
12+
13+
# Connector upgrade advisor in Azure Data Factory and Azure Synapse Analytics
14+
15+
This article describes Connector upgrade advisor in Azure Data Factory and Azure Synapse Analytics.
16+
17+
To learn more, see [Upgrade plan for Azure Data Factory connectors](connector-deprecation-plan.md).
18+
19+
## Overview
20+
21+
The Connector upgrade advisor is a comprehensive tool that helps upgrade pipelines that use outdated V1 linked services and datasets to their latest available versions. This advisor tool applies to V1 connectors with updated versions already available.
22+
23+
:::image type="content" source="media/connector-upgrade-advisor/connector-upgrade-advisor.png" alt-text="Screenshot of the connector upgrade advisor tool page." lightbox="media/connector-upgrade-advisor/connector-upgrade-advisor.png":::
24+
25+
## Supported data sources
26+
27+
- Salesforce
28+
- Salesforce Service Cloud
29+
- ServiceNow
30+
- PostgreSQL
31+
- Google BigQuery
32+
33+
## Known limitations
34+
35+
Currently, support for the Snowflake data source is unavailable.
36+
37+
## How to use
38+
39+
Before using the Connector upgrade advisor, it is recommended to **save** or **discard all** pending changes.
40+
41+
1. To access the **Connector upgrade advisor**, navigate to the **Manage** pane in your data factory. Under the **General** section, locate and select **Connector upgrade advisor**.
42+
43+
:::image type="content" source="media/connector-upgrade-advisor/connector-upgrade-advisor.png" alt-text="Screenshot of the connector upgrade advisor page." lightbox="media/connector-upgrade-advisor/connector-upgrade-advisor.png":::
44+
45+
2. Once you select the **Connector upgrade advisor**, it scans your data factory and identifies all existing pipelines using outdated connectors along with the number of dependencies on outdated versions.
46+
47+
:::image type="content" source="media/connector-upgrade-advisor/outdated-connectors.png" alt-text="Screenshot of the outdated-connectors page." lightbox="media/connector-upgrade-advisor/outdated-connectors.png":::
48+
49+
3. In the **Connector upgrade advisor** home page, choose the pipelines you want to upgrade and click **Upgrade**.
50+
51+
:::image type="content" source="media/connector-upgrade-advisor/upgrade.png" alt-text="Screenshot of upgrade." lightbox="media/connector-upgrade-advisor/upgrade.png":::
52+
53+
4. If a selected pipeline references an outdated dataset shared with other unselected pipelines, a **Select upgrade methods** dialog appears listing all the pipelines sharing datasets.
54+
55+
:::image type="content" source="media/connector-upgrade-advisor/select-upgrade-methods.png" alt-text="Screenshot of the select-upgrade-methods page." lightbox="media/connector-upgrade-advisor/select-upgrade-methods.png":::
56+
57+
If you want to upgrade all pipelines using the same dataset simultaneously, choose **Include listed pipelines to upgrade together**. Otherwise, if you just want to upgrade the selected pipeline separately, select **Create new datasets for selected pipelines**. Click **OK** to confirm your selection.
58+
59+
:::image type="content" source="media/connector-upgrade-advisor/enable-options.png" alt-text="Screenshot of two options." lightbox="media/connector-upgrade-advisor/enable-options.png":::
60+
61+
5. The next window **Map outdated linked services to new linked services** list all outdated linked services. Select an equivalent V2 linked service from the dropdown menu or create a new one that supports the V2 format by clicking **New**. Once configured, click **Next**.
62+
63+
:::image type="content" source="media/connector-upgrade-advisor/new-linked-services.png" alt-text="Screenshot of the linked services page." lightbox="media/connector-upgrade-advisor/new-linked-services.png":::
64+
65+
6. The **Update pipeline queries** page (if applicable) appears only if your selected pipelines use **Salesforce**, **Salesforce Service Cloud**, or **ServiceNow** connectors in the **Copy** activity with a query.
66+
67+
Due to query format differences between V1 and V2:
68+
69+
- Salesforce queries are pre-populated as V1 (SQL) and V2 (SOQL) share common syntax.
70+
71+
- ServiceNow queries require manual adjustments, as the structure has changed.
72+
73+
Once modifications are complete, click **Next**.
74+
75+
:::image type="content" source="media/connector-upgrade-advisor/update-pipeline-queries.png" alt-text="Screenshot of the update pipeline queries page." lightbox="media/connector-upgrade-advisor/update-pipeline-queries.png":::
76+
77+
7. Review and finalize changes using the **Review** page. It provides a summary of all modifications made by the advisor tool. Click **Open and review** to exit the wizard and navigate to the authoring page.
78+
79+
:::image type="content" source="media/connector-upgrade-advisor/review-page.png" alt-text="Screenshot of the review page." lightbox="media/connector-upgrade-advisor/review-page.png":::
80+
81+
Review all modified connectors, then **Save all** or **Publish all** the changes as needed.
82+
83+
:::image type="content" source="media/connector-upgrade-advisor/save-publish.png" alt-text="Screenshot of the save or publish page." lightbox="media/connector-upgrade-advisor/save-publish.png":::
84+
85+
This process ensures a smooth transition from outdated connectors to the latest supported versions.
167 KB
Loading
61 KB
Loading
51.3 KB
Loading
172 KB
Loading
67.1 KB
Loading
99.5 KB
Loading
63 KB
Loading
125 KB
Loading

0 commit comments

Comments
 (0)