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
@@ -88,7 +88,7 @@ The following properties are supported for the REST linked service:
88
88
| url | The base URL of the REST service. | Yes |
89
89
| enableServerCertificateValidation | Whether to validate server-side TLS/SSL certificate when connecting to the endpoint. | No<br /> (the default is **true**) |
90
90
| authenticationType | Type of authentication used to connect to the REST service. Allowed values are **Anonymous**, **Basic**, **AadServicePrincipal**, **OAuth2ClientCredential**, and **ManagedServiceIdentity**. You can additionally configure authentication headers in `authHeaders` property. Refer to corresponding sections below on more properties and examples respectively.| Yes |
91
-
| authHeaders |Additional HTTP request headers for authentication.<br/> For example, to use API key authentication, you can select authentication type as “Anonymous” and specify API key in the header. | No |
91
+
| authHeaders |Other HTTP request headers for authentication.<br/> For example, to use API key authentication, you can select authentication type as "Anonymous" and specify API key in the header. | No |
92
92
| connectVia | The [Integration Runtime](concepts-integration-runtime.md) to use to connect to the data store. Learn more from [Prerequisites](#prerequisites) section. If not specified, this property uses the default Azure Integration Runtime. |No |
93
93
94
94
For different authentication types, see the corresponding sections for details.
@@ -369,7 +369,7 @@ To copy data from REST, the following properties are supported:
369
369
| type | The **type** property of the dataset must be set to **RestResource**. | Yes |
370
370
| relativeUrl | A relative URL to the resource that contains the data. When this property isn't specified, only the URL that's specified in the linked service definition is used. The HTTP connector copies data from the combined URL: `[URL specified in linked service]/[relative URL specified in dataset]`. | No |
371
371
372
-
If you were setting `requestMethod`, `additionalHeaders`, `requestBody` and `paginationRules` in dataset, it's still supported as-is, while you're suggested to use the new model in activity going forward.
372
+
If you were setting `requestMethod`, `additionalHeaders`, `requestBody`, and `paginationRules` in dataset, it's still supported as-is, while you're suggested to use the new model in activity going forward.
373
373
374
374
**Example:**
375
375
@@ -404,10 +404,10 @@ The following properties are supported in the copy activity **source** section:
404
404
|:--- |:--- |:--- |
405
405
| type | The **type** property of the copy activity source must be set to **RestSource**. | Yes |
406
406
| requestMethod | The HTTP method. Allowed values are **GET** (default) and **POST**. | No |
407
-
| additionalHeaders |Additional HTTP request headers. | No |
407
+
| additionalHeaders |Other HTTP request headers. | No |
408
408
| requestBody | The body for the HTTP request. | No |
409
409
| paginationRules | The pagination rules to compose next page requests. Refer to [pagination support](#pagination-support) section on details. | No |
410
-
| httpRequestTimeout | The timeout (the **TimeSpan** value) for the HTTP request to get a response. This value is the timeout to get a response, not the timeout to read response data. The default value is **00:01:40**. | No |
410
+
| httpRequestTimeout | The time-out (the **TimeSpan** value) for the HTTP request to get a response. This value is the time-out to get a response, not the time-out to read response data. The default value is **00:01:40**. | No |
411
411
| requestInterval | The time to wait before sending the request for next page. The default value is **00:00:01**| No |
412
412
413
413
>[!NOTE]
@@ -494,8 +494,8 @@ The following properties are supported in the copy activity **sink** section:
494
494
|:--- |:--- |:--- |
495
495
| type | The **type** property of the copy activity sink must be set to **RestSink**. | Yes |
496
496
| requestMethod | The HTTP method. Allowed values are **POST** (default), **PUT**, and **PATCH**. | No |
497
-
| additionalHeaders |Additional HTTP request headers. | No |
498
-
| httpRequestTimeout | The timeout (the **TimeSpan** value) for the HTTP request to get a response. This value is the timeout to get a response, not the timeout to write the data. The default value is **00:01:40**. | No |
497
+
| additionalHeaders |Other HTTP request headers. | No |
498
+
| httpRequestTimeout | The time-out (the **TimeSpan** value) for the HTTP request to get a response. This value is the time-out to get a response, not the time-out to write the data. The default value is **00:01:40**. | No |
499
499
| requestInterval | The interval time between different requests in millisecond. Request interval value should be a number between [10, 60000]. | No |
500
500
| httpCompressionType | HTTP compression type to use while sending data with Optimal Compression Level. Allowed values are **none** and **gzip**. | No |
501
501
| writeBatchSize | Number of records to write to the REST sink per batch. The default value is 10000. | No |
@@ -556,17 +556,17 @@ REST is supported in data flows for both integration datasets and inline dataset
556
556
|:--- |:--- |:--- |
557
557
| requestMethod | The HTTP method. Allowed values are **GET** and **POST**. | Yes |
558
558
| relativeUrl | A relative URL to the resource that contains the data. When this property isn't specified, only the URL that's specified in the linked service definition is used. The HTTP connector copies data from the combined URL: `[URL specified in linked service]/[relative URL specified in dataset]`. | No |
559
-
| additionalHeaders |Additional HTTP request headers. | No |
560
-
| httpRequestTimeout | The timeout (the **TimeSpan** value) for the HTTP request to get a response. This value is the timeout to get a response, not the timeout to write the data. The default value is **00:01:40**. | No |
559
+
| additionalHeaders |Other HTTP request headers. | No |
560
+
| httpRequestTimeout | The time-out (the **TimeSpan** value) for the HTTP request to get a response. This value is the time-out to get a response, not the time-out to write the data. The default value is **00:01:40**. | No |
561
561
| requestInterval | The interval time between different requests in millisecond. Request interval value should be a number between [10, 60000]. | No |
562
562
| QueryParameters.*request_query_parameter* OR QueryParameters['request_query_parameter']| "request_query_parameter" is user-defined, which references one query parameter name in the next HTTP request URL. | No |
563
563
564
564
### Sink transformation
565
565
566
566
| Property | Description | Required |
567
567
|:--- |:--- |:--- |
568
-
| additionalHeaders |Additional HTTP request headers. | No |
569
-
| httpRequestTimeout | The timeout (the **TimeSpan** value) for the HTTP request to get a response. This value is the timeout to get a response, not the timeout to write the data. The default value is **00:01:40**. | No |
568
+
| additionalHeaders |Other HTTP request headers. | No |
569
+
| httpRequestTimeout | The time-out (the **TimeSpan** value) for the HTTP request to get a response. This value is the time-out to get a response, not the time-out to write the data. The default value is **00:01:40**. | No |
570
570
| requestInterval | The interval time between different requests in millisecond. Request interval value should be a number between [10, 60000]. | No |
571
571
| httpCompressionType | HTTP compression type to use while sending data with Optimal Compression Level. Allowed values are **none** and **gzip**. | No |
572
572
| writeBatchSize | Number of records to write to the REST sink per batch. The default value is 10000. | No |
@@ -577,7 +577,7 @@ You can set the delete, insert, update, and upsert methods as well as the relati
577
577
578
578
## Sample data flow script
579
579
580
-
Notice the use of an alter row transformation prior to the sink to instruct ADF what type of action to take with your REST sink. That is, insert, update, upsert, delete.
580
+
Notice the use of an alter row transformation before the sink to instruct ADF what type of action to take with your REST sink. That is, insert, update, upsert, delete.
0 commit comments