You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/data-factory/connector-office-365.md
+36-36Lines changed: 36 additions & 36 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,55 +1,55 @@
1
1
---
2
-
title: Copy data from Office 365
2
+
title: Copy data from Microsoft 365 (Office 365)
3
3
titleSuffix: Azure Data Factory & Azure Synapse
4
-
description: Learn how to copy data from Office 365 to supported sink data stores by using copy activity in an Azure Data Factory or Synapse Analytics pipeline.
4
+
description: Learn how to copy data from Microsoft 365 (Office 365) to supported sink data stores by using copy activity in an Azure Data Factory or Synapse Analytics pipeline.
5
5
author: jianleishen
6
6
ms.service: data-factory
7
7
ms.subservice: data-movement
8
8
ms.custom: synapse
9
9
ms.topic: conceptual
10
-
ms.date: 03/04/2022
10
+
ms.date: 08/04/2022
11
11
ms.author: jianleishen
12
12
---
13
-
# Copy data from Office 365 into Azure using Azure Data Factory or Synapse Analytics
13
+
# Copy data from Microsoft 365 (Office 365) into Azure using Azure Data Factory or Synapse Analytics
Azure Data Factory and Synapse Analytics pipelines integrate with [Microsoft Graph data connect](/graph/data-connect-concept-overview), allowing you to bring the rich organizational data in your Office 365 tenant into Azure in a scalable way and build analytics applications and extract insights based on these valuable data assets. Integration with Privileged Access Management provides secured access control for the valuable curated data in Office 365. Please refer to [this link](/graph/data-connect-concept-overview) for an overview on Microsoft Graph data connect and refer to [this link](/graph/data-connect-policies#licensing) for licensing information.
16
+
Azure Data Factory and Synapse Analytics pipelines integrate with [Microsoft Graph data connect](/graph/data-connect-concept-overview), allowing you to bring the rich organizational data in your Microsoft 365 (Office 365) tenant into Azure in a scalable way and build analytics applications and extract insights based on these valuable data assets. Integration with Privileged Access Management provides secured access control for the valuable curated data in Microsoft 365 (Office 365). Please refer to [this link](/graph/data-connect-concept-overview) for an overview on Microsoft Graph data connect and refer to [this link](/graph/data-connect-policies#licensing) for licensing information.
17
17
18
-
This article outlines how to use the Copy Activity to copy data from Office 365. It builds on the [copy activity overview](copy-activity-overview.md) article that presents a general overview of copy activity.
18
+
This article outlines how to use the Copy Activity to copy data from Microsoft 365 (Office 365). It builds on the [copy activity overview](copy-activity-overview.md) article that presents a general overview of copy activity.
19
19
20
20
## Supported capabilities
21
21
22
-
This Office 365 connector is supported for the following capabilities:
22
+
This Microsoft 365 (Office 365) connector is supported for the following capabilities:
ADF Office 365 connector and Microsoft Graph data connect enables at scale ingestion of different types of datasets from Exchange Email enabled mailboxes, including address book contacts, calendar events, email messages, user information, mailbox settings, and so on. Refer [here](/graph/data-connect-datasets) to see the complete list of datasets available.
30
+
ADF Microsoft 365 (Office 365) connector and Microsoft Graph data connect enables at scale ingestion of different types of datasets from Exchange Email enabled mailboxes, including address book contacts, calendar events, email messages, user information, mailbox settings, and so on. Refer [here](/graph/data-connect-datasets) to see the complete list of datasets available.
31
31
32
-
For now, within a single copy activity you can only **copy data from Office 365 into [Azure Blob Storage](connector-azure-blob-storage.md), [Azure Data Lake Storage Gen1](connector-azure-data-lake-store.md), and [Azure Data Lake Storage Gen2](connector-azure-data-lake-storage.md) in JSON format** (type setOfObjects). If you want to load Office 365 into other types of data stores or in other formats, you can chain the first copy activity with a subsequent copy activity to further load data into any of the [supported ADF destination stores](copy-activity-overview.md#supported-data-stores-and-formats) (refer to "supported as a sink" column in the "Supported data stores and formats" table).
32
+
For now, within a single copy activity you can only **copy data from Microsoft 365 (Office 365) into [Azure Blob Storage](connector-azure-blob-storage.md), [Azure Data Lake Storage Gen1](connector-azure-data-lake-store.md), and [Azure Data Lake Storage Gen2](connector-azure-data-lake-storage.md) in JSON format** (type setOfObjects). If you want to load Microsoft 365 (Office 365) into other types of data stores or in other formats, you can chain the first copy activity with a subsequent copy activity to further load data into any of the [supported ADF destination stores](copy-activity-overview.md#supported-data-stores-and-formats) (refer to "supported as a sink" column in the "Supported data stores and formats" table).
33
33
34
34
>[!IMPORTANT]
35
-
>- The Azure subscription containing the data factory or Synapse workspace and the sink data store must be under the same Azure Active Directory (Azure AD) tenant as Office 365 tenant.
36
-
>- Ensure the Azure Integration Runtime region used for copy activity as well as the destination is in the same region where the Office 365 tenant users' mailbox is located. Refer [here](concepts-integration-runtime.md#integration-runtime-location) to understand how the Azure IR location is determined. Refer to [table here](/graph/data-connect-datasets#regions) for the list of supported Office regions and corresponding Azure regions.
35
+
>- The Azure subscription containing the data factory or Synapse workspace and the sink data store must be under the same Azure Active Directory (Azure AD) tenant as Microsoft 365 (Office 365) tenant.
36
+
>- Ensure the Azure Integration Runtime region used for copy activity as well as the destination is in the same region where the Microsoft 365 (Office 365) tenant users' mailbox is located. Refer [here](concepts-integration-runtime.md#integration-runtime-location) to understand how the Azure IR location is determined. Refer to [table here](/graph/data-connect-datasets#regions) for the list of supported Office regions and corresponding Azure regions.
37
37
>- Service Principal authentication is the only authentication mechanism supported for Azure Blob Storage, Azure Data Lake Storage Gen1, and Azure Data Lake Storage Gen2 as destination stores.
38
38
39
39
> [!Note]
40
40
> Please use Azure integration runtime in both source and sink linked services. The self-hosted integration runtime and the managed virtual network integration runtime are not supported.
41
41
42
42
## Prerequisites
43
43
44
-
To copy data from Office 365 into Azure, you need to complete the following prerequisite steps:
44
+
To copy data from Microsoft 365 (Office 365) into Azure, you need to complete the following prerequisite steps:
45
45
46
-
- Your Office 365 tenant admin must complete on-boarding actions as described [here](/events/build-may-2021/microsoft-365-teams/breakouts/od483/).
46
+
- Your Microsoft 365 (Office 365) tenant admin must complete on-boarding actions as described [here](/events/build-may-2021/microsoft-365-teams/breakouts/od483/).
47
47
- Create and configure an Azure AD web application in Azure Active Directory. For instructions, see [Create an Azure AD application](../active-directory/develop/howto-create-service-principal-portal.md#register-an-application-with-azure-ad-and-create-a-service-principal).
48
-
- Make note of the following values, which you will use to define the linked service for Office 365:
48
+
- Make note of the following values, which you will use to define the linked service for Microsoft 365 (Office 365):
49
49
- Tenant ID. For instructions, see [Get tenant ID](../active-directory/develop/howto-create-service-principal-portal.md#get-tenant-and-app-id-values-for-signing-in).
50
50
- Application ID and Application key. For instructions, see [Get application ID and authentication key](../active-directory/develop/howto-create-service-principal-portal.md#get-tenant-and-app-id-values-for-signing-in).
51
51
- Add the user identity who will be making the data access request as the owner of the Azure AD web application (from the Azure AD web application > Settings > Owners > Add owner).
52
-
- The user identity must be in the Office 365 organization you are getting data from and must not be a Guest user.
52
+
- The user identity must be in the Microsoft 365 (Office 365) organization you are getting data from and must not be a Guest user.
>For a walkthrough of using Office 365 connector, see [Load data from Office 365](load-office-365-data.md) article.
64
+
>For a walkthrough of using Microsoft 365 (Office 365) connector, see [Load data from Microsoft 365 (Office 365)](load-office-365-data.md) article.
65
65
66
66
You can create a pipeline with the copy activity by using one of the following tools or SDKs. Select a link to go to a tutorial with step-by-step instructions to create a pipeline with a copy activity.
67
67
@@ -72,9 +72,9 @@ You can create a pipeline with the copy activity by using one of the following t
## Create a linked service to Microsoft 365 (Office 365) using UI
76
76
77
-
Use the following steps to create a linked service to Office 365 in the Azure portal UI.
77
+
Use the following steps to create a linked service to Microsoft 365 (Office 365) in the Azure portal UI.
78
78
79
79
1. Browse to the Manage tab in your Azure Data Factory or Synapse workspace and select Linked Services, then click New:
80
80
@@ -86,34 +86,34 @@ Use the following steps to create a linked service to Office 365 in the Azure po
86
86
87
87
:::image type="content" source="media/doc-common-process/new-linked-service-synapse.png" alt-text="Screenshot of creating a new linked service with Azure Synapse UI.":::
88
88
89
-
2. Search for Office and select the Office 365 connector.
89
+
2. Search for Microsoft 365 (Office 365) and select the Microsoft 365 (Office 365) connector.
90
90
91
-
:::image type="content" source="media/connector-office-365/office-365-connector.png" alt-text="Screenshot of the Office 365 connector.":::
91
+
:::image type="content" source="media/connector-office-365/office-365-connector.png" alt-text="Screenshot of the Microsoft 365 (Office 365) connector.":::
92
92
93
93
1. Configure the service details, test the connection, and create the new linked service.
94
94
95
-
:::image type="content" source="media/connector-office-365/configure-office-365-linked-service.png" alt-text="Screenshot of linked service configuration for Office 365.":::
95
+
:::image type="content" source="media/connector-office-365/configure-office-365-linked-service.png" alt-text="Screenshot of linked service configuration for Microsoft 365 (Office 365).":::
96
96
97
97
## Connector configuration details
98
98
99
-
The following sections provide details about properties that are used to define Data Factory entities specific to Office 365 connector.
99
+
The following sections provide details about properties that are used to define Data Factory entities specific to Microsoft 365 (Office 365) connector.
100
100
101
101
## Linked service properties
102
102
103
-
The following properties are supported for Office 365 linked service:
103
+
The following properties are supported for Microsoft 365 (Office 365) linked service:
104
104
105
105
| Property | Description | Required |
106
106
|:--- |:--- |:--- |
107
107
| type | The type property must be set to: **Office365**| Yes |
108
-
| office365TenantId | Azure tenant ID to which the Office 365 account belongs. | Yes |
108
+
| office365TenantId | Azure tenant ID to which the Microsoft 365 (Office 365) account belongs. | Yes |
109
109
| servicePrincipalTenantId | Specify the tenant information under which your Azure AD web application resides. | Yes |
| servicePrincipalKey | Specify the application's key. Mark this field as a SecureString to store it securely. | Yes |
112
112
| connectVia | The Integration Runtime to be used to connect to the data store. If not specified, it uses the default Azure Integration Runtime. | No |
113
113
114
114
>[!NOTE]
115
115
> The difference between **office365TenantId** and **servicePrincipalTenantId** and the corresponding value to provide:
116
-
>- If you are an enterprise developer developing an application against Office 365 data for your own organization's usage, then you should supply the same tenant ID for both properties, which is your organization's AAD tenant ID.
116
+
>- If you are an enterprise developer developing an application against Microsoft 365 (Office 365) data for your own organization's usage, then you should supply the same tenant ID for both properties, which is your organization's AAD tenant ID.
117
117
>- If you are an ISV developer developing an application for your customers, then office365TenantId will be your customer's (application installer) AAD tenant ID and servicePrincipalTenantId will be your company's AAD tenant ID.
118
118
119
119
**Example:**
@@ -124,7 +124,7 @@ The following properties are supported for Office 365 linked service:
"servicePrincipalTenantId": "<AAD app service principal tenant id>",
129
129
"servicePrincipalId": "<AAD app service principal id>",
130
130
"servicePrincipalKey": {
@@ -138,14 +138,14 @@ The following properties are supported for Office 365 linked service:
138
138
139
139
## Dataset properties
140
140
141
-
For a full list of sections and properties available for defining datasets, see the [datasets](concepts-datasets-linked-services.md) article. This section provides a list of properties supported by Office 365 dataset.
141
+
For a full list of sections and properties available for defining datasets, see the [datasets](concepts-datasets-linked-services.md) article. This section provides a list of properties supported by Microsoft 365 (Office 365) dataset.
142
142
143
-
To copy data from Office 365, the following properties are supported:
143
+
To copy data from Microsoft 365 (Office 365), the following properties are supported:
144
144
145
145
| Property | Description | Required |
146
146
|:--- |:--- |:--- |
147
147
| type | The type property of the dataset must be set to: **Office365Table**| Yes |
148
-
| tableName | Name of the dataset to extract from Office 365. Refer [here](/graph/data-connect-datasets#datasets) for the list of Office 365 datasets available for extraction. | Yes |
148
+
| tableName | Name of the dataset to extract from Microsoft 365 (Office 365). Refer [here](/graph/data-connect-datasets#datasets) for the list of Microsoft 365 (Office 365) datasets available for extraction. | Yes |
149
149
150
150
If you were setting `dateFilterColumn`, `startTime`, `endTime`, and `userScopeFilterUri` in dataset, it is still supported as-is, while you are suggested to use the new model in activity source going forward.
151
151
@@ -157,7 +157,7 @@ If you were setting `dateFilterColumn`, `startTime`, `endTime`, and `userScopeFi
157
157
"properties": {
158
158
"type": "Office365Table",
159
159
"linkedServiceName": {
160
-
"referenceName": "<Office 365 linked service name>",
160
+
"referenceName": "<Microsoft 365 (Office 365) linked service name>",
161
161
"type": "LinkedServiceReference"
162
162
},
163
163
"schema": [],
@@ -170,18 +170,18 @@ If you were setting `dateFilterColumn`, `startTime`, `endTime`, and `userScopeFi
170
170
171
171
## Copy activity properties
172
172
173
-
For a full list of sections and properties available for defining activities, see the [Pipelines](concepts-pipelines-activities.md) article. This section provides a list of properties supported by Office 365 source.
173
+
For a full list of sections and properties available for defining activities, see the [Pipelines](concepts-pipelines-activities.md) article. This section provides a list of properties supported by Microsoft 365 (Office 365) source.
174
174
175
-
### Office 365 as source
175
+
### Microsoft 365 (Office 365) as source
176
176
177
-
To copy data from Office 365, the following properties are supported in the copy activity **source** section:
177
+
To copy data from Microsoft 365 (Office 365), the following properties are supported in the copy activity **source** section:
178
178
179
179
| Property | Description | Required |
180
180
|:--- |:--- |:--- |
181
181
| type | The type property of the copy activity source must be set to: **Office365Source**| Yes |
182
182
| allowedGroups | Group selection predicate. Use this property to select up to 10 user groups for whom the data will be retrieved. If no groups are specified, then data will be returned for the entire organization. | No |
183
-
| userScopeFilterUri | When `allowedGroups` property is not specified, you can use a predicate expression that is applied on the entire tenant to filter the specific rows to extract from Office 365. The predicate format should match the query format of Microsoft Graph APIs, e.g. `https://graph.microsoft.com/v1.0/users?$filter=Department eq 'Finance'`. | No |
184
-
| dateFilterColumn | Name of the DateTime filter column. Use this property to limit the time range for which Office 365 data is extracted. | Yes if dataset has one or more DateTime columns. Refer [here](/graph/data-connect-filtering#filtering) for list of datasets that require this DateTime filter. |
183
+
| userScopeFilterUri | When `allowedGroups` property is not specified, you can use a predicate expression that is applied on the entire tenant to filter the specific rows to extract from Microsoft 365 (Office 365). The predicate format should match the query format of Microsoft Graph APIs, e.g. `https://graph.microsoft.com/v1.0/users?$filter=Department eq 'Finance'`. | No |
184
+
| dateFilterColumn | Name of the DateTime filter column. Use this property to limit the time range for which Microsoft 365 (Office 365) data is extracted. | Yes if dataset has one or more DateTime columns. Refer [here](/graph/data-connect-filtering#filtering) for list of datasets that require this DateTime filter. |
185
185
| startTime | Start DateTime value to filter on. | Yes if `dateFilterColumn` is specified |
186
186
| endTime | End DateTime value to filter on. | Yes if `dateFilterColumn` is specified |
187
187
| outputColumns | Array of the columns to copy to sink. | No |
@@ -195,7 +195,7 @@ To copy data from Office 365, the following properties are supported in the copy
0 commit comments