/
DocumentDbOutputDataSource.xml
278 lines (278 loc) · 16 KB
/
DocumentDbOutputDataSource.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
<Type Name="DocumentDbOutputDataSource" FullName="Microsoft.Azure.Management.StreamAnalytics.Models.DocumentDbOutputDataSource">
<TypeSignature Language="C#" Value="public class DocumentDbOutputDataSource : Microsoft.Azure.Management.StreamAnalytics.Models.OutputDataSource" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit DocumentDbOutputDataSource extends Microsoft.Azure.Management.StreamAnalytics.Models.OutputDataSource" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Management.StreamAnalytics.Models.DocumentDbOutputDataSource" />
<TypeSignature Language="VB.NET" Value="Public Class DocumentDbOutputDataSource
Inherits OutputDataSource" />
<TypeSignature Language="F#" Value="type DocumentDbOutputDataSource = class
 inherit OutputDataSource" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.StreamAnalytics</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Microsoft.Azure.Management.StreamAnalytics.Models.OutputDataSource</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute>
<AttributeName Language="C#">[Microsoft.Rest.Serialization.JsonTransformation]</AttributeName>
<AttributeName Language="F#">[<Microsoft.Rest.Serialization.JsonTransformation>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonObject("Microsoft.Storage/DocumentDB")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonObject("Microsoft.Storage/DocumentDB")>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>
Describes a DocumentDB output data source.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public DocumentDbOutputDataSource ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Management.StreamAnalytics.Models.DocumentDbOutputDataSource.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.StreamAnalytics</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>
Initializes a new instance of the DocumentDbOutputDataSource class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public DocumentDbOutputDataSource (string accountId = default, string accountKey = default, string database = default, string collectionNamePattern = default, string partitionKey = default, string documentId = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string accountId, string accountKey, string database, string collectionNamePattern, string partitionKey, string documentId) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Management.StreamAnalytics.Models.DocumentDbOutputDataSource.#ctor(System.String,System.String,System.String,System.String,System.String,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (Optional accountId As String = Nothing, Optional accountKey As String = Nothing, Optional database As String = Nothing, Optional collectionNamePattern As String = Nothing, Optional partitionKey As String = Nothing, Optional documentId As String = Nothing)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.Management.StreamAnalytics.Models.DocumentDbOutputDataSource : string * string * string * string * string * string -> Microsoft.Azure.Management.StreamAnalytics.Models.DocumentDbOutputDataSource" Usage="new Microsoft.Azure.Management.StreamAnalytics.Models.DocumentDbOutputDataSource (accountId, accountKey, database, collectionNamePattern, partitionKey, documentId)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.StreamAnalytics</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="accountId" Type="System.String" />
<Parameter Name="accountKey" Type="System.String" />
<Parameter Name="database" Type="System.String" />
<Parameter Name="collectionNamePattern" Type="System.String" />
<Parameter Name="partitionKey" Type="System.String" />
<Parameter Name="documentId" Type="System.String" />
</Parameters>
<Docs>
<param name="accountId">The DocumentDB account name or ID. Required
on PUT (CreateOrReplace) requests.</param>
<param name="accountKey">The account key for the DocumentDB
account. Required on PUT (CreateOrReplace) requests.</param>
<param name="database">The name of the DocumentDB database.
Required on PUT (CreateOrReplace) requests.</param>
<param name="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.</param>
<param name="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.</param>
<param name="documentId">The name of the field in output events
used to specify the primary key which insert or update operations
are based on.</param>
<summary>
Initializes a new instance of the DocumentDbOutputDataSource class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AccountId">
<MemberSignature Language="C#" Value="public string AccountId { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string AccountId" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.StreamAnalytics.Models.DocumentDbOutputDataSource.AccountId" />
<MemberSignature Language="VB.NET" Value="Public Property AccountId As String" />
<MemberSignature Language="F#" Value="member this.AccountId : string with get, set" Usage="Microsoft.Azure.Management.StreamAnalytics.Models.DocumentDbOutputDataSource.AccountId" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.StreamAnalytics</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="properties.accountId")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="properties.accountId")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the DocumentDB account name or ID. Required on PUT
(CreateOrReplace) requests.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AccountKey">
<MemberSignature Language="C#" Value="public string AccountKey { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string AccountKey" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.StreamAnalytics.Models.DocumentDbOutputDataSource.AccountKey" />
<MemberSignature Language="VB.NET" Value="Public Property AccountKey As String" />
<MemberSignature Language="F#" Value="member this.AccountKey : string with get, set" Usage="Microsoft.Azure.Management.StreamAnalytics.Models.DocumentDbOutputDataSource.AccountKey" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.StreamAnalytics</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="properties.accountKey")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="properties.accountKey")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the account key for the DocumentDB account. Required
on PUT (CreateOrReplace) requests.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CollectionNamePattern">
<MemberSignature Language="C#" Value="public string CollectionNamePattern { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string CollectionNamePattern" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.StreamAnalytics.Models.DocumentDbOutputDataSource.CollectionNamePattern" />
<MemberSignature Language="VB.NET" Value="Public Property CollectionNamePattern As String" />
<MemberSignature Language="F#" Value="member this.CollectionNamePattern : string with get, set" Usage="Microsoft.Azure.Management.StreamAnalytics.Models.DocumentDbOutputDataSource.CollectionNamePattern" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.StreamAnalytics</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="properties.collectionNamePattern")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="properties.collectionNamePattern")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets 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.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Database">
<MemberSignature Language="C#" Value="public string Database { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Database" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.StreamAnalytics.Models.DocumentDbOutputDataSource.Database" />
<MemberSignature Language="VB.NET" Value="Public Property Database As String" />
<MemberSignature Language="F#" Value="member this.Database : string with get, set" Usage="Microsoft.Azure.Management.StreamAnalytics.Models.DocumentDbOutputDataSource.Database" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.StreamAnalytics</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="properties.database")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="properties.database")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the name of the DocumentDB database. Required on PUT
(CreateOrReplace) requests.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="DocumentId">
<MemberSignature Language="C#" Value="public string DocumentId { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string DocumentId" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.StreamAnalytics.Models.DocumentDbOutputDataSource.DocumentId" />
<MemberSignature Language="VB.NET" Value="Public Property DocumentId As String" />
<MemberSignature Language="F#" Value="member this.DocumentId : string with get, set" Usage="Microsoft.Azure.Management.StreamAnalytics.Models.DocumentDbOutputDataSource.DocumentId" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.StreamAnalytics</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="properties.documentId")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="properties.documentId")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the name of the field in output events used to specify
the primary key which insert or update operations are based on.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="PartitionKey">
<MemberSignature Language="C#" Value="public string PartitionKey { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string PartitionKey" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.StreamAnalytics.Models.DocumentDbOutputDataSource.PartitionKey" />
<MemberSignature Language="VB.NET" Value="Public Property PartitionKey As String" />
<MemberSignature Language="F#" Value="member this.PartitionKey : string with get, set" Usage="Microsoft.Azure.Management.StreamAnalytics.Models.DocumentDbOutputDataSource.PartitionKey" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.StreamAnalytics</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="properties.partitionKey")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="properties.partitionKey")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets 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.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>