-
Notifications
You must be signed in to change notification settings - Fork 255
/
DataBoxEdgeUserCollection.xml
450 lines (450 loc) · 42.6 KB
/
DataBoxEdgeUserCollection.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
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
<Type Name="DataBoxEdgeUserCollection" FullName="Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserCollection">
<TypeSignature Language="C#" Value="public class DataBoxEdgeUserCollection : Azure.ResourceManager.ArmCollection, System.Collections.Generic.IAsyncEnumerable<Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserResource>, System.Collections.Generic.IEnumerable<Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserResource>" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit DataBoxEdgeUserCollection extends Azure.ResourceManager.ArmCollection implements class System.Collections.Generic.IAsyncEnumerable`1<class Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserResource>, class System.Collections.Generic.IEnumerable`1<class Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserResource>, class System.Collections.IEnumerable" />
<TypeSignature Language="DocId" Value="T:Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserCollection" />
<TypeSignature Language="VB.NET" Value="Public Class DataBoxEdgeUserCollection
Inherits ArmCollection
Implements IAsyncEnumerable(Of DataBoxEdgeUserResource), IEnumerable(Of DataBoxEdgeUserResource)" />
<TypeSignature Language="F#" Value="type DataBoxEdgeUserCollection = class
 inherit ArmCollection
 interface seq<DataBoxEdgeUserResource>
 interface IEnumerable
 interface IAsyncEnumerable<DataBoxEdgeUserResource>" />
