-
Notifications
You must be signed in to change notification settings - Fork 256
/
MongoDbLinkedService.xml
255 lines (255 loc) · 15.9 KB
/
MongoDbLinkedService.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
<Type Name="MongoDbLinkedService" FullName="Azure.Analytics.Synapse.Artifacts.Models.MongoDbLinkedService">
<TypeSignature Language="C#" Value="public class MongoDbLinkedService : Azure.Analytics.Synapse.Artifacts.Models.LinkedService" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit MongoDbLinkedService extends Azure.Analytics.Synapse.Artifacts.Models.LinkedService" />
<TypeSignature Language="DocId" Value="T:Azure.Analytics.Synapse.Artifacts.Models.MongoDbLinkedService" />
<TypeSignature Language="VB.NET" Value="Public Class MongoDbLinkedService
Inherits LinkedService" />
<TypeSignature Language="F#" Value="type MongoDbLinkedService = class
 inherit LinkedService" />
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Synapse.Artifacts</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Azure.Analytics.Synapse.Artifacts.Models.LinkedService</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Text.Json.Serialization.JsonConverter(typeof(Azure.Analytics.Synapse.Artifacts.Models.MongoDbLinkedService+MongoDbLinkedServiceConverter))]</AttributeName>
<AttributeName Language="F#">[<System.Text.Json.Serialization.JsonConverter(typeof(Azure.Analytics.Synapse.Artifacts.Models.MongoDbLinkedService+MongoDbLinkedServiceConverter))>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary> Linked service for MongoDb data source. </summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public MongoDbLinkedService (object server, object databaseName);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(object server, object databaseName) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Synapse.Artifacts.Models.MongoDbLinkedService.#ctor(System.Object,System.Object)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (server As Object, databaseName As Object)" />
<MemberSignature Language="F#" Value="new Azure.Analytics.Synapse.Artifacts.Models.MongoDbLinkedService : obj * obj -> Azure.Analytics.Synapse.Artifacts.Models.MongoDbLinkedService" Usage="new Azure.Analytics.Synapse.Artifacts.Models.MongoDbLinkedService (server, databaseName)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Synapse.Artifacts</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="server" Type="System.Object" />
<Parameter Name="databaseName" Type="System.Object" />
</Parameters>
<Docs>
<param name="server"> The IP address or server name of the MongoDB server. Type: string (or Expression with resultType string). </param>
<param name="databaseName"> The name of the MongoDB database that you want to access. Type: string (or Expression with resultType string). </param>
<summary> Initializes a new instance of <see cref="T:Azure.Analytics.Synapse.Artifacts.Models.MongoDbLinkedService" />. </summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="server" /> or <paramref name="databaseName" /> is null. </exception>
</Docs>
</Member>
<Member MemberName="AllowSelfSignedServerCert">
<MemberSignature Language="C#" Value="public object AllowSelfSignedServerCert { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance object AllowSelfSignedServerCert" />
<MemberSignature Language="DocId" Value="P:Azure.Analytics.Synapse.Artifacts.Models.MongoDbLinkedService.AllowSelfSignedServerCert" />
<MemberSignature Language="VB.NET" Value="Public Property AllowSelfSignedServerCert As Object" />
<MemberSignature Language="F#" Value="member this.AllowSelfSignedServerCert : obj with get, set" Usage="Azure.Analytics.Synapse.Artifacts.Models.MongoDbLinkedService.AllowSelfSignedServerCert" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Synapse.Artifacts</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Docs>
<summary> Specifies whether to allow self-signed certificates from the server. The default value is false. Type: boolean (or Expression with resultType boolean). </summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AuthenticationType">
<MemberSignature Language="C#" Value="public Azure.Analytics.Synapse.Artifacts.Models.MongoDbAuthenticationType? AuthenticationType { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<valuetype Azure.Analytics.Synapse.Artifacts.Models.MongoDbAuthenticationType> AuthenticationType" />
<MemberSignature Language="DocId" Value="P:Azure.Analytics.Synapse.Artifacts.Models.MongoDbLinkedService.AuthenticationType" />
<MemberSignature Language="VB.NET" Value="Public Property AuthenticationType As Nullable(Of MongoDbAuthenticationType)" />
<MemberSignature Language="F#" Value="member this.AuthenticationType : Nullable<Azure.Analytics.Synapse.Artifacts.Models.MongoDbAuthenticationType> with get, set" Usage="Azure.Analytics.Synapse.Artifacts.Models.MongoDbLinkedService.AuthenticationType" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Synapse.Artifacts</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<Azure.Analytics.Synapse.Artifacts.Models.MongoDbAuthenticationType></ReturnType>
</ReturnValue>
<Docs>
<summary> The authentication type to be used to connect to the MongoDB database. </summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AuthSource">
<MemberSignature Language="C#" Value="public object AuthSource { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance object AuthSource" />
<MemberSignature Language="DocId" Value="P:Azure.Analytics.Synapse.Artifacts.Models.MongoDbLinkedService.AuthSource" />
<MemberSignature Language="VB.NET" Value="Public Property AuthSource As Object" />
<MemberSignature Language="F#" Value="member this.AuthSource : obj with get, set" Usage="Azure.Analytics.Synapse.Artifacts.Models.MongoDbLinkedService.AuthSource" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Synapse.Artifacts</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Docs>
<summary> Database to verify the username and password. Type: string (or Expression with resultType string). </summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="DatabaseName">
<MemberSignature Language="C#" Value="public object DatabaseName { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance object DatabaseName" />
<MemberSignature Language="DocId" Value="P:Azure.Analytics.Synapse.Artifacts.Models.MongoDbLinkedService.DatabaseName" />
<MemberSignature Language="VB.NET" Value="Public Property DatabaseName As Object" />
<MemberSignature Language="F#" Value="member this.DatabaseName : obj with get, set" Usage="Azure.Analytics.Synapse.Artifacts.Models.MongoDbLinkedService.DatabaseName" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Synapse.Artifacts</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Docs>
<summary> The name of the MongoDB database that you want to access. Type: string (or Expression with resultType string). </summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="EnableSsl">
<MemberSignature Language="C#" Value="public object EnableSsl { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance object EnableSsl" />
<MemberSignature Language="DocId" Value="P:Azure.Analytics.Synapse.Artifacts.Models.MongoDbLinkedService.EnableSsl" />
<MemberSignature Language="VB.NET" Value="Public Property EnableSsl As Object" />
<MemberSignature Language="F#" Value="member this.EnableSsl : obj with get, set" Usage="Azure.Analytics.Synapse.Artifacts.Models.MongoDbLinkedService.EnableSsl" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Synapse.Artifacts</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Docs>
<summary> Specifies whether the connections to the server are encrypted using SSL. The default value is false. Type: boolean (or Expression with resultType boolean). </summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="EncryptedCredential">
<MemberSignature Language="C#" Value="public object EncryptedCredential { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance object EncryptedCredential" />
<MemberSignature Language="DocId" Value="P:Azure.Analytics.Synapse.Artifacts.Models.MongoDbLinkedService.EncryptedCredential" />
<MemberSignature Language="VB.NET" Value="Public Property EncryptedCredential As Object" />
<MemberSignature Language="F#" Value="member this.EncryptedCredential : obj with get, set" Usage="Azure.Analytics.Synapse.Artifacts.Models.MongoDbLinkedService.EncryptedCredential" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Synapse.Artifacts</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Docs>
<summary> The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string). </summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Password">
<MemberSignature Language="C#" Value="public Azure.Analytics.Synapse.Artifacts.Models.SecretBase Password { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Azure.Analytics.Synapse.Artifacts.Models.SecretBase Password" />
<MemberSignature Language="DocId" Value="P:Azure.Analytics.Synapse.Artifacts.Models.MongoDbLinkedService.Password" />
<MemberSignature Language="VB.NET" Value="Public Property Password As SecretBase" />
<MemberSignature Language="F#" Value="member this.Password : Azure.Analytics.Synapse.Artifacts.Models.SecretBase with get, set" Usage="Azure.Analytics.Synapse.Artifacts.Models.MongoDbLinkedService.Password" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Synapse.Artifacts</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Analytics.Synapse.Artifacts.Models.SecretBase</ReturnType>
</ReturnValue>
<Docs>
<summary>
Password for authentication.
Please note <see cref="T:Azure.Analytics.Synapse.Artifacts.Models.SecretBase" /> is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes.
The available derived classes include <see cref="T:Azure.Analytics.Synapse.Artifacts.Models.AzureKeyVaultSecretReference" /> and <see cref="T:Azure.Analytics.Synapse.Artifacts.Models.SecureString" />.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Port">
<MemberSignature Language="C#" Value="public object Port { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance object Port" />
<MemberSignature Language="DocId" Value="P:Azure.Analytics.Synapse.Artifacts.Models.MongoDbLinkedService.Port" />
<MemberSignature Language="VB.NET" Value="Public Property Port As Object" />
<MemberSignature Language="F#" Value="member this.Port : obj with get, set" Usage="Azure.Analytics.Synapse.Artifacts.Models.MongoDbLinkedService.Port" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Synapse.Artifacts</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Docs>
<summary> The TCP port number that the MongoDB server uses to listen for client connections. The default value is 27017. Type: integer (or Expression with resultType integer), minimum: 0. </summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Server">
<MemberSignature Language="C#" Value="public object Server { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance object Server" />
<MemberSignature Language="DocId" Value="P:Azure.Analytics.Synapse.Artifacts.Models.MongoDbLinkedService.Server" />
<MemberSignature Language="VB.NET" Value="Public Property Server As Object" />
<MemberSignature Language="F#" Value="member this.Server : obj with get, set" Usage="Azure.Analytics.Synapse.Artifacts.Models.MongoDbLinkedService.Server" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Synapse.Artifacts</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Docs>
<summary> The IP address or server name of the MongoDB server. Type: string (or Expression with resultType string). </summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Username">
<MemberSignature Language="C#" Value="public object Username { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance object Username" />
<MemberSignature Language="DocId" Value="P:Azure.Analytics.Synapse.Artifacts.Models.MongoDbLinkedService.Username" />
<MemberSignature Language="VB.NET" Value="Public Property Username As Object" />
<MemberSignature Language="F#" Value="member this.Username : obj with get, set" Usage="Azure.Analytics.Synapse.Artifacts.Models.MongoDbLinkedService.Username" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Synapse.Artifacts</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Docs>
<summary> Username for authentication. Type: string (or Expression with resultType string). </summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>