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-rest.md
+11-11Lines changed: 11 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@ ms.service: data-factory
7
7
ms.subservice: data-movement
8
8
ms.custom: synapse
9
9
ms.topic: conceptual
10
-
ms.date: 06/13/2022
10
+
ms.date: 08/30/2022
11
11
ms.author: makromer
12
12
---
13
13
@@ -38,7 +38,7 @@ For a list of data stores that are supported as sources/sinks, see [Supported da
38
38
Specifically, this generic REST connector supports:
39
39
40
40
- Copying data from a REST endpoint by using the **GET** or **POST** methods and copying data to a REST endpoint by using the **POST**, **PUT** or **PATCH** methods.
41
-
- Copying data by using one of the following authentications: **Anonymous**, **Basic**, **AAD service principal**, and **user-assigned managed identity**.
41
+
- Copying data by using one of the following authentications: **Anonymous**, **Basic**, **Service Principal**, and **user-assigned managed identity**.
42
42
-**[Pagination](#pagination-support)** in the REST APIs.
43
43
- For REST as source, copying the REST JSON response [as-is](#export-json-response-as-is) or parse it by using [schema mapping](copy-activity-schema-and-type-mapping.md#schema-mapping). Only response payload in **JSON** is supported.
44
44
@@ -94,7 +94,7 @@ The following properties are supported for the REST linked service:
94
94
95
95
For different authentication types, see the corresponding sections for details.
@@ -132,7 +132,7 @@ Set the **authenticationType** property to **Basic**. In addition to the generic
132
132
}
133
133
```
134
134
135
-
### Use AAD service principal authentication
135
+
### Use Service Principal authentication
136
136
137
137
Set the **authenticationType** property to **AadServicePrincipal**. In addition to the generic properties that are described in the preceding section, specify the following properties:
138
138
@@ -141,8 +141,8 @@ Set the **authenticationType** property to **AadServicePrincipal**. In addition
141
141
| servicePrincipalId | Specify the Azure Active Directory application's client ID. | Yes |
142
142
| servicePrincipalKey | Specify the Azure Active Directory application's key. Mark this field as a **SecureString** to store it securely in Data Factory, or [reference a secret stored in Azure Key Vault](store-credentials-in-key-vault.md). | Yes |
143
143
| tenant | Specify the tenant information (domain name or tenant ID) under which your application resides. Retrieve it by hovering the mouse in the top-right corner of the Azure portal. | Yes |
144
-
| aadResourceId | Specify the AAD resource you are requesting for authorization, for example, `https://management.core.windows.net`.| Yes |
145
-
| azureCloudType | For service principal authentication, specify the type of Azure cloud environment to which your AAD application is registered. <br/> Allowed values are **AzurePublic**, **AzureChina**, **AzureUsGovernment**, and **AzureGermany**. By default, the data factory's cloud environment is used. | No |
144
+
| aadResourceId | Specify the Microsoft Azure Active Directory (Azure AD) resource you are requesting for authorization, for example, `https://management.core.windows.net`.| Yes |
145
+
| azureCloudType | For Service Principal authentication, specify the type of Azure cloud environment to which your Azure AD application is registered. <br/> Allowed values are **AzurePublic**, **AzureChina**, **AzureUsGovernment**, and **AzureGermany**. By default, the data factory's cloud environment is used. | No |
146
146
147
147
**Example**
148
148
@@ -160,7 +160,7 @@ Set the **authenticationType** property to **AadServicePrincipal**. In addition
160
160
"type": "SecureString"
161
161
},
162
162
"tenant": "<tenant info, e.g. microsoft.onmicrosoft.com>",
163
-
"aadResourceId": "<AAD resource URL e.g. https://management.core.windows.net>"
163
+
"aadResourceId": "<Azure AD resource URL e.g. https://management.core.windows.net>"
164
164
},
165
165
"connectVia": {
166
166
"referenceName": "<name of Integration Runtime>",
@@ -210,7 +210,7 @@ Set the **authenticationType** property to **ManagedServiceIdentity**. In additi
210
210
211
211
| Property | Description | Required |
212
212
|:--- |:--- |:--- |
213
-
| aadResourceId | Specify the AAD resource you are requesting for authorization, for example, `https://management.core.windows.net`.| Yes |
213
+
| aadResourceId | Specify the Azure AD resource you are requesting for authorization, for example, `https://management.core.windows.net`.| Yes |
214
214
| credentials | Specify the user-assigned managed identity as the credential object. | Yes |
215
215
216
216
@@ -224,7 +224,7 @@ Set the **authenticationType** property to **ManagedServiceIdentity**. In additi
224
224
"typeProperties": {
225
225
"url": "<REST endpoint e.g. https://www.example.com/>",
226
226
"authenticationType": "ManagedServiceIdentity",
227
-
"aadResourceId": "<AAD resource URL e.g. https://management.core.windows.net>",
227
+
"aadResourceId": "<Azure AD resource URL e.g. https://management.core.windows.net>",
228
228
"credential": {
229
229
"referenceName": "credential1",
230
230
"type": "CredentialReference"
@@ -680,14 +680,14 @@ Response 2:
680
680
681
681
:::image type="content" source="media/connector-rest/pagination-rule-example-4-1.png" alt-text="Screenshot showing the End Condition setting for Example 4.1.":::
682
682
683
-
- **Example 4.2: The pagination ends when the value of the specific node in response dose not exist**
683
+
- **Example 4.2: The pagination ends when the value of the specific node in response does not exist**
684
684
685
685
The REST API returns the last response in the following structure:
686
686
687
687
```json
688
688
{}
689
689
```
690
-
Set the end condition rule as **"EndCondition:$.data": "NonExist"** to end the pagination when the value of the specific node in response dose not exist.
690
+
Set the end condition rule as **"EndCondition:$.data": "NonExist"** to end the pagination when the value of the specific node in response does not exist.
691
691
692
692
:::image type="content" source="media/connector-rest/pagination-rule-example-4-2.png" alt-text="Screenshot showing the End Condition setting for Example 4.2.":::
0 commit comments