DocumentDbOutputDataSourceResponse

data class DocumentDbOutputDataSourceResponse(val accountId: String? = null, val accountKey: String? = null, val collectionNamePattern: String? = null, val database: String? = null, val documentId: String? = null, val partitionKey: String? = null, val type: String)

Describes a DocumentDB output data source.

Constructors

Link copied to clipboard
constructor(accountId: String? = null, accountKey: String? = null, collectionNamePattern: String? = null, database: String? = null, documentId: String? = null, partitionKey: String? = null, type: String)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val accountId: String? = null

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

Link copied to clipboard
val accountKey: String? = null

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

Link copied to clipboard

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.

Link copied to clipboard
val database: String? = null

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

Link copied to clipboard
val documentId: String? = null

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

Link copied to clipboard
val partitionKey: String? = null

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.

Link copied to clipboard

Indicates the type of data source output will be written to. Required on PUT (CreateOrReplace) requests. Expected value is 'Microsoft.Storage/DocumentDB'.