-
Notifications
You must be signed in to change notification settings - Fork 256
/
ClientSecretCredential.xml
202 lines (202 loc) · 14.4 KB
/
ClientSecretCredential.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
<Type Name="ClientSecretCredential" FullName="Azure.Identity.ClientSecretCredential">
<TypeSignature Language="C#" Value="public class ClientSecretCredential : Azure.Core.TokenCredential" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit ClientSecretCredential extends Azure.Core.TokenCredential" />
<TypeSignature Language="DocId" Value="T:Azure.Identity.ClientSecretCredential" />
<TypeSignature Language="VB.NET" Value="Public Class ClientSecretCredential
Inherits TokenCredential" />
<TypeSignature Language="F#" Value="type ClientSecretCredential = 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>
<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.11.4.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 a client secret that was generated for an App Registration. More information on how
to configure a client secret can be found at
<see href="https://learn.microsoft.com/entra/identity-platform/quickstart-configure-app-access-web-apis#add-credentials-to-your-web-application" />.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected ClientSecretCredential ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Identity.ClientSecretCredential.#ctor" />
<MemberSignature Language="VB.NET" Value="Protected Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Identity</AssemblyName>
<AssemblyVersion>1.12.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>
Protected constructor for <see href="https://aka.ms/azsdk/net/mocking">mocking</see>.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ClientSecretCredential (string tenantId, string clientId, string clientSecret);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string tenantId, string clientId, string clientSecret) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Identity.ClientSecretCredential.#ctor(System.String,System.String,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (tenantId As String, clientId As String, clientSecret As String)" />
<MemberSignature Language="F#" Value="new Azure.Identity.ClientSecretCredential : string * string * string -> Azure.Identity.ClientSecretCredential" Usage="new Azure.Identity.ClientSecretCredential (tenantId, clientId, clientSecret)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Identity</AssemblyName>
<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" />
</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>
<summary>
Creates an instance of the ClientSecretCredential with the details needed to authenticate against Microsoft Entra ID with a client secret.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ClientSecretCredential (string tenantId, string clientId, string clientSecret, Azure.Identity.ClientSecretCredentialOptions options);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string tenantId, string clientId, string clientSecret, class Azure.Identity.ClientSecretCredentialOptions options) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Identity.ClientSecretCredential.#ctor(System.String,System.String,System.String,Azure.Identity.ClientSecretCredentialOptions)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (tenantId As String, clientId As String, clientSecret As String, options As ClientSecretCredentialOptions)" />
<MemberSignature Language="F#" Value="new Azure.Identity.ClientSecretCredential : string * string * string * Azure.Identity.ClientSecretCredentialOptions -> Azure.Identity.ClientSecretCredential" Usage="new Azure.Identity.ClientSecretCredential (tenantId, clientId, clientSecret, options)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Identity</AssemblyName>
<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="options" Type="Azure.Identity.ClientSecretCredentialOptions" />
</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="options">Options that allow to configure the management of the requests sent to the Microsoft Entra ID.</param>
<summary>
Creates an instance of the ClientSecretCredential with the details needed to authenticate against Microsoft Entra ID with a client secret.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ClientSecretCredential (string tenantId, string clientId, string clientSecret, Azure.Identity.TokenCredentialOptions options);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string tenantId, string clientId, string clientSecret, class Azure.Identity.TokenCredentialOptions options) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Identity.ClientSecretCredential.#ctor(System.String,System.String,System.String,Azure.Identity.TokenCredentialOptions)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (tenantId As String, clientId As String, clientSecret As String, options As TokenCredentialOptions)" />
<MemberSignature Language="F#" Value="new Azure.Identity.ClientSecretCredential : string * string * string * Azure.Identity.TokenCredentialOptions -> Azure.Identity.ClientSecretCredential" Usage="new Azure.Identity.ClientSecretCredential (tenantId, clientId, clientSecret, options)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Identity</AssemblyName>
<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="options" Type="Azure.Identity.TokenCredentialOptions" />
</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="options">Options that allow to configure the management of the requests sent to Microsoft Entra ID.</param>
<summary>
Creates an instance of the ClientSecretCredential with the details needed to authenticate against Microsoft Entra ID with a client secret.
</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 = 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.ClientSecretCredential.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="clientSecretCredential.GetToken (requestContext, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Identity</AssemblyName>
<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>
Obtains a token from Microsoft Entra ID, using the specified client secret to authenticate. 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.ClientSecretCredential.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="clientSecretCredential.GetTokenAsync (requestContext, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Identity</AssemblyName>
<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>
Obtains a token from Microsoft Entra ID, using the specified client secret to authenticate. 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>