/
RoleAssignmentArtifact.xml
293 lines (293 loc) · 16.6 KB
/
RoleAssignmentArtifact.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
<Type Name="RoleAssignmentArtifact" FullName="Microsoft.Azure.Management.Blueprint.Models.RoleAssignmentArtifact">
<TypeSignature Language="C#" Value="public class RoleAssignmentArtifact : Microsoft.Azure.Management.Blueprint.Models.Artifact" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit RoleAssignmentArtifact extends Microsoft.Azure.Management.Blueprint.Models.Artifact" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Management.Blueprint.Models.RoleAssignmentArtifact" />
<TypeSignature Language="VB.NET" Value="Public Class RoleAssignmentArtifact
Inherits Artifact" />
<TypeSignature Language="F#" Value="type RoleAssignmentArtifact = class
 inherit Artifact" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.Blueprint</AssemblyName>
<AssemblyVersion>0.10.0.0</AssemblyVersion>
<AssemblyVersion>0.20.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Microsoft.Azure.Management.Blueprint.Models.Artifact</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("roleAssignment")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonObject("roleAssignment")>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>
Blueprint artifact that applies a Role assignment.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public RoleAssignmentArtifact ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Management.Blueprint.Models.RoleAssignmentArtifact.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.Blueprint</AssemblyName>
<AssemblyVersion>0.20.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>
Initializes a new instance of the RoleAssignmentArtifact class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public RoleAssignmentArtifact (string roleDefinitionId, object principalIds, string id = default, string type = default, string name = default, string displayName = default, string description = default, System.Collections.Generic.IList<string> dependsOn = default, string resourceGroup = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string roleDefinitionId, object principalIds, string id, string type, string name, string displayName, string description, class System.Collections.Generic.IList`1<string> dependsOn, string resourceGroup) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Management.Blueprint.Models.RoleAssignmentArtifact.#ctor(System.String,System.Object,System.String,System.String,System.String,System.String,System.String,System.Collections.Generic.IList{System.String},System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (roleDefinitionId As String, principalIds As Object, Optional id As String = Nothing, Optional type As String = Nothing, Optional name As String = Nothing, Optional displayName As String = Nothing, Optional description As String = Nothing, Optional dependsOn As IList(Of String) = Nothing, Optional resourceGroup As String = Nothing)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.Management.Blueprint.Models.RoleAssignmentArtifact : string * obj * string * string * string * string * string * System.Collections.Generic.IList<string> * string -> Microsoft.Azure.Management.Blueprint.Models.RoleAssignmentArtifact" Usage="new Microsoft.Azure.Management.Blueprint.Models.RoleAssignmentArtifact (roleDefinitionId, principalIds, id, type, name, displayName, description, dependsOn, resourceGroup)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.Blueprint</AssemblyName>
<AssemblyVersion>0.20.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="roleDefinitionId" Type="System.String" />
<Parameter Name="principalIds" Type="System.Object" />
<Parameter Name="id" Type="System.String" />
<Parameter Name="type" Type="System.String" />
<Parameter Name="name" Type="System.String" />
<Parameter Name="displayName" Type="System.String" />
<Parameter Name="description" Type="System.String" />
<Parameter Name="dependsOn" Type="System.Collections.Generic.IList<System.String>" />
<Parameter Name="resourceGroup" Type="System.String" />
</Parameters>
<Docs>
<param name="roleDefinitionId">Azure resource ID of the
RoleDefinition.</param>
<param name="principalIds">Array of user or group identities in
Azure Active Directory. The roleDefinition will apply to each
identity.</param>
<param name="id">String Id used to locate any resource on
Azure.</param>
<param name="type">Type of this resource.</param>
<param name="name">Name of this resource.</param>
<param name="displayName">One-liner string explain this
resource.</param>
<param name="description">Multi-line explain this resource.</param>
<param name="dependsOn">Artifacts which need to be deployed before
the specified artifact.</param>
<param name="resourceGroup">RoleAssignment will be scope to this
resourceGroup. If empty, it scopes to the subscription.</param>
<summary>
Initializes a new instance of the RoleAssignmentArtifact class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="DependsOn">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IList<string> DependsOn { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1<string> DependsOn" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.Blueprint.Models.RoleAssignmentArtifact.DependsOn" />
<MemberSignature Language="VB.NET" Value="Public Property DependsOn As IList(Of String)" />
<MemberSignature Language="F#" Value="member this.DependsOn : System.Collections.Generic.IList<string> with get, set" Usage="Microsoft.Azure.Management.Blueprint.Models.RoleAssignmentArtifact.DependsOn" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.Blueprint</AssemblyName>
<AssemblyVersion>0.20.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="properties.dependsOn")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="properties.dependsOn")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Collections.Generic.IList<System.String></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets artifacts which need to be deployed before the
specified artifact.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Description">
<MemberSignature Language="C#" Value="public string Description { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Description" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.Blueprint.Models.RoleAssignmentArtifact.Description" />
<MemberSignature Language="VB.NET" Value="Public Property Description As String" />
<MemberSignature Language="F#" Value="member this.Description : string with get, set" Usage="Microsoft.Azure.Management.Blueprint.Models.RoleAssignmentArtifact.Description" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.Blueprint</AssemblyName>
<AssemblyVersion>0.20.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="properties.description")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="properties.description")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets multi-line explain this resource.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="DisplayName">
<MemberSignature Language="C#" Value="public string DisplayName { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string DisplayName" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.Blueprint.Models.RoleAssignmentArtifact.DisplayName" />
<MemberSignature Language="VB.NET" Value="Public Property DisplayName As String" />
<MemberSignature Language="F#" Value="member this.DisplayName : string with get, set" Usage="Microsoft.Azure.Management.Blueprint.Models.RoleAssignmentArtifact.DisplayName" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.Blueprint</AssemblyName>
<AssemblyVersion>0.20.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="properties.displayName")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="properties.displayName")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets one-liner string explain this resource.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="PrincipalIds">
<MemberSignature Language="C#" Value="public object PrincipalIds { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance object PrincipalIds" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.Blueprint.Models.RoleAssignmentArtifact.PrincipalIds" />
<MemberSignature Language="VB.NET" Value="Public Property PrincipalIds As Object" />
<MemberSignature Language="F#" Value="member this.PrincipalIds : obj with get, set" Usage="Microsoft.Azure.Management.Blueprint.Models.RoleAssignmentArtifact.PrincipalIds" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.Blueprint</AssemblyName>
<AssemblyVersion>0.20.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="properties.principalIds")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="properties.principalIds")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets array of user or group identities in Azure Active
Directory. The roleDefinition will apply to each identity.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ResourceGroup">
<MemberSignature Language="C#" Value="public string ResourceGroup { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string ResourceGroup" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.Blueprint.Models.RoleAssignmentArtifact.ResourceGroup" />
<MemberSignature Language="VB.NET" Value="Public Property ResourceGroup As String" />
<MemberSignature Language="F#" Value="member this.ResourceGroup : string with get, set" Usage="Microsoft.Azure.Management.Blueprint.Models.RoleAssignmentArtifact.ResourceGroup" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.Blueprint</AssemblyName>
<AssemblyVersion>0.20.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="properties.resourceGroup")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="properties.resourceGroup")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets roleAssignment will be scope to this resourceGroup. If
empty, it scopes to the subscription.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="RoleDefinitionId">
<MemberSignature Language="C#" Value="public string RoleDefinitionId { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string RoleDefinitionId" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.Blueprint.Models.RoleAssignmentArtifact.RoleDefinitionId" />
<MemberSignature Language="VB.NET" Value="Public Property RoleDefinitionId As String" />
<MemberSignature Language="F#" Value="member this.RoleDefinitionId : string with get, set" Usage="Microsoft.Azure.Management.Blueprint.Models.RoleAssignmentArtifact.RoleDefinitionId" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.Blueprint</AssemblyName>
<AssemblyVersion>0.20.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="properties.roleDefinitionId")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="properties.roleDefinitionId")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets azure resource ID of the RoleDefinition.
</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.Blueprint.Models.RoleAssignmentArtifact.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="roleAssignmentArtifact.Validate " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.Blueprint</AssemblyName>
<AssemblyVersion>0.20.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>