-
Notifications
You must be signed in to change notification settings - Fork 262
/
AzureMLLinkedService.xml
223 lines (223 loc) · 14.9 KB
/
AzureMLLinkedService.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
<Type Name="AzureMLLinkedService" FullName="Azure.Analytics.Synapse.Artifacts.Models.AzureMLLinkedService">
<TypeSignature Language="C#" Value="public class AzureMLLinkedService : Azure.Analytics.Synapse.Artifacts.Models.LinkedService" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit AzureMLLinkedService extends Azure.Analytics.Synapse.Artifacts.Models.LinkedService" />
<TypeSignature Language="DocId" Value="T:Azure.Analytics.Synapse.Artifacts.Models.AzureMLLinkedService" />
<TypeSignature Language="VB.NET" Value="Public Class AzureMLLinkedService
Inherits LinkedService" />
<TypeSignature Language="F#" Value="type AzureMLLinkedService = 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.AzureMLLinkedService+AzureMLLinkedServiceConverter))]</AttributeName>
<AttributeName Language="F#">[<System.Text.Json.Serialization.JsonConverter(typeof(Azure.Analytics.Synapse.Artifacts.Models.AzureMLLinkedService+AzureMLLinkedServiceConverter))>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary> Azure ML Studio Web Service linked service. </summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public AzureMLLinkedService (object mlEndpoint, Azure.Analytics.Synapse.Artifacts.Models.SecretBase apiKey);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(object mlEndpoint, class Azure.Analytics.Synapse.Artifacts.Models.SecretBase apiKey) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Synapse.Artifacts.Models.AzureMLLinkedService.#ctor(System.Object,Azure.Analytics.Synapse.Artifacts.Models.SecretBase)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (mlEndpoint As Object, apiKey As SecretBase)" />
<MemberSignature Language="F#" Value="new Azure.Analytics.Synapse.Artifacts.Models.AzureMLLinkedService : obj * Azure.Analytics.Synapse.Artifacts.Models.SecretBase -> Azure.Analytics.Synapse.Artifacts.Models.AzureMLLinkedService" Usage="new Azure.Analytics.Synapse.Artifacts.Models.AzureMLLinkedService (mlEndpoint, apiKey)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Synapse.Artifacts</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="mlEndpoint" Type="System.Object" />
<Parameter Name="apiKey" Type="Azure.Analytics.Synapse.Artifacts.Models.SecretBase" />
</Parameters>
<Docs>
<param name="mlEndpoint"> The Batch Execution REST URL for an Azure ML Studio Web Service endpoint. Type: string (or Expression with resultType string). </param>
<param name="apiKey">
The API key for accessing the Azure ML model endpoint.
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" />.
</param>
<summary> Initializes a new instance of <see cref="T:Azure.Analytics.Synapse.Artifacts.Models.AzureMLLinkedService" />. </summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="mlEndpoint" /> or <paramref name="apiKey" /> is null. </exception>
</Docs>
</Member>
<Member MemberName="ApiKey">
<MemberSignature Language="C#" Value="public Azure.Analytics.Synapse.Artifacts.Models.SecretBase ApiKey { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Azure.Analytics.Synapse.Artifacts.Models.SecretBase ApiKey" />
<MemberSignature Language="DocId" Value="P:Azure.Analytics.Synapse.Artifacts.Models.AzureMLLinkedService.ApiKey" />
<MemberSignature Language="VB.NET" Value="Public Property ApiKey As SecretBase" />
<MemberSignature Language="F#" Value="member this.ApiKey : Azure.Analytics.Synapse.Artifacts.Models.SecretBase with get, set" Usage="Azure.Analytics.Synapse.Artifacts.Models.AzureMLLinkedService.ApiKey" />
<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>
The API key for accessing the Azure ML model endpoint.
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="Authentication">
<MemberSignature Language="C#" Value="public object Authentication { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance object Authentication" />
<MemberSignature Language="DocId" Value="P:Azure.Analytics.Synapse.Artifacts.Models.AzureMLLinkedService.Authentication" />
<MemberSignature Language="VB.NET" Value="Public Property Authentication As Object" />
<MemberSignature Language="F#" Value="member this.Authentication : obj with get, set" Usage="Azure.Analytics.Synapse.Artifacts.Models.AzureMLLinkedService.Authentication" />
<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> Type of authentication (Required to specify MSI) used to connect to AzureML. Type: string (or Expression with resultType string). </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.AzureMLLinkedService.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.AzureMLLinkedService.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="MlEndpoint">
<MemberSignature Language="C#" Value="public object MlEndpoint { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance object MlEndpoint" />
<MemberSignature Language="DocId" Value="P:Azure.Analytics.Synapse.Artifacts.Models.AzureMLLinkedService.MlEndpoint" />
<MemberSignature Language="VB.NET" Value="Public Property MlEndpoint As Object" />
<MemberSignature Language="F#" Value="member this.MlEndpoint : obj with get, set" Usage="Azure.Analytics.Synapse.Artifacts.Models.AzureMLLinkedService.MlEndpoint" />
<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 Batch Execution REST URL for an Azure ML Studio Web Service endpoint. Type: string (or Expression with resultType string). </summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ServicePrincipalId">
<MemberSignature Language="C#" Value="public object ServicePrincipalId { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance object ServicePrincipalId" />
<MemberSignature Language="DocId" Value="P:Azure.Analytics.Synapse.Artifacts.Models.AzureMLLinkedService.ServicePrincipalId" />
<MemberSignature Language="VB.NET" Value="Public Property ServicePrincipalId As Object" />
<MemberSignature Language="F#" Value="member this.ServicePrincipalId : obj with get, set" Usage="Azure.Analytics.Synapse.Artifacts.Models.AzureMLLinkedService.ServicePrincipalId" />
<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 ID of the service principal used to authenticate against the ARM-based updateResourceEndpoint of an Azure ML Studio web service. Type: string (or Expression with resultType string). </summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ServicePrincipalKey">
<MemberSignature Language="C#" Value="public Azure.Analytics.Synapse.Artifacts.Models.SecretBase ServicePrincipalKey { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Azure.Analytics.Synapse.Artifacts.Models.SecretBase ServicePrincipalKey" />
<MemberSignature Language="DocId" Value="P:Azure.Analytics.Synapse.Artifacts.Models.AzureMLLinkedService.ServicePrincipalKey" />
<MemberSignature Language="VB.NET" Value="Public Property ServicePrincipalKey As SecretBase" />
<MemberSignature Language="F#" Value="member this.ServicePrincipalKey : Azure.Analytics.Synapse.Artifacts.Models.SecretBase with get, set" Usage="Azure.Analytics.Synapse.Artifacts.Models.AzureMLLinkedService.ServicePrincipalKey" />
<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>
The key of the service principal used to authenticate against the ARM-based updateResourceEndpoint of an Azure ML Studio web service.
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="Tenant">
<MemberSignature Language="C#" Value="public object Tenant { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance object Tenant" />
<MemberSignature Language="DocId" Value="P:Azure.Analytics.Synapse.Artifacts.Models.AzureMLLinkedService.Tenant" />
<MemberSignature Language="VB.NET" Value="Public Property Tenant As Object" />
<MemberSignature Language="F#" Value="member this.Tenant : obj with get, set" Usage="Azure.Analytics.Synapse.Artifacts.Models.AzureMLLinkedService.Tenant" />
<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 or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string). </summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="UpdateResourceEndpoint">
<MemberSignature Language="C#" Value="public object UpdateResourceEndpoint { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance object UpdateResourceEndpoint" />
<MemberSignature Language="DocId" Value="P:Azure.Analytics.Synapse.Artifacts.Models.AzureMLLinkedService.UpdateResourceEndpoint" />
<MemberSignature Language="VB.NET" Value="Public Property UpdateResourceEndpoint As Object" />
<MemberSignature Language="F#" Value="member this.UpdateResourceEndpoint : obj with get, set" Usage="Azure.Analytics.Synapse.Artifacts.Models.AzureMLLinkedService.UpdateResourceEndpoint" />
<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 Update Resource REST URL for an Azure ML Studio Web Service endpoint. Type: string (or Expression with resultType string). </summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>