Share via

CosmosDbSqlApiSource Class

  • Reference

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

All required parameters must be populated in order to send to server.

Inheritance
azure.mgmt.datafactory.models._models_py3.CopySource
CosmosDbSqlApiSource

Constructor

CosmosDbSqlApiSource(*, additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, source_retry_count: MutableMapping[str, Any] | None = None, source_retry_wait: MutableMapping[str, Any] | None = None, max_concurrent_connections: MutableMapping[str, Any] | None = None, disable_metrics_collection: MutableMapping[str, Any] | None = None, query: MutableMapping[str, Any] | None = None, page_size: MutableMapping[str, Any] | None = None, preferred_regions: MutableMapping[str, Any] | None = None, detect_datetime: MutableMapping[str, Any] | None = None, additional_columns: MutableMapping[str, Any] | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
additional_properties
dict[str, <xref:JSON>]

Unmatched properties from the message are deserialized to this collection.
source_retry_count
<xref:JSON>

Source retry count. Type: integer (or Expression with resultType integer).
source_retry_wait
<xref:JSON>

Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).
max_concurrent_connections
<xref:JSON>

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

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

SQL API query. Type: string (or Expression with resultType string).
page_size
<xref:JSON>

Page size of the result. Type: integer (or Expression with resultType integer).
preferred_regions
<xref:JSON>

Preferred regions. Type: array of strings (or Expression with resultType array of strings).
detect_datetime
<xref:JSON>

Whether detect primitive values as datetime values. Type: boolean (or Expression with resultType boolean).
additional_columns
<xref:JSON>

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

Variables

Name Description
additional_properties
dict[str, <xref:JSON>]

Unmatched properties from the message are deserialized to this collection.
type
str

Copy source type. Required.
source_retry_count
<xref:JSON>

Source retry count. Type: integer (or Expression with resultType integer).
source_retry_wait
<xref:JSON>

Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).
max_concurrent_connections
<xref:JSON>

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

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

SQL API query. Type: string (or Expression with resultType string).
page_size
<xref:JSON>

Page size of the result. Type: integer (or Expression with resultType integer).
preferred_regions
<xref:JSON>

Preferred regions. Type: array of strings (or Expression with resultType array of strings).
detect_datetime
<xref:JSON>

Whether detect primitive values as datetime values. Type: boolean (or Expression with resultType boolean).
additional_columns
<xref:JSON>

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