/
OnBehalfOfCredential.xml
243 lines (243 loc) · 18.5 KB
/
OnBehalfOfCredential.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
<Type Name="OnBehalfOfCredential" FullName="Azure.Identity.OnBehalfOfCredential">
<TypeSignature Language="C#" Value="public class OnBehalfOfCredential : Azure.Core.TokenCredential" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit OnBehalfOfCredential extends Azure.Core.TokenCredential" />
<TypeSignature Language="DocId" Value="T:Azure.Identity.OnBehalfOfCredential" />
<TypeSignature Language="VB.NET" Value="Public Class OnBehalfOfCredential
Inherits TokenCredential" />
<TypeSignature Language="F#" Value="type OnBehalfOfCredential = class
 inherit TokenCredential" />
<AssemblyInfo>
<AssemblyName>Azure.Identity</AssemblyName>
<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>
<AssemblyVersion>1.10.0.0</AssemblyVersion>
<AssemblyVersion>1.10.1.0</AssemblyVersion>
<AssemblyVersion>1.10.2.0</AssemblyVersion>
<AssemblyVersion>1.10.3.0</AssemblyVersion>
<AssemblyVersion>1.10.4.0</AssemblyVersion>
<AssemblyVersion>1.11.0.0</AssemblyVersion>
<AssemblyVersion>1.11.1.0</AssemblyVersion>
<AssemblyVersion>1.11.2.0</AssemblyVersion>
<AssemblyVersion>1.11.3.0</AssemblyVersion>
<AssemblyVersion>1.12.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Azure.Core.TokenCredential</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Enables authentication to Microsoft Entra ID using an On-Behalf-Of flow.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected OnBehalfOfCredential ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Identity.OnBehalfOfCredential.#ctor" />
<MemberSignature Language="VB.NET" Value="Protected Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Identity</AssemblyName>
<AssemblyVersion>1.11.3.0</AssemblyVersion>
<AssemblyVersion>1.12.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>
Protected constructor for mocking.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public OnBehalfOfCredential (string tenantId, string clientId, System.Security.Cryptography.X509Certificates.X509Certificate2 clientCertificate, string userAssertion);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string tenantId, string clientId, class System.Security.Cryptography.X509Certificates.X509Certificate2 clientCertificate, string userAssertion) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Identity.OnBehalfOfCredential.#ctor(System.String,System.String,System.Security.Cryptography.X509Certificates.X509Certificate2,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (tenantId As String, clientId As String, clientCertificate As X509Certificate2, userAssertion As String)" />
<MemberSignature Language="F#" Value="new Azure.Identity.OnBehalfOfCredential : string * string * System.Security.Cryptography.X509Certificates.X509Certificate2 * string -> Azure.Identity.OnBehalfOfCredential" Usage="new Azure.Identity.OnBehalfOfCredential (tenantId, clientId, clientCertificate, userAssertion)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Identity</AssemblyName>
<AssemblyVersion>1.11.3.0</AssemblyVersion>
<AssemblyVersion>1.12.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="tenantId" Type="System.String" />
<Parameter Name="clientId" Type="System.String" />
<Parameter Name="clientCertificate" Type="System.Security.Cryptography.X509Certificates.X509Certificate2" />
<Parameter Name="userAssertion" Type="System.String" />
</Parameters>
<Docs>
<param name="tenantId">The Microsoft Entra tenant (directory) ID of the service principal.</param>
<param name="clientId">The client (application) ID of the service principal</param>
<param name="clientCertificate">The authentication X509 Certificate of the service principal</param>
<param name="userAssertion">The access token that will be used by <see cref="T:Azure.Identity.OnBehalfOfCredential" /> as the user assertion when requesting On-Behalf-Of tokens.</param>
<summary>
Creates an instance of the <see cref="T:Azure.Identity.OnBehalfOfCredential" /> with the details needed to authenticate against Microsoft Entra ID with the specified certificate.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public OnBehalfOfCredential (string tenantId, string clientId, string clientSecret, string userAssertion);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string tenantId, string clientId, string clientSecret, string userAssertion) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Identity.OnBehalfOfCredential.#ctor(System.String,System.String,System.String,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (tenantId As String, clientId As String, clientSecret As String, userAssertion As String)" />
<MemberSignature Language="F#" Value="new Azure.Identity.OnBehalfOfCredential : string * string * string * string -> Azure.Identity.OnBehalfOfCredential" Usage="new Azure.Identity.OnBehalfOfCredential (tenantId, clientId, clientSecret, userAssertion)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Identity</AssemblyName>
<AssemblyVersion>1.11.3.0</AssemblyVersion>
<AssemblyVersion>1.12.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="tenantId" Type="System.String" />
<Parameter Name="clientId" Type="System.String" />
<Parameter Name="clientSecret" Type="System.String" />
<Parameter Name="userAssertion" Type="System.String" />
</Parameters>
<Docs>
<param name="tenantId">The Microsoft Entra tenant (directory) ID of the service principal.</param>
<param name="clientId">The client (application) ID of the service principal</param>
<param name="clientSecret">A client secret that was generated for the App Registration used to authenticate the client.</param>
<param name="userAssertion">The access token that will be used by <see cref="T:Azure.Identity.OnBehalfOfCredential" /> as the user assertion when requesting On-Behalf-Of tokens.</param>
<summary>
Creates an instance of the <see cref="T:Azure.Identity.OnBehalfOfCredential" /> with the details needed to authenticate with Microsoft Entra ID.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public OnBehalfOfCredential (string tenantId, string clientId, System.Security.Cryptography.X509Certificates.X509Certificate2 clientCertificate, string userAssertion, Azure.Identity.OnBehalfOfCredentialOptions options);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string tenantId, string clientId, class System.Security.Cryptography.X509Certificates.X509Certificate2 clientCertificate, string userAssertion, class Azure.Identity.OnBehalfOfCredentialOptions options) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Identity.OnBehalfOfCredential.#ctor(System.String,System.String,System.Security.Cryptography.X509Certificates.X509Certificate2,System.String,Azure.Identity.OnBehalfOfCredentialOptions)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (tenantId As String, clientId As String, clientCertificate As X509Certificate2, userAssertion As String, options As OnBehalfOfCredentialOptions)" />
<MemberSignature Language="F#" Value="new Azure.Identity.OnBehalfOfCredential : string * string * System.Security.Cryptography.X509Certificates.X509Certificate2 * string * Azure.Identity.OnBehalfOfCredentialOptions -> Azure.Identity.OnBehalfOfCredential" Usage="new Azure.Identity.OnBehalfOfCredential (tenantId, clientId, clientCertificate, userAssertion, options)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Identity</AssemblyName>
<AssemblyVersion>1.11.3.0</AssemblyVersion>
<AssemblyVersion>1.12.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="tenantId" Type="System.String" />
<Parameter Name="clientId" Type="System.String" />
<Parameter Name="clientCertificate" Type="System.Security.Cryptography.X509Certificates.X509Certificate2" />
<Parameter Name="userAssertion" Type="System.String" />
<Parameter Name="options" Type="Azure.Identity.OnBehalfOfCredentialOptions" />
</Parameters>
<Docs>
<param name="tenantId">The Microsoft Entra tenant (directory) ID of the service principal.</param>
<param name="clientId">The client (application) ID of the service principal</param>
<param name="clientCertificate">The authentication X509 Certificate of the service principal</param>
<param name="userAssertion">The access token that will be used by <see cref="T:Azure.Identity.OnBehalfOfCredential" /> as the user assertion when requesting On-Behalf-Of tokens.</param>
<param name="options">Options that allow to configure the management of the requests sent to Microsoft Entra ID.</param>
<summary>
Creates an instance of the <see cref="T:Azure.Identity.OnBehalfOfCredential" /> with the details needed to authenticate against Microsoft Entra ID with the specified certificate.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public OnBehalfOfCredential (string tenantId, string clientId, string clientSecret, string userAssertion, Azure.Identity.OnBehalfOfCredentialOptions options);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string tenantId, string clientId, string clientSecret, string userAssertion, class Azure.Identity.OnBehalfOfCredentialOptions options) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Identity.OnBehalfOfCredential.#ctor(System.String,System.String,System.String,System.String,Azure.Identity.OnBehalfOfCredentialOptions)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (tenantId As String, clientId As String, clientSecret As String, userAssertion As String, options As OnBehalfOfCredentialOptions)" />
<MemberSignature Language="F#" Value="new Azure.Identity.OnBehalfOfCredential : string * string * string * string * Azure.Identity.OnBehalfOfCredentialOptions -> Azure.Identity.OnBehalfOfCredential" Usage="new Azure.Identity.OnBehalfOfCredential (tenantId, clientId, clientSecret, userAssertion, options)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Identity</AssemblyName>
<AssemblyVersion>1.11.3.0</AssemblyVersion>
<AssemblyVersion>1.12.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="tenantId" Type="System.String" />
<Parameter Name="clientId" Type="System.String" />
<Parameter Name="clientSecret" Type="System.String" />
<Parameter Name="userAssertion" Type="System.String" />
<Parameter Name="options" Type="Azure.Identity.OnBehalfOfCredentialOptions" />
</Parameters>
<Docs>
<param name="tenantId">The Microsoft Entra tenant (directory) ID of the service principal.</param>
<param name="clientId">The client (application) ID of the service principal</param>
<param name="clientSecret">A client secret that was generated for the App Registration used to authenticate the client.</param>
<param name="userAssertion">The access token that will be used by <see cref="T:Azure.Identity.OnBehalfOfCredential" /> as the user assertion when requesting On-Behalf-Of tokens.</param>
<param name="options">Options that allow to configure the management of the requests sent to Microsoft Entra ID.</param>
<summary>
Creates an instance of the <see cref="T:Azure.Identity.OnBehalfOfCredential" /> with the details needed to authenticate with Microsoft Entra ID.
</summary>
<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);" />
<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.OnBehalfOfCredential.GetToken(Azure.Core.TokenRequestContext,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function GetToken (requestContext As TokenRequestContext, cancellationToken As CancellationToken) As AccessToken" />
<MemberSignature Language="F#" Value="override this.GetToken : Azure.Core.TokenRequestContext * System.Threading.CancellationToken -> Azure.Core.AccessToken" Usage="onBehalfOfCredential.GetToken (requestContext, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Identity</AssemblyName>
<AssemblyVersion>1.11.3.0</AssemblyVersion>
<AssemblyVersion>1.12.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>
Authenticates with Microsoft Entra ID and returns an access token if successful.
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>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 override System.Threading.Tasks.ValueTask<Azure.Core.AccessToken> GetTokenAsync (Azure.Core.TokenRequestContext requestContext, System.Threading.CancellationToken cancellationToken);" />
<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.OnBehalfOfCredential.GetTokenAsync(Azure.Core.TokenRequestContext,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function GetTokenAsync (requestContext As TokenRequestContext, cancellationToken As CancellationToken) 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="onBehalfOfCredential.GetTokenAsync (requestContext, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Identity</AssemblyName>
<AssemblyVersion>1.11.3.0</AssemblyVersion>
<AssemblyVersion>1.12.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>
Authenticates with Microsoft Entra ID and returns an access token if successful.
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>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>