CosmosDBSqlApiSource Class

Definition

Namespace:

Azure.ResourceManager.DataFactory.Models

Assembly:

Azure.ResourceManager.DataFactory.dll

Package:

Azure.ResourceManager.DataFactory v1.5.0

Source:

CosmosDBSqlApiSource.cs

A copy activity Azure CosmosDB (SQL API) Collection source.

public class CosmosDBSqlApiSource : Azure.ResourceManager.DataFactory.Models.CopyActivitySource, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.DataFactory.Models.CosmosDBSqlApiSource>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.DataFactory.Models.CosmosDBSqlApiSource>

type CosmosDBSqlApiSource = class
    inherit CopyActivitySource
    interface IJsonModel<CosmosDBSqlApiSource>
    interface IPersistableModel<CosmosDBSqlApiSource>

Public Class CosmosDBSqlApiSource
Inherits CopyActivitySource
Implements IJsonModel(Of CosmosDBSqlApiSource), IPersistableModel(Of CosmosDBSqlApiSource)

Inheritance

Object

CopyActivitySource

CosmosDBSqlApiSource

Implements

IJsonModel<CosmosDBSqlApiSource> IPersistableModel<CosmosDBSqlApiSource> IPersistableModel<T>

Constructors

CosmosDBSqlApiSource()

Initializes a new instance of CosmosDBSqlApiSource.

Properties

AdditionalColumns	Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects). 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" }.
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)
DetectDatetime	Whether detect primitive values as datetime values. Type: boolean (or Expression with resultType boolean).
DisableMetricsCollection	If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). (Inherited from CopyActivitySource)
MaxConcurrentConnections	The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). (Inherited from CopyActivitySource)
PageSize	Page size of the result. Type: integer (or Expression with resultType integer).
PreferredRegions	Preferred regions. Type: array of strings (or Expression with resultType array of strings).
Query	SQL API query. 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)

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<CosmosDBSqlApiSource>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<CosmosDBSqlApiSource>.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<CosmosDBSqlApiSource>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model.
IPersistableModel<CosmosDBSqlApiSource>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<CosmosDBSqlApiSource>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData.