Configuring an ADF Linked Service Connection for SharePoint Online List
For information on how to enable a connection for use with linked services, see Configuring a Linked Service Connection.
Field labels in this walkthrough follow the underlying Azure Data Factory property names, with the connection column that carries each value named alongside. The exact labels shown in the BimlFlex Connection Editor may differ.
After selecting SharePoint Online List from the Linked Service Type dropdown, the form required for creating a SharePoint Online List Linked Service will appear.
Source Only Connector
A SharePoint Online List connection is used as a source. It is not available as a target.
Each SharePoint Online List object is read from the list that the dataset names through the TargetObjectName parameter, and the copy source passes the TargetSchemaName and TargetObjectName parameters. BimlFlex composes no query of its own for the object.
An OData query for the list (for example, $top=10&$select=Title,Number) is the object's Override SQL, or the text of the object's Override SQL extension point when the Override SQL is empty. The query is written to the ADF query property of the copy source, and BimlFlex appends nothing to the query it is given. An object with no query builds a copy source without one, so the whole list is copied, and the build reports no warning for it.
The copy source sets the ADF httpRequestTimeout property to five minutes, the Azure Data Factory default, on every build. BimlFlex has no setting that changes it.
The SharePoint Online List copy source carries no additional columns. When the object has additional columns, they are not written to the copy source, and the build reports a warning that names the object.
Choosing an Authentication Method
| Method | Credentials | Additional Settings |
|---|---|---|
| Service principal key | Tenant Id, Service Principal Id and Service Principal Key | None |
Recommendation: Store the Service Principal Key in Azure Key Vault rather than entering it as plaintext.
Complete Example: Service Principal Key with Azure Key Vault
| Field | Example Value |
|---|---|
| Connect via Integration Runtime | AutoResolveIntegrationRuntime |
| Site URL | https://contoso.sharepoint.com/sites/siteName |
| Tenant Id | <tenant-id-of-app-registration> |
| Service Principal Id | <client-id-of-app-registration> |
| Azure Key Vault Linked Service | bfx-kv |
| Secret Name (for Service Principal Key) | BFX-SRC-SharePointClientSecret |
Required Fields
Common Required Fields
A SharePoint Online List Linked Service connection uses a single Authentication Type, so the same fields are required on every connection.
These common required fields are:
- Connect via Integration Runtime
- Site URL
- Tenant Id
- Service Principal Id
- Service Principal Key (or Azure Key Vault)
Connect via Integration Runtime
Connect via Integration Runtime names the integration runtime for a SharePoint Online List Linked Service connection.
The default value is AutoResolveIntegrationRuntime.
To use another runtime, select it from the dropdown or choose + New to add one.
When a custom value is saved in the linked service form, it will be added to the custom integration runtimes.
The custom values that appear in this dropdown can be maintained in Settings under Azure - AzureIntegrationRuntime.
The runtime is stored in the connection's LS_ConnectVia_IntegrationRuntime column. Any value other than AutoResolveIntegrationRuntime is written to the linked service as the runtime it connects through.
Azure Data Factory supports the Azure integration runtime and the self-hosted integration runtime for this connector.
Site URL
The Site URL identifies the SharePoint Online site that holds the lists (for example, https://contoso.sharepoint.com/sites/siteName).
It is stored in the connection's LS_Url column and maps to the ADF siteUrl property.
Tenant Id
The Tenant Id identifies the Microsoft Entra tenant under which the application registration resides.
It is stored in the connection's LS_Tenant column and maps to the ADF tenantId property.
Authentication Type
The SharePoint Online List Linked Service connection signs in with a service principal and its key. BimlFlex does not read the connection's Authentication Type column for this connector.
Azure Data Factory also accepts a service principal certificate for this connector. BimlFlex writes the key form, and no certificate credential is written to the linked service.
Service principal key
The Service Principal Id supplies the Application (client) ID of the application registered in Microsoft Entra ID and is stored in the connection's LS_ServicePrincipalId column. It maps to the ADF servicePrincipalId property.
The Service Principal Key supplies the application key as plaintext in the LS_ServicePrincipalKey column, or as an Azure Key Vault reference stored in the LS_ServicePrincipalKeyKVS_ fields that resolves to the key at runtime. It maps to the ADF servicePrincipalKey property.
When an Azure Key Vault reference is set, the plaintext key is not written to the linked service.
When the connection's LS_EncryptedCredential column holds an Encrypted Credential value, it is also written to the linked service.
It is suggested that Azure Key Vault be used in place of manually entering the Service Principal Key.
Azure Data Factory Linked Service Additional Information
For additional information on ADF SharePoint Online List Linked Service and its connection requirements see the Azure Data Factory SharePoint Online List Connector documentation.