-
Notifications
You must be signed in to change notification settings - Fork 256
/
EntitiesOperationsExtensions.xml
313 lines (309 loc) · 23.3 KB
/
EntitiesOperationsExtensions.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
<Type Name="EntitiesOperationsExtensions" FullName="Microsoft.Azure.Management.ManagementGroups.EntitiesOperationsExtensions">
<TypeSignature Language="C#" Value="public static class EntitiesOperationsExtensions" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract sealed beforefieldinit EntitiesOperationsExtensions extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Management.ManagementGroups.EntitiesOperationsExtensions" />
<TypeSignature Language="VB.NET" Value="Public Module EntitiesOperationsExtensions" />
<TypeSignature Language="F#" Value="type EntitiesOperationsExtensions = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.ManagementGroups</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Extension methods for EntitiesOperations.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="List">
<MemberSignature Language="C#" Value="public static Microsoft.Rest.Azure.IPage<Microsoft.Azure.Management.ManagementGroups.Models.EntityInfo> List (this Microsoft.Azure.Management.ManagementGroups.IEntitiesOperations operations, string skiptoken = default, int? skip = default, int? top = default, string select = default, string search = default, string filter = default, string view = default, string groupName = default, string cacheControl = "no-cache");" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.Rest.Azure.IPage`1<class Microsoft.Azure.Management.ManagementGroups.Models.EntityInfo> List(class Microsoft.Azure.Management.ManagementGroups.IEntitiesOperations operations, string skiptoken, valuetype System.Nullable`1<int32> skip, valuetype System.Nullable`1<int32> top, string select, string search, string filter, string view, string groupName, string cacheControl) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Management.ManagementGroups.EntitiesOperationsExtensions.List(Microsoft.Azure.Management.ManagementGroups.IEntitiesOperations,System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.String,System.String,System.String,System.String,System.String,System.String)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function List (operations As IEntitiesOperations, Optional skiptoken As String = Nothing, Optional skip As Nullable(Of Integer) = Nothing, Optional top As Nullable(Of Integer) = Nothing, Optional select As String = Nothing, Optional search As String = Nothing, Optional filter As String = Nothing, Optional view As String = Nothing, Optional groupName As String = Nothing, Optional cacheControl As String = "no-cache") As IPage(Of EntityInfo)" />
<MemberSignature Language="F#" Value="static member List : Microsoft.Azure.Management.ManagementGroups.IEntitiesOperations * string * Nullable<int> * Nullable<int> * string * string * string * string * string * string -> Microsoft.Rest.Azure.IPage<Microsoft.Azure.Management.ManagementGroups.Models.EntityInfo>" Usage="Microsoft.Azure.Management.ManagementGroups.EntitiesOperationsExtensions.List (operations, skiptoken, skip, top, select, search, filter, view, groupName, cacheControl)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.ManagementGroups</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Rest.Azure.IPage<Microsoft.Azure.Management.ManagementGroups.Models.EntityInfo></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="operations" Type="Microsoft.Azure.Management.ManagementGroups.IEntitiesOperations" RefType="this" />
<Parameter Name="skiptoken" Type="System.String" />
<Parameter Name="skip" Type="System.Nullable<System.Int32>" />
<Parameter Name="top" Type="System.Nullable<System.Int32>" />
<Parameter Name="select" Type="System.String" />
<Parameter Name="search" Type="System.String" />
<Parameter Name="filter" Type="System.String" />
<Parameter Name="view" Type="System.String" />
<Parameter Name="groupName" Type="System.String" />
<Parameter Name="cacheControl" Type="System.String" />
</Parameters>
<Docs>
<param name="operations">
The operations group for this extension method.
</param>
<param name="skiptoken">
Page continuation token is only used if a previous operation returned a
partial result.
If a previous response contains a nextLink element, the value of the
nextLink element will include a token parameter that specifies a starting
point to use for subsequent calls.
</param>
<param name="skip">
Number of entities to skip over when retrieving results. Passing this in
will override $skipToken.
</param>
<param name="top">
Number of elements to return when retrieving results. Passing this in will
override $skipToken.
</param>
<param name="select">
This parameter specifies the fields to include in the response. Can include
any combination of
Name,DisplayName,Type,ParentDisplayNameChain,ParentChain, e.g.
'$select=Name,DisplayName,Type,ParentDisplayNameChain,ParentNameChain'.
When specified the $select parameter can override select in $skipToken.
</param>
<param name="search">
The $search parameter is used in conjunction with the $filter parameter to
return three different outputs depending on the parameter passed in.
With $search=AllowedParents the API will return the entity info of all
groups that the requested entity will be able to reparent to as determined
by the user's permissions.
With $search=AllowedChildren the API will return the entity info of all
entities that can be added as children of the requested entity.
With $search=ParentAndFirstLevelChildren the API will return the parent and
first level of children that the user has either direct access to or
indirect access via one of their descendants.
With $search=ParentOnly the API will return only the group if the user has
access to at least one of the descendants of the group.
With $search=ChildrenOnly the API will return only the first level of
children of the group entity info specified in $filter. The user must have
direct access to the children entities or one of it's descendants for it to
show up in the results. Possible values include: 'AllowedParents',
'AllowedChildren', 'ParentAndFirstLevelChildren', 'ParentOnly',
'ChildrenOnly'
</param>
<param name="filter">
The filter parameter allows you to filter on the the name or display name
fields. You can check for equality on the name field (e.g. name eq
'{entityName}') and you can check for substrings on either the name or
display name fields(e.g. contains(name, '{substringToSearch}'),
contains(displayName, '{substringToSearch')). Note that the '{entityName}'
and '{substringToSearch}' fields are checked case insensitively.
</param>
<param name="view">
The view parameter allows clients to filter the type of data that is
returned by the getEntities call. Possible values include: 'FullHierarchy',
'GroupsOnly', 'SubscriptionsOnly', 'Audit'
</param>
<param name="groupName">
A filter which allows the get entities call to focus on a particular group
(i.e. "$filter=name eq 'groupName'")
</param>
<param name="cacheControl">
Indicates whether the request should utilize any caches. Populate the
header with 'no-cache' value to bypass existing caches.
</param>
<summary>
List all entities (Management Groups, Subscriptions, etc.) for the
authenticated user.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ListAsync">
<MemberSignature Language="C#" Value="public static System.Threading.Tasks.Task<Microsoft.Rest.Azure.IPage<Microsoft.Azure.Management.ManagementGroups.Models.EntityInfo>> ListAsync (this Microsoft.Azure.Management.ManagementGroups.IEntitiesOperations operations, string skiptoken = default, int? skip = default, int? top = default, string select = default, string search = default, string filter = default, string view = default, string groupName = default, string cacheControl = "no-cache", System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Threading.Tasks.Task`1<class Microsoft.Rest.Azure.IPage`1<class Microsoft.Azure.Management.ManagementGroups.Models.EntityInfo>> ListAsync(class Microsoft.Azure.Management.ManagementGroups.IEntitiesOperations operations, string skiptoken, valuetype System.Nullable`1<int32> skip, valuetype System.Nullable`1<int32> top, string select, string search, string filter, string view, string groupName, string cacheControl, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Management.ManagementGroups.EntitiesOperationsExtensions.ListAsync(Microsoft.Azure.Management.ManagementGroups.IEntitiesOperations,System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.String,System.String,System.String,System.String,System.String,System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function ListAsync (operations As IEntitiesOperations, Optional skiptoken As String = Nothing, Optional skip As Nullable(Of Integer) = Nothing, Optional top As Nullable(Of Integer) = Nothing, Optional select As String = Nothing, Optional search As String = Nothing, Optional filter As String = Nothing, Optional view As String = Nothing, Optional groupName As String = Nothing, Optional cacheControl As String = "no-cache", Optional cancellationToken As CancellationToken = Nothing) As Task(Of IPage(Of EntityInfo))" />
<MemberSignature Language="F#" Value="static member ListAsync : Microsoft.Azure.Management.ManagementGroups.IEntitiesOperations * string * Nullable<int> * Nullable<int> * string * string * string * string * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.IPage<Microsoft.Azure.Management.ManagementGroups.Models.EntityInfo>>" Usage="Microsoft.Azure.Management.ManagementGroups.EntitiesOperationsExtensions.ListAsync (operations, skiptoken, skip, top, select, search, filter, view, groupName, cacheControl, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.ManagementGroups</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.Rest.Azure.IPage<Microsoft.Azure.Management.ManagementGroups.Models.EntityInfo>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="operations" Type="Microsoft.Azure.Management.ManagementGroups.IEntitiesOperations" RefType="this" />
<Parameter Name="skiptoken" Type="System.String" />
<Parameter Name="skip" Type="System.Nullable<System.Int32>" />
<Parameter Name="top" Type="System.Nullable<System.Int32>" />
<Parameter Name="select" Type="System.String" />
<Parameter Name="search" Type="System.String" />
<Parameter Name="filter" Type="System.String" />
<Parameter Name="view" Type="System.String" />
<Parameter Name="groupName" Type="System.String" />
<Parameter Name="cacheControl" Type="System.String" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="operations">
The operations group for this extension method.
</param>
<param name="skiptoken">
Page continuation token is only used if a previous operation returned a
partial result.
If a previous response contains a nextLink element, the value of the
nextLink element will include a token parameter that specifies a starting
point to use for subsequent calls.
</param>
<param name="skip">
Number of entities to skip over when retrieving results. Passing this in
will override $skipToken.
</param>
<param name="top">
Number of elements to return when retrieving results. Passing this in will
override $skipToken.
</param>
<param name="select">
This parameter specifies the fields to include in the response. Can include
any combination of
Name,DisplayName,Type,ParentDisplayNameChain,ParentChain, e.g.
'$select=Name,DisplayName,Type,ParentDisplayNameChain,ParentNameChain'.
When specified the $select parameter can override select in $skipToken.
</param>
<param name="search">
The $search parameter is used in conjunction with the $filter parameter to
return three different outputs depending on the parameter passed in.
With $search=AllowedParents the API will return the entity info of all
groups that the requested entity will be able to reparent to as determined
by the user's permissions.
With $search=AllowedChildren the API will return the entity info of all
entities that can be added as children of the requested entity.
With $search=ParentAndFirstLevelChildren the API will return the parent and
first level of children that the user has either direct access to or
indirect access via one of their descendants.
With $search=ParentOnly the API will return only the group if the user has
access to at least one of the descendants of the group.
With $search=ChildrenOnly the API will return only the first level of
children of the group entity info specified in $filter. The user must have
direct access to the children entities or one of it's descendants for it to
show up in the results. Possible values include: 'AllowedParents',
'AllowedChildren', 'ParentAndFirstLevelChildren', 'ParentOnly',
'ChildrenOnly'
</param>
<param name="filter">
The filter parameter allows you to filter on the the name or display name
fields. You can check for equality on the name field (e.g. name eq
'{entityName}') and you can check for substrings on either the name or
display name fields(e.g. contains(name, '{substringToSearch}'),
contains(displayName, '{substringToSearch')). Note that the '{entityName}'
and '{substringToSearch}' fields are checked case insensitively.
</param>
<param name="view">
The view parameter allows clients to filter the type of data that is
returned by the getEntities call. Possible values include: 'FullHierarchy',
'GroupsOnly', 'SubscriptionsOnly', 'Audit'
</param>
<param name="groupName">
A filter which allows the get entities call to focus on a particular group
(i.e. "$filter=name eq 'groupName'")
</param>
<param name="cacheControl">
Indicates whether the request should utilize any caches. Populate the
header with 'no-cache' value to bypass existing caches.
</param>
<param name="cancellationToken">
The cancellation token.
</param>
<summary>
List all entities (Management Groups, Subscriptions, etc.) for the
authenticated user.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ListNext">
<MemberSignature Language="C#" Value="public static Microsoft.Rest.Azure.IPage<Microsoft.Azure.Management.ManagementGroups.Models.EntityInfo> ListNext (this Microsoft.Azure.Management.ManagementGroups.IEntitiesOperations operations, string nextPageLink, string cacheControl = "no-cache");" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.Rest.Azure.IPage`1<class Microsoft.Azure.Management.ManagementGroups.Models.EntityInfo> ListNext(class Microsoft.Azure.Management.ManagementGroups.IEntitiesOperations operations, string nextPageLink, string cacheControl) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Management.ManagementGroups.EntitiesOperationsExtensions.ListNext(Microsoft.Azure.Management.ManagementGroups.IEntitiesOperations,System.String,System.String)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function ListNext (operations As IEntitiesOperations, nextPageLink As String, Optional cacheControl As String = "no-cache") As IPage(Of EntityInfo)" />
<MemberSignature Language="F#" Value="static member ListNext : Microsoft.Azure.Management.ManagementGroups.IEntitiesOperations * string * string -> Microsoft.Rest.Azure.IPage<Microsoft.Azure.Management.ManagementGroups.Models.EntityInfo>" Usage="Microsoft.Azure.Management.ManagementGroups.EntitiesOperationsExtensions.ListNext (operations, nextPageLink, cacheControl)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.ManagementGroups</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Rest.Azure.IPage<Microsoft.Azure.Management.ManagementGroups.Models.EntityInfo></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="operations" Type="Microsoft.Azure.Management.ManagementGroups.IEntitiesOperations" RefType="this" />
<Parameter Name="nextPageLink" Type="System.String" />
<Parameter Name="cacheControl" Type="System.String" />
</Parameters>
<Docs>
<param name="operations">
The operations group for this extension method.
</param>
<param name="nextPageLink">
The NextLink from the previous successful call to List operation.
</param>
<param name="cacheControl">
Indicates whether the request should utilize any caches. Populate the
header with 'no-cache' value to bypass existing caches.
</param>
<summary>
List all entities (Management Groups, Subscriptions, etc.) for the
authenticated user.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ListNextAsync">
<MemberSignature Language="C#" Value="public static System.Threading.Tasks.Task<Microsoft.Rest.Azure.IPage<Microsoft.Azure.Management.ManagementGroups.Models.EntityInfo>> ListNextAsync (this Microsoft.Azure.Management.ManagementGroups.IEntitiesOperations operations, string nextPageLink, string cacheControl = "no-cache", System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Threading.Tasks.Task`1<class Microsoft.Rest.Azure.IPage`1<class Microsoft.Azure.Management.ManagementGroups.Models.EntityInfo>> ListNextAsync(class Microsoft.Azure.Management.ManagementGroups.IEntitiesOperations operations, string nextPageLink, string cacheControl, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Management.ManagementGroups.EntitiesOperationsExtensions.ListNextAsync(Microsoft.Azure.Management.ManagementGroups.IEntitiesOperations,System.String,System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function ListNextAsync (operations As IEntitiesOperations, nextPageLink As String, Optional cacheControl As String = "no-cache", Optional cancellationToken As CancellationToken = Nothing) As Task(Of IPage(Of EntityInfo))" />
<MemberSignature Language="F#" Value="static member ListNextAsync : Microsoft.Azure.Management.ManagementGroups.IEntitiesOperations * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.IPage<Microsoft.Azure.Management.ManagementGroups.Models.EntityInfo>>" Usage="Microsoft.Azure.Management.ManagementGroups.EntitiesOperationsExtensions.ListNextAsync (operations, nextPageLink, cacheControl, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.ManagementGroups</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.Rest.Azure.IPage<Microsoft.Azure.Management.ManagementGroups.Models.EntityInfo>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="operations" Type="Microsoft.Azure.Management.ManagementGroups.IEntitiesOperations" RefType="this" />
<Parameter Name="nextPageLink" Type="System.String" />
<Parameter Name="cacheControl" Type="System.String" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="operations">
The operations group for this extension method.
</param>
<param name="nextPageLink">
The NextLink from the previous successful call to List operation.
</param>
<param name="cacheControl">
Indicates whether the request should utilize any caches. Populate the
header with 'no-cache' value to bypass existing caches.
</param>
<param name="cancellationToken">
The cancellation token.
</param>
<summary>
List all entities (Management Groups, Subscriptions, etc.) for the
authenticated user.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>