forked from dotnet/SqlClient
/
AzureManagedIdentityAuthenticationProvider.xml
45 lines (42 loc) · 2.08 KB
/
AzureManagedIdentityAuthenticationProvider.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
<docs>
<members name="AzureManagedIdentityAuthenticationProvider">
<AzureManagedIdentityAuthenticationProvider>
<summary>
This class implements <see cref="T:Microsoft.Data.SqlClient.SqlAuthenticationProvider" /> and provides active directory managed identity authentication support.
</summary>
</AzureManagedIdentityAuthenticationProvider>
<ctor>
<param name="retryTimeoutInSeconds">Number of seconds to wait for response from Managed Identity service endpoint when attempting a retry. The default is 0, i.e. no timeout is applied.</param>
<param name="maxRetryCount">Maximum number of retries to perform when Managed Identity service endpoint is unreachable. By default, the driver retries 5 times.</param>
<param name="httpClient">
An instance of <see cref="T:System.Net.Http.HttpClient" /> to be used by this authentication provider.
</param>
<summary>
Initializes the <see cref="T:Microsoft.Data.SqlClient.AzureManagedIdentityAuthenticationProvider" /> class.
</summary>
</ctor>
<AcquireTokenAsync>
<param name="parameters">The Active Directory authentication parameters passed to authentication providers.</param>
<summary>Acquires a security token from the Managed Identity service endpoint.</summary>
<returns>Represents an asynchronous operation that returns the authentication token.</returns>
</AcquireTokenAsync>
<IsSupported>
<param name="authentication">The authentication method.</param>
<summary>Indicates whether the specified authentication method is supported.</summary>
<returns>
<see langword="true" /> if the specified authentication method is supported; otherwise, <see langword="false" />.
</returns>
<remarks>
<format type="text/markdown">
<![CDATA[
## Remarks
The supported authentication methods are:
|Authentication Method|
|----------------|
|<xref:Microsoft.Data.SqlClient.SqlAuthenticationMethod.ActiveDirectoryMnaagedIdentity%2A>|
]]>
</format>
</remarks>
</IsSupported>
</members>
</docs>