IDocumentDbOutputDataSourceProperties Interface
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Models.DocumentDbOutputDataSourcePropertiesTypeConverter))]
public interface IDocumentDbOutputDataSourceProperties : Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Runtime.IJsonSerializable[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Models.DocumentDbOutputDataSourcePropertiesTypeConverter))>]
type IDocumentDbOutputDataSourceProperties = interface
interface IJsonSerializablePublic Interface IDocumentDbOutputDataSourceProperties
Implements IJsonSerializable- Derived
- Attributes
- Implements
Properties
| Name | Description |
|---|---|
| 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. |
Methods
| Name | Description |
|---|---|
| ToJson(JsonObject, SerializationMode) | (Inherited from IJsonSerializable) |