Share via


RestSource Class

Definition

A copy activity Rest service source.

public class RestSource : Azure.ResourceManager.DataFactory.Models.CopyActivitySource, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.DataFactory.Models.RestSource>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.DataFactory.Models.RestSource>
public class RestSource : Azure.ResourceManager.DataFactory.Models.CopyActivitySource
type RestSource = class
    inherit CopyActivitySource
    interface IJsonModel<RestSource>
    interface IPersistableModel<RestSource>
type RestSource = class
    inherit CopyActivitySource
Public Class RestSource
Inherits CopyActivitySource
Implements IJsonModel(Of RestSource), IPersistableModel(Of RestSource)
Public Class RestSource
Inherits CopyActivitySource
Inheritance
Implements

Constructors

RestSource()

Initializes a new instance of RestSource.

Properties

AdditionalColumns

Specifies the additional columns to be added to source data. Type: key value pairs (value should be string type).

AdditionalHeaders

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

AdditionalProperties

Additional Properties

To assign an object to the value of this property use FromObjectAsJson<T>(T, JsonSerializerOptions).

To assign an already formatted json string to this property use FromString(String).

Examples:

  • BinaryData.FromObjectAsJson("foo"): Creates a payload of "foo".
  • BinaryData.FromString("\"foo\""): Creates a payload of "foo".
  • BinaryData.FromObjectAsJson(new { key = "value" }): Creates a payload of { "key": "value" }.
  • BinaryData.FromString("{\"key\": \"value\"}"): Creates a payload of { "key": "value" }.

(Inherited from CopyActivitySource)
DisableMetricsCollection

If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).

(Inherited from CopyActivitySource)
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 CopyActivitySource)
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.

To assign an object to this property use FromObjectAsJson<T>(T, JsonSerializerOptions).

To assign an already formatted json string to this property use FromString(String).

Examples:

  • BinaryData.FromObjectAsJson("foo"): Creates a payload of "foo".
  • BinaryData.FromString("\"foo\""): Creates a payload of "foo".
  • BinaryData.FromObjectAsJson(new { key = "value" }): Creates a payload of { "key": "value" }.
  • BinaryData.FromString("{\"key\": \"value\"}"): Creates a payload of { "key": "value" }.

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 CopyActivitySource)
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 CopyActivitySource)

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions) (Inherited from CopyActivitySource)

Explicit Interface Implementations

IJsonModel<CopyActivitySource>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

(Inherited from CopyActivitySource)
IJsonModel<CopyActivitySource>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

(Inherited from CopyActivitySource)
IJsonModel<RestSource>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<RestSource>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<CopyActivitySource>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

(Inherited from CopyActivitySource)
IPersistableModel<CopyActivitySource>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

(Inherited from CopyActivitySource)
IPersistableModel<CopyActivitySource>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

(Inherited from CopyActivitySource)
IPersistableModel<RestSource>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<RestSource>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<RestSource>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to