Share via


DocumentDbOutputDataSource Class

Definition

Describes a DocumentDB output data source.

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Models.Api20170401Preview.DocumentDbOutputDataSourceTypeConverter))]
public class DocumentDbOutputDataSource : Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Models.Api20170401Preview.IDocumentDbOutputDataSource, Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Runtime.IValidates
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Models.Api20170401Preview.DocumentDbOutputDataSourceTypeConverter))>]
type DocumentDbOutputDataSource = class
    interface IDocumentDbOutputDataSource
    interface IJsonSerializable
    interface IOutputDataSource
    interface IValidates
Public Class DocumentDbOutputDataSource
Implements IDocumentDbOutputDataSource, IValidates
Inheritance
DocumentDbOutputDataSource
Attributes
Implements

Constructors

DocumentDbOutputDataSource()

Creates an new DocumentDbOutputDataSource instance.

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

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

Methods

DeserializeFromDictionary(IDictionary)

Deserializes a IDictionary into an instance of DocumentDbOutputDataSource.

DeserializeFromPSObject(PSObject)

Deserializes a PSObject into an instance of DocumentDbOutputDataSource.

FromJson(JsonNode)

Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Models.Api20170401Preview.IDocumentDbOutputDataSource.

FromJsonString(String)

Creates a new instance of DocumentDbOutputDataSource, deserializing the content from a json string.

ToJson(JsonObject, SerializationMode)

Serializes this instance of DocumentDbOutputDataSource into a JsonNode.

ToJsonString()

Serializes this instance to a json string.

Validate(IEventListener)

Validates that this object meets the validation criteria.

Applies to