Share via

CosmosDbSqlApiSink interface

  • Reference
Package:
@azure/arm-datafactory

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

Extends
CopySink

Properties

type

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

Describes how to write data to Azure Cosmos DB. Type: string (or Expression with resultType string). Allowed values: insert and upsert.

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 sink data store. Type: integer (or Expression with resultType integer).
sinkRetryCount

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

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

Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.
writeBatchTimeout

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

Property Details

type

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

type: "CosmosDbSqlApiSink"

Property Value

"CosmosDbSqlApiSink"

writeBehavior

Describes how to write data to Azure Cosmos DB. Type: string (or Expression with resultType string). Allowed values: insert and upsert.

writeBehavior?: any

Property Value

any

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 CopySink.disableMetricsCollection

maxConcurrentConnections

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

maxConcurrentConnections?: any

Property Value

any

Inherited From CopySink.maxConcurrentConnections

sinkRetryCount

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

sinkRetryCount?: any

Property Value

any

Inherited From CopySink.sinkRetryCount

sinkRetryWait

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

sinkRetryWait?: any

Property Value

any

Inherited From CopySink.sinkRetryWait

writeBatchSize

Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

writeBatchSize?: any

Property Value

any

Inherited From CopySink.writeBatchSize

writeBatchTimeout

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

writeBatchTimeout?: any

Property Value

any

Inherited From CopySink.writeBatchTimeout