Skip to content

Commit 714e54b

Browse files
authored
Merge pull request #300552 from Clare-Zheng82/0529-Add_BYOD_doc
[Doc update] Add BYOD doc
2 parents a6184a2 + a4ea011 commit 714e54b

File tree

3 files changed

+103
-1
lines changed

3 files changed

+103
-1
lines changed

articles/data-factory/TOC.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -376,7 +376,9 @@ items:
376376
- name: Connector release stages and timelines
377377
href: connector-release-stages-and-timelines.md
378378
- name: Connector upgrade FAQ
379-
href: connector-deprecation-frequently-asked-questions.md
379+
href: connector-deprecation-frequently-asked-questions.md
380+
- name: Guidance for Bring Your Own Driver (BYOD)
381+
href: guidance-for-byod-approach.md
380382
- name: Amazon Marketplace Web Service (Deprecated)
381383
href: connector-amazon-marketplace-web-service.md
382384
- name: Amazon RDS for Oracle
Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
---
2+
title: Guidance on using the Bring Your Own Driver (BYOD) approach
3+
description: This article provides step-by-step guidance for Bring Your Own Driver (BYOD) approach.
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: 05/29/2025
11+
---
12+
13+
# Guidance on using the Bring Your Own Driver (BYOD) approach
14+
15+
[!INCLUDE[appliesto-adf-asa-md](includes/appliesto-adf-asa-md.md)]
16+
17+
This article provides step-by-step guidance for using connectors with Bring Your Own Driver (BYOD) approach and upgrading from outdated V1 connectors to the latest V2 connectors in scenarios where the BYOD approach is required.
18+
19+
## Guidance on using connectors with BYOD approach
20+
21+
### Steps
22+
23+
1. **Review Connector Requirements**
24+
Visit the Data Factory documentation for the specific connector. Under the **Pre-requisites** section, verify:
25+
26+
- The supported version of the **client driver**.
27+
- The minimum required **SHIR version** for compatibility.
28+
29+
1. **Install and Configure Self-Hosted Integration Runtime (SHIR)**
30+
31+
- Set up SHIR on a physical machine or virtual machine within your network.
32+
- Follow the official [Microsoft SHIR installation guide](create-self-hosted-integration-runtime.md) to complete setup.
33+
34+
1. **Download the Required Driver Package**
35+
36+
Navigate to the connector's documentation or driver source to download the appropriate version of the client driver supported for the connector.
37+
38+
1. **Install the Driver**
39+
40+
Install the downloaded driver package on the machine where SHIR is running.
41+
42+
### Related connectors
43+
44+
- [Informix](connector-informix.md)
45+
- [Microsoft Access](connector-microsoft-access.md)
46+
- [SAP Business Warehouse](connector-sap-business-warehouse.md)
47+
- [SAP HANA](connector-sap-hana.md)
48+
- [SAP Table](connector-sap-table.md)
49+
50+
## Guidance on upgrading connectors with BYOD approach required
51+
52+
### Steps
53+
54+
1. **Review Connector Requirements**
55+
Visit the Data Factory documentation for the specific V2 connector. Under the **Pre-requisites** section, verify:
56+
57+
- The supported version of the **client driver**.
58+
- The minimum required **SHIR version** for compatibility.
59+
60+
1. **Install and Configure Self-Hosted Integration Runtime (SHIR)**
61+
62+
- Set up SHIR on a physical machine or virtual machine within your network.
63+
- Follow the official [Microsoft SHIR installation guide](create-self-hosted-integration-runtime.md) to complete setup.
64+
65+
1. **Download the Required Driver Package**
66+
67+
Navigate to the connector's documentation or driver source to download the appropriate version of the client driver supported for V2 connector.
68+
69+
1. **Install the Driver**
70+
71+
Install the downloaded driver package on the machine where SHIR is running.
72+
73+
1. **Update Linked Services in Data Factory**
74+
75+
- Identify existing linked services that currently use the V1 connector (typically via Azure IR or SHIR).
76+
- Modify them to:
77+
- Use the new SHIR instance.
78+
- Set the connector version to **2.0** from 1.0.
79+
80+
:::image type="content" source="media/connector-lifecycle/select-version.png" alt-text="Screenshot of the linked services page." lightbox="media/connector-lifecycle/select-version.png":::
81+
82+
1. **Test the Connection**
83+
84+
Validate connectivity to the data source using the updated linked service with version 2.0 connector.
85+
86+
1. **Validate Pipeline Functionality**
87+
88+
Run test executions of your pipelines to confirm they function correctly with the new V2 connector and SHIR setup.
89+
90+
### Related connectors
91+
92+
- [Vertica (version 2.0)](connector-vertica.md)
93+
94+
## Related content
95+
96+
- [Connector lifecycle overview](connector-lifecycle-overview.md)
97+
- [Connector upgrade guidance](connector-upgrade-guidance.md)
98+
- [Connector upgrade advisor](connector-upgrade-advisor.md)
99+
- [Connector release stages and timelines](connector-release-stages-and-timelines.md)
100+
- [Connector upgrade FAQ](connector-deprecation-frequently-asked-questions.md)
4.27 KB
Loading

0 commit comments

Comments
 (0)