Share via


RestSource Class

Definition

A copy activity Rest service source.

[System.Text.Json.Serialization.JsonConverter(typeof(Azure.Analytics.Synapse.Artifacts.Models.RestSource+RestSourceConverter))]
public class RestSource : Azure.Analytics.Synapse.Artifacts.Models.CopySource
[<System.Text.Json.Serialization.JsonConverter(typeof(Azure.Analytics.Synapse.Artifacts.Models.RestSource+RestSourceConverter))>]
type RestSource = class
    inherit CopySource
Public Class RestSource
Inherits CopySource
Inheritance
RestSource
Attributes

Constructors

RestSource()

Initializes a new instance of RestSource.

Properties

AdditionalColumns

Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

AdditionalHeaders

The additional HTTP headers in the request to the RESTful API. Type: string (or Expression with resultType string).

AdditionalProperties

Additional Properties.

(Inherited from CopySource)
HttpRequestTimeout

The timeout (TimeSpan) to get an HTTP response. It is the timeout to get a response, not the timeout to read response data. Default value: 00:01:40. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

MaxConcurrentConnections

The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

(Inherited from CopySource)
PaginationRules

The pagination rules to compose next page requests. Type: string (or Expression with resultType string).

RequestBody

The HTTP request body to the RESTful API if requestMethod is POST. Type: string (or Expression with resultType string).

RequestInterval

The time to await before sending next page request.

RequestMethod

The HTTP method used to call the RESTful API. The default is GET. Type: string (or Expression with resultType string).

SourceRetryCount

Source retry count. Type: integer (or Expression with resultType integer).

(Inherited from CopySource)
SourceRetryWait

Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

(Inherited from CopySource)

Applies to