-
Notifications
You must be signed in to change notification settings - Fork 268
/
DefaultAzureCredential.xml
213 lines (210 loc) · 15.6 KB
/
DefaultAzureCredential.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
<Type Name="DefaultAzureCredential" FullName="Azure.Identity.DefaultAzureCredential">
<TypeSignature Language="C#" Value="public class DefaultAzureCredential : Azure.Core.TokenCredential" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit DefaultAzureCredential extends Azure.Core.TokenCredential" />
<TypeSignature Language="DocId" Value="T:Azure.Identity.DefaultAzureCredential" />
<TypeSignature Language="VB.NET" Value="Public Class DefaultAzureCredential
Inherits TokenCredential" />
<TypeSignature Language="F#" Value="type DefaultAzureCredential = 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>
<AssemblyVersion>1.12.1.0</AssemblyVersion>
<AssemblyVersion>1.13.0.0</AssemblyVersion>
<AssemblyVersion>1.13.1.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Azure.Core.TokenCredential</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Simplifies authentication while developing apps that deploy to Azure by combining credentials used in Azure
hosting environments with credentials used in local development. In production, it's better to use something
else. See <see href="https://aka.ms/azsdk/net/identity/credential-chains#usage-guidance-for-defaultazurecredential">Usage guidance for DefaultAzureCredential</see>.
Attempts to authenticate with each of these credentials, in the following order, stopping when one provides
a token:
<list type="bullet"><item><description><see cref="T:Azure.Identity.EnvironmentCredential" /></description></item><item><description><see cref="T:Azure.Identity.WorkloadIdentityCredential" /></description></item><item><description><see cref="T:Azure.Identity.ManagedIdentityCredential" /></description></item><item><description><see cref="T:Azure.Identity.SharedTokenCacheCredential" /></description></item><item><description><see cref="T:Azure.Identity.VisualStudioCredential" /></description></item><item><description><see cref="T:Azure.Identity.VisualStudioCodeCredential" /></description></item><item><description><see cref="T:Azure.Identity.AzureCliCredential" /></description></item><item><description><see cref="T:Azure.Identity.AzurePowerShellCredential" /></description></item><item><description><see cref="T:Azure.Identity.AzureDeveloperCliCredential" /></description></item><item><description><see cref="T:Azure.Identity.InteractiveBrowserCredential" /></description></item></list>
Consult the documentation of these credentials for more information on how they attempt authentication.
</summary>
<remarks>
Note that credentials requiring user interaction, such as the <see cref="T:Azure.Identity.InteractiveBrowserCredential" />, are excluded by default. Callers must explicitly enable this when
constructing <see cref="T:Azure.Identity.DefaultAzureCredential" /> either by setting the includeInteractiveCredentials parameter to <c>true</c>, or the setting the
<see cref="P:Azure.Identity.DefaultAzureCredentialOptions.ExcludeInteractiveBrowserCredential" /> property to <c>false</c> when passing <see cref="T:Azure.Identity.DefaultAzureCredentialOptions" />.
</remarks>
<example>
<para>
This example demonstrates authenticating the BlobClient from the Azure.Storage.Blobs client library using DefaultAzureCredential,
deployed to an Azure resource with a user-assigned managed identity configured.
</para>
<code snippet="Snippet:UserAssignedManagedIdentityWithClientId" language="csharp">
// When deployed to an Azure host, DefaultAzureCredential will authenticate the specified user-assigned managed identity.
string userAssignedClientId = "<your managed identity client ID>";
var credential = new DefaultAzureCredential(
new DefaultAzureCredentialOptions
{
ManagedIdentityClientId = userAssignedClientId
});
var blobClient = new BlobClient(
new Uri("https://myaccount.blob.core.windows.net/mycontainer/myblob"),
credential);
</code>
</example>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected DefaultAzureCredential ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Identity.DefaultAzureCredential.#ctor" />
<MemberSignature Language="VB.NET" Value="Protected Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Identity</AssemblyName>
<AssemblyVersion>1.13.0.0</AssemblyVersion>
<AssemblyVersion>1.13.1.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 DefaultAzureCredential (Azure.Identity.DefaultAzureCredentialOptions options);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class Azure.Identity.DefaultAzureCredentialOptions options) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Identity.DefaultAzureCredential.#ctor(Azure.Identity.DefaultAzureCredentialOptions)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (options As DefaultAzureCredentialOptions)" />
<MemberSignature Language="F#" Value="new Azure.Identity.DefaultAzureCredential : Azure.Identity.DefaultAzureCredentialOptions -> Azure.Identity.DefaultAzureCredential" Usage="new Azure.Identity.DefaultAzureCredential options" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Identity</AssemblyName>
<AssemblyVersion>1.13.0.0</AssemblyVersion>
<AssemblyVersion>1.13.1.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="options" Type="Azure.Identity.DefaultAzureCredentialOptions" />
</Parameters>
<Docs>
<param name="options">Options that configure the management of the requests sent to Microsoft Entra ID, and determine which credentials are included in the <see cref="T:Azure.Identity.DefaultAzureCredential" /> authentication flow.</param>
<summary>
Creates an instance of the <see cref="T:Azure.Identity.DefaultAzureCredential" /> class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public DefaultAzureCredential (bool includeInteractiveCredentials = false);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(bool includeInteractiveCredentials) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Identity.DefaultAzureCredential.#ctor(System.Boolean)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (Optional includeInteractiveCredentials As Boolean = false)" />
<MemberSignature Language="F#" Value="new Azure.Identity.DefaultAzureCredential : bool -> Azure.Identity.DefaultAzureCredential" Usage="new Azure.Identity.DefaultAzureCredential includeInteractiveCredentials" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Identity</AssemblyName>
<AssemblyVersion>1.13.0.0</AssemblyVersion>
<AssemblyVersion>1.13.1.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="includeInteractiveCredentials" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="includeInteractiveCredentials">Specifies whether credentials requiring user interaction will be included in the default authentication flow.</param>
<summary>
Creates an instance of the DefaultAzureCredential class.
</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.DefaultAzureCredential.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="defaultAzureCredential.GetToken (requestContext, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Identity</AssemblyName>
<AssemblyVersion>1.13.0.0</AssemblyVersion>
<AssemblyVersion>1.13.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 details of the authentication request.</param>
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
<summary>
Sequentially calls <see cref="M:Azure.Core.TokenCredential.GetToken(Azure.Core.TokenRequestContext,System.Threading.CancellationToken)" /> on all the included credentials, returning the first successfully
obtained <see cref="T:Azure.Core.AccessToken" />. Acquired tokens are <see href="https://aka.ms/azsdk/net/identity/token-cache">cached</see>
by the credential instance. Token lifetime and refreshing is handled automatically. Where possible, reuse credential instances
to optimize cache effectiveness.
</summary>
<returns>The first <see cref="T:Azure.Core.AccessToken" /> returned by the specified sources. Any credential which raises a <see cref="T:Azure.Identity.CredentialUnavailableException" /> will be skipped.</returns>
<remarks>
Credentials requiring user interaction, such as <see cref="T:Azure.Identity.InteractiveBrowserCredential" />, are excluded by default.
</remarks>
<exception cref="T:Azure.Identity.AuthenticationFailedException">Thrown when the authentication failed.</exception>
</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.DefaultAzureCredential.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="defaultAzureCredential.GetTokenAsync (requestContext, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Identity</AssemblyName>
<AssemblyVersion>1.13.0.0</AssemblyVersion>
<AssemblyVersion>1.13.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 details of the authentication request.</param>
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
<summary>
Sequentially calls <see cref="M:Azure.Core.TokenCredential.GetToken(Azure.Core.TokenRequestContext,System.Threading.CancellationToken)" /> on all the included credentials, returning the first successfully
obtained <see cref="T:Azure.Core.AccessToken" />. Acquired tokens are <see href="https://aka.ms/azsdk/net/identity/token-cache">cached</see>
by the credential instance. Token lifetime and refreshing is handled automatically. Where possible, reuse credential instances
to optimize cache effectiveness.
</summary>
<returns>The first <see cref="T:Azure.Core.AccessToken" /> returned by the specified sources. Any credential which raises a <see cref="T:Azure.Identity.CredentialUnavailableException" /> will be skipped.</returns>
<remarks>
Credentials requiring user interaction, such as <see cref="T:Azure.Identity.InteractiveBrowserCredential" />, are excluded by default.
</remarks>
<exception cref="T:Azure.Identity.AuthenticationFailedException">Thrown when the authentication failed.</exception>
</Docs>
</Member>
</Members>
</Type>