CosmosDbSqlApiSource Class

Definition

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

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

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

AdditionalProperties

Additional Properties.

(Inherited from CopySource)
DetectDatetime

Whether detect primitive values as datetime values. Type: boolean (or Expression with resultType boolean).

MaxConcurrentConnections

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

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