Skip to content

Commit 0eef031

Browse files
Merge pull request #211147 from jess-hu-340/0914-add-SAMI
[Doc update] Add SAMI to REST doc
2 parents 21b888d + e9d60bb commit 0eef031

File tree

1 file changed

+32
-2
lines changed

1 file changed

+32
-2
lines changed

articles/data-factory/connector-rest.md

Lines changed: 32 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ ms.service: data-factory
77
ms.subservice: data-movement
88
ms.custom: synapse
99
ms.topic: conceptual
10-
ms.date: 08/30/2022
10+
ms.date: 09/14/2022
1111
ms.author: makromer
1212
---
1313

@@ -38,7 +38,7 @@ For a list of data stores that are supported as sources/sinks, see [Supported da
3838
Specifically, this generic REST connector supports:
3939

4040
- 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**, **Service Principal**, and **user-assigned managed identity**.
41+
- Copying data by using one of the following authentications: **Anonymous**, **Basic**, **Service Principal**, **OAuth2 Client Credential**, **System Assigned Managed Identity** and **User Assigned Managed Identity**.
4242
- **[Pagination](#pagination-support)** in the REST APIs.
4343
- 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.
4444

@@ -96,6 +96,7 @@ For different authentication types, see the corresponding sections for details.
9696
- [Basic authentication](#use-basic-authentication)
9797
- [Service Principal authentication](#use-service-principal-authentication)
9898
- [OAuth2 Client Credential authentication](#use-oauth2-client-credential-authentication)
99+
- [System-assigned managed identity authentication](#managed-identity)
99100
- [User-assigned managed identity authentication](#use-user-assigned-managed-identity-authentication)
100101
- [Anonymous authentication](#using-authentication-headers)
101102

@@ -132,6 +133,7 @@ Set the **authenticationType** property to **Basic**. In addition to the generic
132133
}
133134
```
134135

136+
135137
### Use Service Principal authentication
136138

137139
Set the **authenticationType** property to **AadServicePrincipal**. In addition to the generic properties that are described in the preceding section, specify the following properties:
@@ -205,6 +207,34 @@ Set the **authenticationType** property to **OAuth2ClientCredential**. In additi
205207
}
206208
```
207209

210+
### <a name="managed-identity"></a> Use system-assigned managed identity authentication
211+
212+
Set the **authenticationType** property to **ManagedServiceIdentity**. In addition to the generic properties that are described in the preceding section, specify the following properties:
213+
214+
| Property | Description | Required |
215+
|:--- |:--- |:--- |
216+
| aadResourceId | Specify the AAD resource you are requesting for authorization, for example, `https://management.core.windows.net`.| Yes |
217+
218+
**Example**
219+
220+
```json
221+
{
222+
"name": "RESTLinkedService",
223+
"properties": {
224+
"type": "RestService",
225+
"typeProperties": {
226+
"url": "<REST endpoint e.g. https://www.example.com/>",
227+
"authenticationType": "ManagedServiceIdentity",
228+
"aadResourceId": "<AAD resource URL e.g. https://management.core.windows.net>"
229+
},
230+
"connectVia": {
231+
"referenceName": "<name of Integration Runtime>",
232+
"type": "IntegrationRuntimeReference"
233+
}
234+
}
235+
}
236+
```
237+
208238
### Use user-assigned managed identity authentication
209239
Set the **authenticationType** property to **ManagedServiceIdentity**. In addition to the generic properties that are described in the preceding section, specify the following properties:
210240

0 commit comments

Comments
 (0)