Share via

DocumentDbOutputDataSource interface

  • Reference
Package:
@azure/arm-streamanalytics

Describes a DocumentDB output data source.

Extends
OutputDataSource

Properties

accountId

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

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

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.
database

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

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

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.
type

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

Property Details

accountId

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

accountId?: string

Property Value

string

accountKey

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

accountKey?: string

Property Value

string

collectionNamePattern

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.

collectionNamePattern?: string

Property Value

string

database

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

database?: string

Property Value

string

documentId

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

documentId?: string

Property Value

string

partitionKey

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.

partitionKey?: string

Property Value

string

type

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

type: "Microsoft.Storage/DocumentDB"

Property Value

"Microsoft.Storage/DocumentDB"