Share via

CosmosDbSqlApiSource interface

  • Reference
Package:
@azure/arm-datafactory

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

Extends
CopySource

Properties

additionalColumns

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

Whether detect primitive values as datetime values. Type: boolean (or Expression with resultType boolean).
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).
type

Polymorphic discriminator, which specifies the different types this object can be

Inherited Properties

disableMetricsCollection

If true, disable data store metrics collection. Default is false. 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).
sourceRetryCount

Source retry count. Type: integer (or Expression with resultType integer).
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])).

Property Details

additionalColumns

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

additionalColumns?: any

Property Value

any

detectDatetime

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

detectDatetime?: any

Property Value

any

pageSize

Page size of the result. Type: integer (or Expression with resultType integer).

pageSize?: any

Property Value

any

preferredRegions

Preferred regions. Type: array of strings (or Expression with resultType array of strings).

preferredRegions?: any

Property Value

any

query

SQL API query. Type: string (or Expression with resultType string).

query?: any

Property Value

any

type

Polymorphic discriminator, which specifies the different types this object can be

type: "CosmosDbSqlApiSource"

Property Value

"CosmosDbSqlApiSource"

Inherited Property Details

disableMetricsCollection

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

disableMetricsCollection?: any

Property Value

any

Inherited From CopySource.disableMetricsCollection

maxConcurrentConnections

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

maxConcurrentConnections?: any

Property Value

any

Inherited From CopySource.maxConcurrentConnections

sourceRetryCount

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

sourceRetryCount?: any

Property Value

any

Inherited From CopySource.sourceRetryCount

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

sourceRetryWait?: any

Property Value

any

Inherited From CopySource.sourceRetryWait