-
Notifications
You must be signed in to change notification settings - Fork 268
/
TokenCredential.xml
127 lines (127 loc) · 7.8 KB
/
TokenCredential.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
<Type Name="TokenCredential" FullName="Azure.Core.TokenCredential">
<TypeSignature Language="C#" Value="public abstract class TokenCredential" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit TokenCredential extends System.Object" />
<TypeSignature Language="DocId" Value="T:Azure.Core.TokenCredential" />
<TypeSignature Language="VB.NET" Value="Public MustInherit Class TokenCredential" />
<TypeSignature Language="F#" Value="type TokenCredential = class" />
<AssemblyInfo>
<AssemblyName>Azure.Core</AssemblyName>
<AssemblyVersion>1.13.0.0</AssemblyVersion>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
<AssemblyVersion>1.15.0.0</AssemblyVersion>
<AssemblyVersion>1.16.0.0</AssemblyVersion>
<AssemblyVersion>1.17.0.0</AssemblyVersion>
<AssemblyVersion>1.18.0.0</AssemblyVersion>
<AssemblyVersion>1.19.0.0</AssemblyVersion>
<AssemblyVersion>1.20.0.0</AssemblyVersion>
<AssemblyVersion>1.21.0.0</AssemblyVersion>
<AssemblyVersion>1.22.0.0</AssemblyVersion>
<AssemblyVersion>1.23.0.0</AssemblyVersion>
<AssemblyVersion>1.24.0.0</AssemblyVersion>
<AssemblyVersion>1.25.0.0</AssemblyVersion>
<AssemblyVersion>1.26.0.0</AssemblyVersion>
<AssemblyVersion>1.27.0.0</AssemblyVersion>
<AssemblyVersion>1.28.0.0</AssemblyVersion>
<AssemblyVersion>1.29.0.0</AssemblyVersion>
<AssemblyVersion>1.30.0.0</AssemblyVersion>
<AssemblyVersion>1.31.0.0</AssemblyVersion>
<AssemblyVersion>1.32.0.0</AssemblyVersion>
<AssemblyVersion>1.33.0.0</AssemblyVersion>
<AssemblyVersion>1.34.0.0</AssemblyVersion>
<AssemblyVersion>1.35.0.0</AssemblyVersion>
<AssemblyVersion>1.36.0.0</AssemblyVersion>
<AssemblyVersion>1.37.0.0</AssemblyVersion>
<AssemblyVersion>1.38.0.0</AssemblyVersion>
<AssemblyVersion>1.39.0.0</AssemblyVersion>
<AssemblyVersion>1.40.0.0</AssemblyVersion>
<AssemblyVersion>1.41.0.0</AssemblyVersion>
<AssemblyVersion>1.42.0.0</AssemblyVersion>
<AssemblyVersion>1.43.0.0</AssemblyVersion>
<AssemblyVersion>1.44.0.0</AssemblyVersion>
<AssemblyVersion>1.44.1.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Represents a credential capable of providing an OAuth token.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected TokenCredential ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Core.TokenCredential.#ctor" />
<MemberSignature Language="VB.NET" Value="Protected Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Core</AssemblyName>
<AssemblyVersion>1.44.1.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetToken">
<MemberSignature Language="C#" Value="public abstract Azure.Core.AccessToken GetToken (Azure.Core.TokenRequestContext requestContext, System.Threading.CancellationToken cancellationToken);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot 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.Core.TokenCredential.GetToken(Azure.Core.TokenRequestContext,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public MustOverride Function GetToken (requestContext As TokenRequestContext, cancellationToken As CancellationToken) As AccessToken" />
<MemberSignature Language="F#" Value="abstract member GetToken : Azure.Core.TokenRequestContext * System.Threading.CancellationToken -> Azure.Core.AccessToken" Usage="tokenCredential.GetToken (requestContext, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Core</AssemblyName>
<AssemblyVersion>1.44.1.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 <see cref="T:Azure.Core.TokenRequestContext" /> with authentication information.</param>
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken" /> to use.</param>
<summary>
Gets an <see cref="T:Azure.Core.AccessToken" /> for the specified set of scopes.
</summary>
<returns>A valid <see cref="T:Azure.Core.AccessToken" />.</returns>
<remarks>Caching and management of the lifespan for the <see cref="T:Azure.Core.AccessToken" /> is considered the responsibility of the caller: each call should request a fresh token being requested.</remarks>
</Docs>
</Member>
<Member MemberName="GetTokenAsync">
<MemberSignature Language="C#" Value="public abstract System.Threading.Tasks.ValueTask<Azure.Core.AccessToken> GetTokenAsync (Azure.Core.TokenRequestContext requestContext, System.Threading.CancellationToken cancellationToken);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot 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.Core.TokenCredential.GetTokenAsync(Azure.Core.TokenRequestContext,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public MustOverride Function GetTokenAsync (requestContext As TokenRequestContext, cancellationToken As CancellationToken) As ValueTask(Of AccessToken)" />
<MemberSignature Language="F#" Value="abstract member GetTokenAsync : Azure.Core.TokenRequestContext * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<Azure.Core.AccessToken>" Usage="tokenCredential.GetTokenAsync (requestContext, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Core</AssemblyName>
<AssemblyVersion>1.44.1.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 <see cref="T:Azure.Core.TokenRequestContext" /> with authentication information.</param>
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken" /> to use.</param>
<summary>
Gets an <see cref="T:Azure.Core.AccessToken" /> for the specified set of scopes.
</summary>
<returns>A valid <see cref="T:Azure.Core.AccessToken" />.</returns>
<remarks>Caching and management of the lifespan for the <see cref="T:Azure.Core.AccessToken" /> is considered the responsibility of the caller: each call should request a fresh token being requested.</remarks>
</Docs>
</Member>
</Members>
</Type>