DocumentDbOutputDataSourceProperties Class
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.
The properties that are associated with a DocumentDB output.
[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Models.Api20170401Preview.DocumentDbOutputDataSourcePropertiesTypeConverter))]
public class DocumentDbOutputDataSourceProperties : Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Models.Api20170401Preview.IDocumentDbOutputDataSourceProperties
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Models.Api20170401Preview.DocumentDbOutputDataSourcePropertiesTypeConverter))>]
type DocumentDbOutputDataSourceProperties = class
interface IDocumentDbOutputDataSourceProperties
interface IJsonSerializable
Public Class DocumentDbOutputDataSourceProperties
Implements IDocumentDbOutputDataSourceProperties
- Inheritance
-
DocumentDbOutputDataSourceProperties
- Attributes
- Implements
Constructors
DocumentDbOutputDataSourceProperties() |
Creates an new DocumentDbOutputDataSourceProperties 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. |
Methods
DeserializeFromDictionary(IDictionary) |
Deserializes a IDictionary into an instance of DocumentDbOutputDataSourceProperties. |
DeserializeFromPSObject(PSObject) |
Deserializes a PSObject into an instance of DocumentDbOutputDataSourceProperties. |
FromJson(JsonNode) |
Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Models.Api20170401Preview.IDocumentDbOutputDataSourceProperties. |
FromJsonString(String) |
Creates a new instance of DocumentDbOutputDataSourceProperties, deserializing the content from a json string. |
ToJson(JsonObject, SerializationMode) |
Serializes this instance of DocumentDbOutputDataSourceProperties into a JsonNode. |
ToJsonString() |
Serializes this instance to a json string. |