Feedback Edit

DocumentDbOutputDataSource Class

  • Reference

Describes a DocumentDB output data source.

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

Inheritance
azure.mgmt.streamanalytics.models._models_py3.OutputDataSource
DocumentDbOutputDataSource

Constructor

DocumentDbOutputDataSource(*, account_id: Optional[str] = None, account_key: Optional[str] = None, database: Optional[str] = None, collection_name_pattern: Optional[str] = None, partition_key: Optional[str] = None, document_id: Optional[str] = None, **kwargs)

Parameters

type
str
Required

Required. Indicates the type of data source output will be written to. Required on PUT (CreateOrReplace) requests.Constant filled by server.

account_id
str
Required

The DocumentDB account name or ID. Required on PUT (CreateOrReplace) requests.

account_key
str
Required

The account key for the DocumentDB account. Required on PUT (CreateOrReplace) requests.

database
str
Required

The name of the DocumentDB database. Required on PUT (CreateOrReplace) requests.

collection_name_pattern
str
Required

The collection name pattern for the collections to be used. The collection name format can be constructed using the optional {partition} token, where partitions start from 0. See the DocumentDB section of https://docs.microsoft.com/en- us/rest/api/streamanalytics/stream-analytics-output for more information. Required on PUT (CreateOrReplace) requests.

partition_key
str
Required

The name of the field in output events used to specify the key for partitioning output across collections. If 'collectionNamePattern' contains the {partition} token, this property is required to be specified.

document_id
str
Required

The name of the field in output events used to specify the primary key which insert or update operations are based on.