/
ClusterPrincipalAssignment.xml
356 lines (356 loc) · 19.7 KB
/
ClusterPrincipalAssignment.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
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
<Type Name="ClusterPrincipalAssignment" FullName="Microsoft.Azure.Management.Kusto.Models.ClusterPrincipalAssignment">
<TypeSignature Language="C#" Value="public class ClusterPrincipalAssignment : Microsoft.Azure.Management.Kusto.Models.ProxyResource" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit ClusterPrincipalAssignment extends Microsoft.Azure.Management.Kusto.Models.ProxyResource" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Management.Kusto.Models.ClusterPrincipalAssignment" />
<TypeSignature Language="VB.NET" Value="Public Class ClusterPrincipalAssignment
Inherits ProxyResource" />
<TypeSignature Language="F#" Value="type ClusterPrincipalAssignment = class
 inherit ProxyResource" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.Kusto</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
<AssemblyVersion>10.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Microsoft.Azure.Management.Kusto.Models.ProxyResource</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute>
<AttributeName Language="C#">[Microsoft.Rest.Serialization.JsonTransformation]</AttributeName>
<AttributeName Language="F#">[<Microsoft.Rest.Serialization.JsonTransformation>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>
Class representing a cluster principal assignment.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ClusterPrincipalAssignment ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Management.Kusto.Models.ClusterPrincipalAssignment.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.Kusto</AssemblyName>
<AssemblyVersion>10.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>
Initializes a new instance of the ClusterPrincipalAssignment class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ClusterPrincipalAssignment (string principalId, string role, string principalType, string id = default, string name = default, string type = default, string tenantId = default, string tenantName = default, string principalName = default, string provisioningState = default, string aadObjectId = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string principalId, string role, string principalType, string id, string name, string type, string tenantId, string tenantName, string principalName, string provisioningState, string aadObjectId) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Management.Kusto.Models.ClusterPrincipalAssignment.#ctor(System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (principalId As String, role As String, principalType As String, Optional id As String = Nothing, Optional name As String = Nothing, Optional type As String = Nothing, Optional tenantId As String = Nothing, Optional tenantName As String = Nothing, Optional principalName As String = Nothing, Optional provisioningState As String = Nothing, Optional aadObjectId As String = Nothing)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.Management.Kusto.Models.ClusterPrincipalAssignment : string * string * string * string * string * string * string * string * string * string * string -> Microsoft.Azure.Management.Kusto.Models.ClusterPrincipalAssignment" Usage="new Microsoft.Azure.Management.Kusto.Models.ClusterPrincipalAssignment (principalId, role, principalType, id, name, type, tenantId, tenantName, principalName, provisioningState, aadObjectId)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.Kusto</AssemblyName>
<AssemblyVersion>10.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="principalId" Type="System.String" />
<Parameter Name="role" Type="System.String" />
<Parameter Name="principalType" Type="System.String" />
<Parameter Name="id" Type="System.String" />
<Parameter Name="name" Type="System.String" />
<Parameter Name="type" Type="System.String" />
<Parameter Name="tenantId" Type="System.String" />
<Parameter Name="tenantName" Type="System.String" />
<Parameter Name="principalName" Type="System.String" />
<Parameter Name="provisioningState" Type="System.String" />
<Parameter Name="aadObjectId" Type="System.String" />
</Parameters>
<Docs>
<param name="principalId">The principal ID assigned to the cluster
principal. It can be a user email, application ID, or security
group name.</param>
<param name="role">Cluster principal role. Possible values include:
'AllDatabasesAdmin', 'AllDatabasesViewer'</param>
<param name="principalType">Principal type. Possible values
include: 'App', 'Group', 'User'</param>
<param name="id">Fully qualified resource ID for the resource. Ex -
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}</param>
<param name="name">The name of the resource</param>
<param name="type">The type of the resource. E.g.
"Microsoft.Compute/virtualMachines" or
"Microsoft.Storage/storageAccounts"</param>
<param name="tenantId">The tenant id of the principal</param>
<param name="tenantName">The tenant name of the principal</param>
<param name="principalName">The principal name</param>
<param name="provisioningState">The provisioned state of the
resource. Possible values include: 'Running', 'Creating',
'Deleting', 'Succeeded', 'Failed', 'Moving'</param>
<param name="aadObjectId">The service principal object id in AAD
(Azure active directory)</param>
<summary>
Initializes a new instance of the ClusterPrincipalAssignment class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AadObjectId">
<MemberSignature Language="C#" Value="public string AadObjectId { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string AadObjectId" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.Kusto.Models.ClusterPrincipalAssignment.AadObjectId" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property AadObjectId As String" />
<MemberSignature Language="F#" Value="member this.AadObjectId : string" Usage="Microsoft.Azure.Management.Kusto.Models.ClusterPrincipalAssignment.AadObjectId" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.Kusto</AssemblyName>
<AssemblyVersion>10.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="properties.aadObjectId")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="properties.aadObjectId")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the service principal object id in AAD (Azure active
directory)
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="PrincipalId">
<MemberSignature Language="C#" Value="public string PrincipalId { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string PrincipalId" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.Kusto.Models.ClusterPrincipalAssignment.PrincipalId" />
<MemberSignature Language="VB.NET" Value="Public Property PrincipalId As String" />
<MemberSignature Language="F#" Value="member this.PrincipalId : string with get, set" Usage="Microsoft.Azure.Management.Kusto.Models.ClusterPrincipalAssignment.PrincipalId" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.Kusto</AssemblyName>
<AssemblyVersion>10.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="properties.principalId")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="properties.principalId")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the principal ID assigned to the cluster principal. It
can be a user email, application ID, or security group name.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="PrincipalName">
<MemberSignature Language="C#" Value="public string PrincipalName { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string PrincipalName" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.Kusto.Models.ClusterPrincipalAssignment.PrincipalName" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property PrincipalName As String" />
<MemberSignature Language="F#" Value="member this.PrincipalName : string" Usage="Microsoft.Azure.Management.Kusto.Models.ClusterPrincipalAssignment.PrincipalName" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.Kusto</AssemblyName>
<AssemblyVersion>10.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="properties.principalName")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="properties.principalName")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the principal name
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="PrincipalType">
<MemberSignature Language="C#" Value="public string PrincipalType { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string PrincipalType" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.Kusto.Models.ClusterPrincipalAssignment.PrincipalType" />
<MemberSignature Language="VB.NET" Value="Public Property PrincipalType As String" />
<MemberSignature Language="F#" Value="member this.PrincipalType : string with get, set" Usage="Microsoft.Azure.Management.Kusto.Models.ClusterPrincipalAssignment.PrincipalType" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.Kusto</AssemblyName>
<AssemblyVersion>10.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="properties.principalType")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="properties.principalType")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets principal type. Possible values include: 'App',
'Group', 'User'
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ProvisioningState">
<MemberSignature Language="C#" Value="public string ProvisioningState { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string ProvisioningState" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.Kusto.Models.ClusterPrincipalAssignment.ProvisioningState" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property ProvisioningState As String" />
<MemberSignature Language="F#" Value="member this.ProvisioningState : string" Usage="Microsoft.Azure.Management.Kusto.Models.ClusterPrincipalAssignment.ProvisioningState" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.Kusto</AssemblyName>
<AssemblyVersion>10.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="properties.provisioningState")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="properties.provisioningState")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the provisioned state of the resource. Possible values
include: 'Running', 'Creating', 'Deleting', 'Succeeded', 'Failed',
'Moving'
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Role">
<MemberSignature Language="C#" Value="public string Role { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Role" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.Kusto.Models.ClusterPrincipalAssignment.Role" />
<MemberSignature Language="VB.NET" Value="Public Property Role As String" />
<MemberSignature Language="F#" Value="member this.Role : string with get, set" Usage="Microsoft.Azure.Management.Kusto.Models.ClusterPrincipalAssignment.Role" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.Kusto</AssemblyName>
<AssemblyVersion>10.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="properties.role")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="properties.role")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets cluster principal role. Possible values include:
'AllDatabasesAdmin', 'AllDatabasesViewer'
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="TenantId">
<MemberSignature Language="C#" Value="public string TenantId { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string TenantId" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.Kusto.Models.ClusterPrincipalAssignment.TenantId" />
<MemberSignature Language="VB.NET" Value="Public Property TenantId As String" />
<MemberSignature Language="F#" Value="member this.TenantId : string with get, set" Usage="Microsoft.Azure.Management.Kusto.Models.ClusterPrincipalAssignment.TenantId" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.Kusto</AssemblyName>
<AssemblyVersion>10.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="properties.tenantId")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="properties.tenantId")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the tenant id of the principal
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="TenantName">
<MemberSignature Language="C#" Value="public string TenantName { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string TenantName" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.Kusto.Models.ClusterPrincipalAssignment.TenantName" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property TenantName As String" />
<MemberSignature Language="F#" Value="member this.TenantName : string" Usage="Microsoft.Azure.Management.Kusto.Models.ClusterPrincipalAssignment.TenantName" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.Kusto</AssemblyName>
<AssemblyVersion>10.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="properties.tenantName")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="properties.tenantName")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the tenant name of the principal
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Validate">
<MemberSignature Language="C#" Value="public virtual void Validate ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Validate() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Management.Kusto.Models.ClusterPrincipalAssignment.Validate" />
<MemberSignature Language="VB.NET" Value="Public Overridable Sub Validate ()" />
<MemberSignature Language="F#" Value="abstract member Validate : unit -> unit
override this.Validate : unit -> unit" Usage="clusterPrincipalAssignment.Validate " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.Kusto</AssemblyName>
<AssemblyVersion>10.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Validate the object.
</summary>
<remarks>To be added.</remarks>
<exception cref="T:Microsoft.Rest.ValidationException">
Thrown if validation fails
</exception>
</Docs>
</Member>
</Members>
</Type>