forked from Azure/azure-docs-sdk-dotnet
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathDeviceCodeCredential.xml
408 lines (408 loc) · 29.4 KB
/
DeviceCodeCredential.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
<Type Name="DeviceCodeCredential" FullName="Azure.Identity.DeviceCodeCredential">
<TypeSignature Language="C#" Value="public class DeviceCodeCredential : Azure.Core.TokenCredential" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit DeviceCodeCredential extends Azure.Core.TokenCredential" />
<TypeSignature Language="DocId" Value="T:Azure.Identity.DeviceCodeCredential" />
<TypeSignature Language="VB.NET" Value="Public Class DeviceCodeCredential
Inherits TokenCredential" />
<TypeSignature Language="F#" Value="type DeviceCodeCredential = class
 inherit TokenCredential" />
<AssemblyInfo>
<AssemblyName>Azure.Identity</AssemblyName>
<AssemblyVersion>1.3.0.0</AssemblyVersion>
<AssemblyVersion>1.4.0.0</AssemblyVersion>
<AssemblyVersion>1.4.1.0</AssemblyVersion>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
<AssemblyVersion>1.6.0.0</AssemblyVersion>
<AssemblyVersion>1.6.1.0</AssemblyVersion>
<AssemblyVersion>1.7.0.0</AssemblyVersion>
<AssemblyVersion>1.8.0.0</AssemblyVersion>
<AssemblyVersion>1.8.1.0</AssemblyVersion>
<AssemblyVersion>1.8.2.0</AssemblyVersion>
<AssemblyVersion>1.9.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Azure.Core.TokenCredential</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
A <see cref="T:Azure.Core.TokenCredential" /> implementation which authenticates a user using the device code flow, and provides access tokens for that user account.
For more information on the device code authentication flow see https://github.com/AzureAD/microsoft-authentication-library-for-dotnet/wiki/Device-Code-Flow.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public DeviceCodeCredential ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Identity.DeviceCodeCredential.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Identity</AssemblyName>
<AssemblyVersion>1.3.0.0</AssemblyVersion>
<AssemblyVersion>1.4.0.0</AssemblyVersion>
<AssemblyVersion>1.4.1.0</AssemblyVersion>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
<AssemblyVersion>1.6.0.0</AssemblyVersion>
<AssemblyVersion>1.6.1.0</AssemblyVersion>
<AssemblyVersion>1.7.0.0</AssemblyVersion>
<AssemblyVersion>1.8.0.0</AssemblyVersion>
<AssemblyVersion>1.8.1.0</AssemblyVersion>
<AssemblyVersion>1.8.2.0</AssemblyVersion>
<AssemblyVersion>1.9.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>
Creates a new <see cref="T:Azure.Identity.DeviceCodeCredential" />, which will authenticate users using the device code flow.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public DeviceCodeCredential (Azure.Identity.DeviceCodeCredentialOptions options);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class Azure.Identity.DeviceCodeCredentialOptions options) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Identity.DeviceCodeCredential.#ctor(Azure.Identity.DeviceCodeCredentialOptions)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (options As DeviceCodeCredentialOptions)" />
<MemberSignature Language="F#" Value="new Azure.Identity.DeviceCodeCredential : Azure.Identity.DeviceCodeCredentialOptions -> Azure.Identity.DeviceCodeCredential" Usage="new Azure.Identity.DeviceCodeCredential options" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Identity</AssemblyName>
<AssemblyVersion>1.3.0.0</AssemblyVersion>
<AssemblyVersion>1.4.0.0</AssemblyVersion>
<AssemblyVersion>1.4.1.0</AssemblyVersion>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
<AssemblyVersion>1.6.0.0</AssemblyVersion>
<AssemblyVersion>1.6.1.0</AssemblyVersion>
<AssemblyVersion>1.7.0.0</AssemblyVersion>
<AssemblyVersion>1.8.0.0</AssemblyVersion>
<AssemblyVersion>1.8.1.0</AssemblyVersion>
<AssemblyVersion>1.8.2.0</AssemblyVersion>
<AssemblyVersion>1.9.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="options" Type="Azure.Identity.DeviceCodeCredentialOptions" />
</Parameters>
<Docs>
<param name="options">The client options for the newly created <see cref="T:Azure.Identity.DeviceCodeCredential" />.</param>
<summary>
Creates a new <see cref="T:Azure.Identity.DeviceCodeCredential" /> with the specified options, which will authenticate users using the device code flow.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public DeviceCodeCredential (Func<Azure.Identity.DeviceCodeInfo,System.Threading.CancellationToken,System.Threading.Tasks.Task> deviceCodeCallback, string clientId, Azure.Identity.TokenCredentialOptions options = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Func`3<valuetype Azure.Identity.DeviceCodeInfo, valuetype System.Threading.CancellationToken, class System.Threading.Tasks.Task> deviceCodeCallback, string clientId, class Azure.Identity.TokenCredentialOptions options) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Identity.DeviceCodeCredential.#ctor(System.Func{Azure.Identity.DeviceCodeInfo,System.Threading.CancellationToken,System.Threading.Tasks.Task},System.String,Azure.Identity.TokenCredentialOptions)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (deviceCodeCallback As Func(Of DeviceCodeInfo, CancellationToken, Task), clientId As String, Optional options As TokenCredentialOptions = Nothing)" />
<MemberSignature Language="F#" Value="new Azure.Identity.DeviceCodeCredential : Func<Azure.Identity.DeviceCodeInfo, System.Threading.CancellationToken, System.Threading.Tasks.Task> * string * Azure.Identity.TokenCredentialOptions -> Azure.Identity.DeviceCodeCredential" Usage="new Azure.Identity.DeviceCodeCredential (deviceCodeCallback, clientId, options)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Identity</AssemblyName>
<AssemblyVersion>1.3.0.0</AssemblyVersion>
<AssemblyVersion>1.4.0.0</AssemblyVersion>
<AssemblyVersion>1.4.1.0</AssemblyVersion>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
<AssemblyVersion>1.6.0.0</AssemblyVersion>
<AssemblyVersion>1.6.1.0</AssemblyVersion>
<AssemblyVersion>1.7.0.0</AssemblyVersion>
<AssemblyVersion>1.8.0.0</AssemblyVersion>
<AssemblyVersion>1.8.1.0</AssemblyVersion>
<AssemblyVersion>1.8.2.0</AssemblyVersion>
<AssemblyVersion>1.9.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>]</AttributeName>
</Attribute>
</Attributes>
<Parameters>
<Parameter Name="deviceCodeCallback" Type="System.Func<Azure.Identity.DeviceCodeInfo,System.Threading.CancellationToken,System.Threading.Tasks.Task>" />
<Parameter Name="clientId" Type="System.String" />
<Parameter Name="options" Type="Azure.Identity.TokenCredentialOptions" />
</Parameters>
<Docs>
<param name="deviceCodeCallback">The callback to be executed to display the device code to the user</param>
<param name="clientId">The client id of the application to which the users will authenticate</param>
<param name="options">The client options for the newly created DeviceCodeCredential</param>
<summary>
Creates a new DeviceCodeCredential with the specified options, which will authenticate users with the specified application.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public DeviceCodeCredential (Func<Azure.Identity.DeviceCodeInfo,System.Threading.CancellationToken,System.Threading.Tasks.Task> deviceCodeCallback, string tenantId, string clientId, Azure.Identity.TokenCredentialOptions options = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Func`3<valuetype Azure.Identity.DeviceCodeInfo, valuetype System.Threading.CancellationToken, class System.Threading.Tasks.Task> deviceCodeCallback, string tenantId, string clientId, class Azure.Identity.TokenCredentialOptions options) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Identity.DeviceCodeCredential.#ctor(System.Func{Azure.Identity.DeviceCodeInfo,System.Threading.CancellationToken,System.Threading.Tasks.Task},System.String,System.String,Azure.Identity.TokenCredentialOptions)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (deviceCodeCallback As Func(Of DeviceCodeInfo, CancellationToken, Task), tenantId As String, clientId As String, Optional options As TokenCredentialOptions = Nothing)" />
<MemberSignature Language="F#" Value="new Azure.Identity.DeviceCodeCredential : Func<Azure.Identity.DeviceCodeInfo, System.Threading.CancellationToken, System.Threading.Tasks.Task> * string * string * Azure.Identity.TokenCredentialOptions -> Azure.Identity.DeviceCodeCredential" Usage="new Azure.Identity.DeviceCodeCredential (deviceCodeCallback, tenantId, clientId, options)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Identity</AssemblyName>
<AssemblyVersion>1.3.0.0</AssemblyVersion>
<AssemblyVersion>1.4.0.0</AssemblyVersion>
<AssemblyVersion>1.4.1.0</AssemblyVersion>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
<AssemblyVersion>1.6.0.0</AssemblyVersion>
<AssemblyVersion>1.6.1.0</AssemblyVersion>
<AssemblyVersion>1.7.0.0</AssemblyVersion>
<AssemblyVersion>1.8.0.0</AssemblyVersion>
<AssemblyVersion>1.8.1.0</AssemblyVersion>
<AssemblyVersion>1.8.2.0</AssemblyVersion>
<AssemblyVersion>1.9.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>]</AttributeName>
</Attribute>
</Attributes>
<Parameters>
<Parameter Name="deviceCodeCallback" Type="System.Func<Azure.Identity.DeviceCodeInfo,System.Threading.CancellationToken,System.Threading.Tasks.Task>" />
<Parameter Name="tenantId" Type="System.String" />
<Parameter Name="clientId" Type="System.String" />
<Parameter Name="options" Type="Azure.Identity.TokenCredentialOptions" />
</Parameters>
<Docs>
<param name="deviceCodeCallback">The callback to be executed to display the device code to the user</param>
<param name="tenantId">The tenant id of the application to which users will authenticate. This can be null for multi-tenanted applications.</param>
<param name="clientId">The client id of the application to which the users will authenticate</param>
<param name="options">The client options for the newly created DeviceCodeCredential</param>
<summary>
Creates a new DeviceCodeCredential with the specified options, which will authenticate users with the specified application.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Authenticate">
<MemberSignature Language="C#" Value="public virtual Azure.Identity.AuthenticationRecord Authenticate (System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Identity.AuthenticationRecord Authenticate(valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Identity.DeviceCodeCredential.Authenticate(System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function Authenticate (Optional cancellationToken As CancellationToken = Nothing) As AuthenticationRecord" />
<MemberSignature Language="F#" Value="abstract member Authenticate : System.Threading.CancellationToken -> Azure.Identity.AuthenticationRecord
override this.Authenticate : System.Threading.CancellationToken -> Azure.Identity.AuthenticationRecord" Usage="deviceCodeCredential.Authenticate cancellationToken" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Identity</AssemblyName>
<AssemblyVersion>1.3.0.0</AssemblyVersion>
<AssemblyVersion>1.4.0.0</AssemblyVersion>
<AssemblyVersion>1.4.1.0</AssemblyVersion>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
<AssemblyVersion>1.6.0.0</AssemblyVersion>
<AssemblyVersion>1.6.1.0</AssemblyVersion>
<AssemblyVersion>1.7.0.0</AssemblyVersion>
<AssemblyVersion>1.8.0.0</AssemblyVersion>
<AssemblyVersion>1.8.1.0</AssemblyVersion>
<AssemblyVersion>1.8.2.0</AssemblyVersion>
<AssemblyVersion>1.9.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Identity.AuthenticationRecord</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
<summary>
Interactively authenticates a user via the default browser.
</summary>
<returns>The result of the authentication request, containing the acquired <see cref="T:Azure.Core.AccessToken" />, and the <see cref="T:Azure.Identity.AuthenticationRecord" /> which can be used to silently authenticate the account.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Authenticate">
<MemberSignature Language="C#" Value="public virtual Azure.Identity.AuthenticationRecord Authenticate (Azure.Core.TokenRequestContext requestContext, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Identity.AuthenticationRecord Authenticate(valuetype Azure.Core.TokenRequestContext requestContext, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Identity.DeviceCodeCredential.Authenticate(Azure.Core.TokenRequestContext,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function Authenticate (requestContext As TokenRequestContext, Optional cancellationToken As CancellationToken = Nothing) As AuthenticationRecord" />
<MemberSignature Language="F#" Value="abstract member Authenticate : Azure.Core.TokenRequestContext * System.Threading.CancellationToken -> Azure.Identity.AuthenticationRecord
override this.Authenticate : Azure.Core.TokenRequestContext * System.Threading.CancellationToken -> Azure.Identity.AuthenticationRecord" Usage="deviceCodeCredential.Authenticate (requestContext, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Identity</AssemblyName>
<AssemblyVersion>1.3.0.0</AssemblyVersion>
<AssemblyVersion>1.4.0.0</AssemblyVersion>
<AssemblyVersion>1.4.1.0</AssemblyVersion>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
<AssemblyVersion>1.6.0.0</AssemblyVersion>
<AssemblyVersion>1.6.1.0</AssemblyVersion>
<AssemblyVersion>1.7.0.0</AssemblyVersion>
<AssemblyVersion>1.8.0.0</AssemblyVersion>
<AssemblyVersion>1.8.1.0</AssemblyVersion>
<AssemblyVersion>1.8.2.0</AssemblyVersion>
<AssemblyVersion>1.9.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Identity.AuthenticationRecord</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="requestContext" Type="Azure.Core.TokenRequestContext" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
<param name="requestContext">The details of the authentication request.</param>
<summary>
Interactively authenticates a user via the default browser.
</summary>
<returns>The <see cref="T:Azure.Identity.AuthenticationRecord" /> of the authenticated account.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AuthenticateAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Identity.AuthenticationRecord> AuthenticateAsync (System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Identity.AuthenticationRecord> AuthenticateAsync(valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Identity.DeviceCodeCredential.AuthenticateAsync(System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function AuthenticateAsync (Optional cancellationToken As CancellationToken = Nothing) As Task(Of AuthenticationRecord)" />
<MemberSignature Language="F#" Value="abstract member AuthenticateAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Identity.AuthenticationRecord>
override this.AuthenticateAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Identity.AuthenticationRecord>" Usage="deviceCodeCredential.AuthenticateAsync cancellationToken" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Identity</AssemblyName>
<AssemblyVersion>1.3.0.0</AssemblyVersion>
<AssemblyVersion>1.4.0.0</AssemblyVersion>
<AssemblyVersion>1.4.1.0</AssemblyVersion>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
<AssemblyVersion>1.6.0.0</AssemblyVersion>
<AssemblyVersion>1.6.1.0</AssemblyVersion>
<AssemblyVersion>1.7.0.0</AssemblyVersion>
<AssemblyVersion>1.8.0.0</AssemblyVersion>
<AssemblyVersion>1.8.1.0</AssemblyVersion>
<AssemblyVersion>1.8.2.0</AssemblyVersion>
<AssemblyVersion>1.9.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Identity.AuthenticationRecord></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
<summary>
Interactively authenticates a user via the default browser.
</summary>
<returns>The <see cref="T:Azure.Identity.AuthenticationRecord" /> which can be used to silently authenticate the account on future execution of credentials using the same persisted token cache.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AuthenticateAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Identity.AuthenticationRecord> AuthenticateAsync (Azure.Core.TokenRequestContext requestContext, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Identity.AuthenticationRecord> AuthenticateAsync(valuetype Azure.Core.TokenRequestContext requestContext, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Identity.DeviceCodeCredential.AuthenticateAsync(Azure.Core.TokenRequestContext,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function AuthenticateAsync (requestContext As TokenRequestContext, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AuthenticationRecord)" />
<MemberSignature Language="F#" Value="abstract member AuthenticateAsync : Azure.Core.TokenRequestContext * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Identity.AuthenticationRecord>
override this.AuthenticateAsync : Azure.Core.TokenRequestContext * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Identity.AuthenticationRecord>" Usage="deviceCodeCredential.AuthenticateAsync (requestContext, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Identity</AssemblyName>
<AssemblyVersion>1.3.0.0</AssemblyVersion>
<AssemblyVersion>1.4.0.0</AssemblyVersion>
<AssemblyVersion>1.4.1.0</AssemblyVersion>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
<AssemblyVersion>1.6.0.0</AssemblyVersion>
<AssemblyVersion>1.6.1.0</AssemblyVersion>
<AssemblyVersion>1.7.0.0</AssemblyVersion>
<AssemblyVersion>1.8.0.0</AssemblyVersion>
<AssemblyVersion>1.8.1.0</AssemblyVersion>
<AssemblyVersion>1.8.2.0</AssemblyVersion>
<AssemblyVersion>1.9.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Identity.AuthenticationRecord></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="requestContext" Type="Azure.Core.TokenRequestContext" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
<param name="requestContext">The details of the authentication request.</param>
<summary>
Interactively authenticates a user via the default browser.
</summary>
<returns>The <see cref="T:Azure.Identity.AuthenticationRecord" /> of the authenticated account.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetToken">
<MemberSignature Language="C#" Value="public override Azure.Core.AccessToken GetToken (Azure.Core.TokenRequestContext requestContext, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance valuetype Azure.Core.AccessToken GetToken(valuetype Azure.Core.TokenRequestContext requestContext, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Identity.DeviceCodeCredential.GetToken(Azure.Core.TokenRequestContext,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function GetToken (requestContext As TokenRequestContext, Optional cancellationToken As CancellationToken = Nothing) As AccessToken" />
<MemberSignature Language="F#" Value="override this.GetToken : Azure.Core.TokenRequestContext * System.Threading.CancellationToken -> Azure.Core.AccessToken" Usage="deviceCodeCredential.GetToken (requestContext, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Identity</AssemblyName>
<AssemblyVersion>1.3.0.0</AssemblyVersion>
<AssemblyVersion>1.4.0.0</AssemblyVersion>
<AssemblyVersion>1.4.1.0</AssemblyVersion>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
<AssemblyVersion>1.6.0.0</AssemblyVersion>
<AssemblyVersion>1.6.1.0</AssemblyVersion>
<AssemblyVersion>1.7.0.0</AssemblyVersion>
<AssemblyVersion>1.8.0.0</AssemblyVersion>
<AssemblyVersion>1.8.1.0</AssemblyVersion>
<AssemblyVersion>1.8.2.0</AssemblyVersion>
<AssemblyVersion>1.9.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Core.AccessToken</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="requestContext" Type="Azure.Core.TokenRequestContext" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="requestContext">The details of the authentication request.</param>
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
<summary>
Obtains a token for a user account, authenticating them through the device code authentication flow. Acquired tokens are cached
by the credential instance. Token lifetime and refreshing is handled automatically. Where possible, reuse credential instances
to optimize cache effectiveness.
</summary>
<returns>An <see cref="T:Azure.Core.AccessToken" /> which can be used to authenticate service client calls.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetTokenAsync">
<MemberSignature Language="C#" Value="public override System.Threading.Tasks.ValueTask<Azure.Core.AccessToken> GetTokenAsync (Azure.Core.TokenRequestContext requestContext, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance valuetype System.Threading.Tasks.ValueTask`1<valuetype Azure.Core.AccessToken> GetTokenAsync(valuetype Azure.Core.TokenRequestContext requestContext, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Identity.DeviceCodeCredential.GetTokenAsync(Azure.Core.TokenRequestContext,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function GetTokenAsync (requestContext As TokenRequestContext, Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of AccessToken)" />
<MemberSignature Language="F#" Value="override this.GetTokenAsync : Azure.Core.TokenRequestContext * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<Azure.Core.AccessToken>" Usage="deviceCodeCredential.GetTokenAsync (requestContext, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Identity</AssemblyName>
<AssemblyVersion>1.3.0.0</AssemblyVersion>
<AssemblyVersion>1.4.0.0</AssemblyVersion>
<AssemblyVersion>1.4.1.0</AssemblyVersion>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
<AssemblyVersion>1.6.0.0</AssemblyVersion>
<AssemblyVersion>1.6.1.0</AssemblyVersion>
<AssemblyVersion>1.7.0.0</AssemblyVersion>
<AssemblyVersion>1.8.0.0</AssemblyVersion>
<AssemblyVersion>1.8.1.0</AssemblyVersion>
<AssemblyVersion>1.8.2.0</AssemblyVersion>
<AssemblyVersion>1.9.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.ValueTask<Azure.Core.AccessToken></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="requestContext" Type="Azure.Core.TokenRequestContext" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="requestContext">The details of the authentication request.</param>
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
<summary>
Obtains a token for a user account, authenticating them through the device code authentication flow. Acquired tokens are cached
by the credential instance. Token lifetime and refreshing is handled automatically. Where possible, reuse credential instances
to optimize cache effectiveness.
</summary>
<returns>An <see cref="T:Azure.Core.AccessToken" /> which can be used to authenticate service client calls.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>