<AssemblyInfo>
<AssemblyName>Azure.ResourceManager.DataBoxEdge</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.0.1.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Azure.ResourceManager.ArmCollection</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>System.Collections.Generic.IAsyncEnumerable<Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserResource></InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.Collections.Generic.IEnumerable<Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserResource></InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.Collections.IEnumerable</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<summary>
A class representing a collection of <see cref="T:Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserResource" /> and their operations.
Each <see cref="T:Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserResource" /> in the collection will belong to the same instance of <see cref="T:Azure.ResourceManager.DataBoxEdge.DataBoxEdgeDeviceResource" />.
To get a <see cref="T:Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserCollection" /> instance call the GetDataBoxEdgeUsers method from an instance of <see cref="T:Azure.ResourceManager.DataBoxEdge.DataBoxEdgeDeviceResource" />.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected DataBoxEdgeUserCollection ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserCollection.#ctor" />
<MemberSignature Language="VB.NET" Value="Protected Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.ResourceManager.DataBoxEdge</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary> Initializes a new instance of the <see cref="T:Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserCollection" /> class for mocking. </summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CreateOrUpdate">
<MemberSignature Language="C#" Value="public virtual Azure.ResourceManager.ArmOperation<Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserResource> CreateOrUpdate (Azure.WaitUntil waitUntil, string name, Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserData data, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.ResourceManager.ArmOperation`1<class Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserResource> CreateOrUpdate(valuetype Azure.WaitUntil waitUntil, string name, class Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserData data, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserCollection.CreateOrUpdate(Azure.WaitUntil,System.String,Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserData,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function CreateOrUpdate (waitUntil As WaitUntil, name As String, data As DataBoxEdgeUserData, Optional cancellationToken As CancellationToken = Nothing) As ArmOperation(Of DataBoxEdgeUserResource)" />
<MemberSignature Language="F#" Value="abstract member CreateOrUpdate : Azure.WaitUntil * string * Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserData * System.Threading.CancellationToken -> Azure.ResourceManager.ArmOperation<Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserResource>
override this.CreateOrUpdate : Azure.WaitUntil * string * Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserData * System.Threading.CancellationToken -> Azure.ResourceManager.ArmOperation<Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserResource>" Usage="dataBoxEdgeUserCollection.CreateOrUpdate (waitUntil, name, data, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.ResourceManager.DataBoxEdge</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.ResourceManager.ArmOperation<Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserResource></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="waitUntil" Type="Azure.WaitUntil" />
<Parameter Name="name" Type="System.String" />
<Parameter Name="data" Type="Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserData" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="waitUntil">
<see cref="F:Azure.WaitUntil.Completed" /> if the method should wait to return until the long-running operation has completed on the service; <see cref="F:Azure.WaitUntil.Started" /> if it should return after starting the operation. For more information on long-running operations, please see <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/LongRunningOperations.md"> Azure.Core Long-Running Operation samples</see>. </param>
<param name="name"> The user name. </param>
<param name="data"> The user details. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary>
Creates a new user or updates an existing user's information on a Data Box Edge/Data Box Gateway device.
<list type="bullet"><item><term>Request Path</term><description>/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/users/{name}</description></item><item><term>Operation Id</term><description>Users_CreateOrUpdate</description></item></list></summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentException">
<paramref name="name" /> is an empty string, and was expected to be non-empty. </exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="name" /> or <paramref name="data" /> is null. </exception>
</Docs>
</Member>
<Member MemberName="CreateOrUpdateAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserResource>> CreateOrUpdateAsync (Azure.WaitUntil waitUntil, string name, Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserData data, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.ResourceManager.ArmOperation`1<class Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserResource>> CreateOrUpdateAsync(valuetype Azure.WaitUntil waitUntil, string name, class Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserData data, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserCollection.CreateOrUpdateAsync(Azure.WaitUntil,System.String,Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserData,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function CreateOrUpdateAsync (waitUntil As WaitUntil, name As String, data As DataBoxEdgeUserData, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ArmOperation(Of DataBoxEdgeUserResource))" />
<MemberSignature Language="F#" Value="abstract member CreateOrUpdateAsync : Azure.WaitUntil * string * Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserData * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserResource>>
override this.CreateOrUpdateAsync : Azure.WaitUntil * string * Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserData * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserResource>>" Usage="dataBoxEdgeUserCollection.CreateOrUpdateAsync (waitUntil, name, data, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.ResourceManager.DataBoxEdge</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserResource>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="waitUntil" Type="Azure.WaitUntil" />
<Parameter Name="name" Type="System.String" />
<Parameter Name="data" Type="Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserData" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="waitUntil">
<see cref="F:Azure.WaitUntil.Completed" /> if the method should wait to return until the long-running operation has completed on the service; <see cref="F:Azure.WaitUntil.Started" /> if it should return after starting the operation. For more information on long-running operations, please see <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/LongRunningOperations.md"> Azure.Core Long-Running Operation samples</see>. </param>
<param name="name"> The user name. </param>
<param name="data"> The user details. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary>
Creates a new user or updates an existing user's information on a Data Box Edge/Data Box Gateway device.
<list type="bullet"><item><term>Request Path</term><description>/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/users/{name}</description></item><item><term>Operation Id</term><description>Users_CreateOrUpdate</description></item></list></summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentException">
<paramref name="name" /> is an empty string, and was expected to be non-empty. </exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="name" /> or <paramref name="data" /> is null. </exception>
</Docs>
</Member>
<Member MemberName="Exists">
<MemberSignature Language="C#" Value="public virtual Azure.Response<bool> Exists (string name, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<bool> Exists(string name, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserCollection.Exists(System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function Exists (name As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of Boolean)" />
<MemberSignature Language="F#" Value="abstract member Exists : string * System.Threading.CancellationToken -> Azure.Response<bool>
override this.Exists : string * System.Threading.CancellationToken -> Azure.Response<bool>" Usage="dataBoxEdgeUserCollection.Exists (name, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.ResourceManager.DataBoxEdge</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Response<System.Boolean></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="name" Type="System.String" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="name"> The user name. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary>
Checks to see if the resource exists in azure.
<list type="bullet"><item><term>Request Path</term><description>/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/users/{name}</description></item><item><term>Operation Id</term><description>Users_Get</description></item></list></summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentException">
<paramref name="name" /> is an empty string, and was expected to be non-empty. </exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="name" /> is null. </exception>
</Docs>
</Member>
<Member MemberName="ExistsAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<bool>> ExistsAsync (string name, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response`1<bool>> ExistsAsync(string name, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserCollection.ExistsAsync(System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function ExistsAsync (name As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of Boolean))" />
<MemberSignature Language="F#" Value="abstract member ExistsAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<bool>>
override this.ExistsAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<bool>>" Usage="dataBoxEdgeUserCollection.ExistsAsync (name, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.ResourceManager.DataBoxEdge</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Response<System.Boolean>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="name" Type="System.String" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="name"> The user name. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary>
Checks to see if the resource exists in azure.
<list type="bullet"><item><term>Request Path</term><description>/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/users/{name}</description></item><item><term>Operation Id</term><description>Users_Get</description></item></list></summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentException">
<paramref name="name" /> is an empty string, and was expected to be non-empty. </exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="name" /> is null. </exception>
</Docs>
</Member>
<Member MemberName="Get">
<MemberSignature Language="C#" Value="public virtual Azure.Response<Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserResource> Get (string name, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserResource> Get(string name, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserCollection.Get(System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function Get (name As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of DataBoxEdgeUserResource)" />
<MemberSignature Language="F#" Value="abstract member Get : string * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserResource>
override this.Get : string * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserResource>" Usage="dataBoxEdgeUserCollection.Get (name, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.ResourceManager.DataBoxEdge</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Response<Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserResource></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="name" Type="System.String" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="name"> The user name. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary>
Gets the properties of the specified user.
<list type="bullet"><item><term>Request Path</term><description>/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/users/{name}</description></item><item><term>Operation Id</term><description>Users_Get</description></item></list></summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentException">
<paramref name="name" /> is an empty string, and was expected to be non-empty. </exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="name" /> is null. </exception>
</Docs>
</Member>
<Member MemberName="GetAll">
<MemberSignature Language="C#" Value="public virtual Azure.Pageable<Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserResource> GetAll (string filter = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Pageable`1<class Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserResource> GetAll(string filter, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserCollection.GetAll(System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetAll (Optional filter As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Pageable(Of DataBoxEdgeUserResource)" />
<MemberSignature Language="F#" Value="abstract member GetAll : string * System.Threading.CancellationToken -> Azure.Pageable<Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserResource>
override this.GetAll : string * System.Threading.CancellationToken -> Azure.Pageable<Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserResource>" Usage="dataBoxEdgeUserCollection.GetAll (filter, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.ResourceManager.DataBoxEdge</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Pageable<Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserResource></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="filter" Type="System.String" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="filter"> Specify $filter='Type eq <type>' to filter on user type property. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary>
Gets all the users registered on a Data Box Edge/Data Box Gateway device.
<list type="bullet"><item><term>Request Path</term><description>/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/users</description></item><item><term>Operation Id</term><description>Users_ListByDataBoxEdgeDevice</description></item></list></summary>
<returns> A collection of <see cref="T:Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserResource" /> that may take multiple service requests to iterate over. </returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetAllAsync">
<MemberSignature Language="C#" Value="public virtual Azure.AsyncPageable<Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserResource> GetAllAsync (string filter = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AsyncPageable`1<class Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserResource> GetAllAsync(string filter, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserCollection.GetAllAsync(System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetAllAsync (Optional filter As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of DataBoxEdgeUserResource)" />
<MemberSignature Language="F#" Value="abstract member GetAllAsync : string * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserResource>
override this.GetAllAsync : string * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserResource>" Usage="dataBoxEdgeUserCollection.GetAllAsync (filter, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.ResourceManager.DataBoxEdge</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.AsyncPageable<Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserResource></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="filter" Type="System.String" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="filter"> Specify $filter='Type eq <type>' to filter on user type property. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary>
Gets all the users registered on a Data Box Edge/Data Box Gateway device.
<list type="bullet"><item><term>Request Path</term><description>/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/users</description></item><item><term>Operation Id</term><description>Users_ListByDataBoxEdgeDevice</description></item></list></summary>
<returns> An async collection of <see cref="T:Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserResource" /> that may take multiple service requests to iterate over. </returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserResource>> GetAsync (string name, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response`1<class Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserResource>> GetAsync(string name, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserCollection.GetAsync(System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetAsync (name As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of DataBoxEdgeUserResource))" />
<MemberSignature Language="F#" Value="abstract member GetAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserResource>>
override this.GetAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserResource>>" Usage="dataBoxEdgeUserCollection.GetAsync (name, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.ResourceManager.DataBoxEdge</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserResource>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="name" Type="System.String" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="name"> The user name. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary>
Gets the properties of the specified user.
<list type="bullet"><item><term>Request Path</term><description>/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/users/{name}</description></item><item><term>Operation Id</term><description>Users_Get</description></item></list></summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentException">
<paramref name="name" /> is an empty string, and was expected to be non-empty. </exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="name" /> is null. </exception>
</Docs>
</Member>
<Member MemberName="GetIfExists">
<MemberSignature Language="C#" Value="public virtual Azure.NullableResponse<Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserResource> GetIfExists (string name, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.NullableResponse`1<class Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserResource> GetIfExists(string name, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserCollection.GetIfExists(System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetIfExists (name As String, Optional cancellationToken As CancellationToken = Nothing) As NullableResponse(Of DataBoxEdgeUserResource)" />
<MemberSignature Language="F#" Value="abstract member GetIfExists : string * System.Threading.CancellationToken -> Azure.NullableResponse<Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserResource>
override this.GetIfExists : string * System.Threading.CancellationToken -> Azure.NullableResponse<Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserResource>" Usage="dataBoxEdgeUserCollection.GetIfExists (name, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.ResourceManager.DataBoxEdge</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.NullableResponse<Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserResource></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="name" Type="System.String" Index="0" FrameworkAlternate="azure-dotnet" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="1" FrameworkAlternate="azure-dotnet" />
</Parameters>
<Docs>
<param name="name"> The user name. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary>
Tries to get details for this resource from the service.
<list type="bullet"><item><term>Request Path</term><description>/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/users/{name}</description></item><item><term>Operation Id</term><description>Users_Get</description></item></list></summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentException">
<paramref name="name" /> is an empty string, and was expected to be non-empty. </exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="name" /> is null. </exception>
</Docs>
</Member>
<Member MemberName="GetIfExistsAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.NullableResponse<Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserResource>> GetIfExistsAsync (string name, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.NullableResponse`1<class Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserResource>> GetIfExistsAsync(string name, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserCollection.GetIfExistsAsync(System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetIfExistsAsync (name As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of NullableResponse(Of DataBoxEdgeUserResource))" />
<MemberSignature Language="F#" Value="abstract member GetIfExistsAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.NullableResponse<Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserResource>>
override this.GetIfExistsAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.NullableResponse<Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserResource>>" Usage="dataBoxEdgeUserCollection.GetIfExistsAsync (name, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.ResourceManager.DataBoxEdge</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.NullableResponse<Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserResource>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="name" Type="System.String" Index="0" FrameworkAlternate="azure-dotnet" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="1" FrameworkAlternate="azure-dotnet" />
</Parameters>
<Docs>
<param name="name"> The user name. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary>
Tries to get details for this resource from the service.
<list type="bullet"><item><term>Request Path</term><description>/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/users/{name}</description></item><item><term>Operation Id</term><description>Users_Get</description></item></list></summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentException">
<paramref name="name" /> is an empty string, and was expected to be non-empty. </exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="name" /> is null. </exception>
</Docs>
</Member>
<Member MemberName="System.Collections.Generic.IAsyncEnumerable<Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserResource>.GetAsyncEnumerator">
<MemberSignature Language="C#" Value="System.Collections.Generic.IAsyncEnumerator<Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserResource> IAsyncEnumerable<DataBoxEdgeUserResource>.GetAsyncEnumerator (System.Threading.CancellationToken cancellationToken);" />
<MemberSignature Language="ILAsm" Value=".method hidebysig newslot virtual instance class System.Collections.Generic.IAsyncEnumerator`1<class Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserResource> System.Collections.Generic.IAsyncEnumerable<Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserResource>.GetAsyncEnumerator(valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserCollection.System#Collections#Generic#IAsyncEnumerable<Azure#ResourceManager#DataBoxEdge#DataBoxEdgeUserResource>#GetAsyncEnumerator(System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Function GetAsyncEnumerator (cancellationToken As CancellationToken) As IAsyncEnumerator(Of DataBoxEdgeUserResource) Implements IAsyncEnumerable(Of DataBoxEdgeUserResource).GetAsyncEnumerator" />
<MemberSignature Language="F#" Value="abstract member System.Collections.Generic.IAsyncEnumerable<Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserResource>.GetAsyncEnumerator : System.Threading.CancellationToken -> System.Collections.Generic.IAsyncEnumerator<Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserResource>
override this.System.Collections.Generic.IAsyncEnumerable<Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserResource>.GetAsyncEnumerator : System.Threading.CancellationToken -> System.Collections.Generic.IAsyncEnumerator<Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserResource>" Usage="dataBoxEdgeUserCollection.System.Collections.Generic.IAsyncEnumerable<Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserResource>.GetAsyncEnumerator cancellationToken" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:System.Collections.Generic.IAsyncEnumerable`1.GetAsyncEnumerator(System.Threading.CancellationToken)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Azure.ResourceManager.DataBoxEdge</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IAsyncEnumerator<Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserResource></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> that may be used to cancel the asynchronous iteration.</param>
<summary>Returns an enumerator that iterates asynchronously through the collection.</summary>
<returns>An enumerator that can be used to iterate asynchronously through the collection.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="System.Collections.Generic.IEnumerable<Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserResource>.GetEnumerator">
<MemberSignature Language="C#" Value="System.Collections.Generic.IEnumerator<Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserResource> IEnumerable<DataBoxEdgeUserResource>.GetEnumerator ();" />
<MemberSignature Language="ILAsm" Value=".method hidebysig newslot virtual instance class System.Collections.Generic.IEnumerator`1<class Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserResource> System.Collections.Generic.IEnumerable<Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserResource>.GetEnumerator() cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserCollection.System#Collections#Generic#IEnumerable<Azure#ResourceManager#DataBoxEdge#DataBoxEdgeUserResource>#GetEnumerator" />
<MemberSignature Language="VB.NET" Value="Function GetEnumerator () As IEnumerator(Of DataBoxEdgeUserResource) Implements IEnumerable(Of DataBoxEdgeUserResource).GetEnumerator" />
<MemberSignature Language="F#" Value="abstract member System.Collections.Generic.IEnumerable<Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserResource>.GetEnumerator : unit -> System.Collections.Generic.IEnumerator<Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserResource>
override this.System.Collections.Generic.IEnumerable<Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserResource>.GetEnumerator : unit -> System.Collections.Generic.IEnumerator<Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserResource>" Usage="dataBoxEdgeUserCollection.System.Collections.Generic.IEnumerable<Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserResource>.GetEnumerator " />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:System.Collections.Generic.IEnumerable`1.GetEnumerator</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Azure.ResourceManager.DataBoxEdge</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IEnumerator<Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserResource></ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Returns an enumerator that iterates through the collection.</summary>
<returns>An enumerator that can be used to iterate through the collection.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="System.Collections.IEnumerable.GetEnumerator">
<MemberSignature Language="C#" Value="System.Collections.IEnumerator IEnumerable.GetEnumerator ();" />
<MemberSignature Language="ILAsm" Value=".method hidebysig newslot virtual instance class System.Collections.IEnumerator System.Collections.IEnumerable.GetEnumerator() cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.ResourceManager.DataBoxEdge.DataBoxEdgeUserCollection.System#Collections#IEnumerable#GetEnumerator" />
<MemberSignature Language="VB.NET" Value="Function GetEnumerator () As IEnumerator Implements IEnumerable.GetEnumerator" />
<MemberSignature Language="F#" Value="abstract member System.Collections.IEnumerable.GetEnumerator : unit -> System.Collections.IEnumerator
override this.System.Collections.IEnumerable.GetEnumerator : unit -> System.Collections.IEnumerator" Usage="dataBoxEdgeUserCollection.System.Collections.IEnumerable.GetEnumerator " />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:System.Collections.IEnumerable.GetEnumerator</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Azure.ResourceManager.DataBoxEdge</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.IEnumerator</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Returns an enumerator that iterates through a collection.</summary>
<returns>An <see cref="T:System.Collections.IEnumerator" /> object that can be used to iterate through the collection.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>