Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Drive traffic to credential reuse guidance #47931

Merged
merged 3 commits into from
Jan 22, 2025
Merged

Drive traffic to credential reuse guidance #47931

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1c4138c
Drive traffic to credential reuse guidance
scottaddie Jan 22, 2025
1ad9cd9
Update DeviceCodeCredential XML docs
scottaddie Jan 22, 2025
eccf48b
Trim trailing whitespace
scottaddie Jan 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions sdk/identity/Azure.Identity/src/Credentials/AuthorizationCodeCredential.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,8 @@ internal AuthorizationCodeCredential(string tenantId, string clientId, string cl
/// <summary>
/// Obtains a token from Microsoft Entra ID, using the specified authorization code to authenticate. 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.
/// refreshing is handled automatically. Where possible, <see href="https://aka.ms/azsdk/net/identity/credential-reuse">reuse credential instances</see>
/// to optimize cache effectiveness.
/// </summary>
/// <param name="requestContext">The details of the authentication request.</param>
/// <param name="cancellationToken">A <see cref="CancellationToken"/> controlling the request lifetime.</param>
Expand All @@ -124,7 +125,8 @@ public override AccessToken GetToken(TokenRequestContext requestContext, Cancell
/// <summary>
/// Obtains a token from Microsoft Entra ID, using the specified authorization code to authenticate. 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.
/// refreshing is handled automatically. Where possible, <see href="https://aka.ms/azsdk/net/identity/credential-reuse">reuse credential instances</see>
/// to optimize cache effectiveness.
/// </summary>
/// <param name="requestContext">The details of the authentication request.</param>
/// <param name="cancellationToken">A <see cref="CancellationToken"/> controlling the request lifetime.</param>
Expand Down
6 changes: 4 additions & 2 deletions sdk/identity/Azure.Identity/src/Credentials/AzureApplicationCredential.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,8 @@ internal AzureApplicationCredential(AzureApplicationCredentialOptions options, E
/// <summary>
/// Sequentially calls <see cref="TokenCredential.GetToken"/> on all the specified sources, returning the first successfully obtained
/// <see cref="AccessToken"/>. Acquired tokens are cached by the credential instance. Token lifetime and refreshing is handled
/// automatically. Where possible, reuse credential instances to optimize cache effectiveness.
/// automatically. Where possible, <see href="https://aka.ms/azsdk/net/identity/credential-reuse">reuse credential instances</see>
/// to optimize cache effectiveness.
/// </summary>
/// <param name="requestContext">The details of the authentication request.</param>
/// <param name="cancellationToken">A <see cref="CancellationToken"/> controlling the request lifetime.</param>
Expand All @@ -58,7 +59,8 @@ public override AccessToken GetToken(TokenRequestContext requestContext, Cancell
/// <summary>
/// Sequentially calls <see cref="TokenCredential.GetToken"/> on all the specified sources, returning the first successfully obtained
/// <see cref="AccessToken"/>. Acquired tokens are cached by the credential instance. Token lifetime and refreshing is handled
/// automatically. Where possible,reuse credential instances to optimize cache effectiveness.
/// automatically. Where possible,<see href="https://aka.ms/azsdk/net/identity/credential-reuse">reuse credential instances</see>
/// to optimize cache effectiveness.
/// </summary>
/// <param name="requestContext">The details of the authentication request.</param>
/// <param name="cancellationToken">A <see cref="CancellationToken"/> controlling the request lifetime.</param>
Expand Down
8 changes: 4 additions & 4 deletions sdk/identity/Azure.Identity/src/Credentials/ChainedTokenCredential.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,8 +71,8 @@ public ChainedTokenCredential(params TokenCredential[] sources)
/// <summary>
/// Sequentially calls <see cref="TokenCredential.GetToken"/> on all the specified sources, returning the first successfully obtained
/// <see cref="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.
/// credential instance. Token lifetime and refreshing is handled automatically. Where possible, <see href="https://aka.ms/azsdk/net/identity/credential-reuse">reuse credential instances</see>
/// to optimize cache effectiveness.
/// </summary>
/// <param name="requestContext">The details of the authentication request.</param>
/// <param name="cancellationToken">A <see cref="CancellationToken"/> controlling the request lifetime.</param>
Expand All @@ -84,8 +84,8 @@ public override AccessToken GetToken(TokenRequestContext requestContext, Cancell
/// <summary>
/// Sequentially calls <see cref="TokenCredential.GetToken"/> on all the specified sources, returning the first successfully obtained
/// <see cref="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.
/// credential instance. Token lifetime and refreshing is handled automatically. Where possible, <see href="https://aka.ms/azsdk/net/identity/credential-reuse">reuse credential instances</see>
/// to optimize cache effectiveness.
/// </summary>
/// <param name="requestContext">The details of the authentication request.</param>
/// <param name="cancellationToken">A <see cref="CancellationToken"/> controlling the request lifetime.</param>
Expand Down
6 changes: 4 additions & 2 deletions sdk/identity/Azure.Identity/src/Credentials/ClientCertificateCredential.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,8 @@ internal ClientCertificateCredential(
/// <summary>
/// Obtains a token from Microsoft Entra ID, using the specified X509 certificate to authenticate. 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.
/// and refreshing is handled automatically. Where possible, <see href="https://aka.ms/azsdk/net/identity/credential-reuse">reuse credential instances</see>
/// to optimize cache effectiveness.
/// </summary>
/// <param name="requestContext">The details of the authentication request.</param>
/// <param name="cancellationToken">A <see cref="CancellationToken"/> controlling the request lifetime.</param>
Expand All @@ -201,7 +202,8 @@ public override AccessToken GetToken(TokenRequestContext requestContext, Cancell
/// <summary>
/// Obtains a token from Microsoft Entra ID, using the specified X509 certificate to authenticate. 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.
/// and refreshing is handled automatically. Where possible, <see href="https://aka.ms/azsdk/net/identity/credential-reuse">reuse credential instances</see>
/// to optimize cache effectiveness.
/// </summary>
/// <param name="requestContext">The details of the authentication request.</param>
/// <param name="cancellationToken">A <see cref="CancellationToken"/> controlling the request lifetime.</param>
Expand Down
6 changes: 4 additions & 2 deletions sdk/identity/Azure.Identity/src/Credentials/ClientSecretCredential.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,8 @@ internal ClientSecretCredential(string tenantId, string clientId, string clientS
/// <summary>
/// Obtains a token from Microsoft Entra ID, using the specified client secret to authenticate. 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.
/// and refreshing is handled automatically. Where possible, <see href="https://aka.ms/azsdk/net/identity/credential-reuse">reuse credential instances</see>
/// to optimize cache effectiveness.
/// </summary>
/// <param name="requestContext">The details of the authentication request.</param>
/// <param name="cancellationToken">A <see cref="CancellationToken"/> controlling the request lifetime.</param>
Expand All @@ -132,7 +133,8 @@ public override async ValueTask<AccessToken> GetTokenAsync(TokenRequestContext r
/// <summary>
/// Obtains a token from Microsoft Entra ID, using the specified client secret to authenticate. 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.
/// and refreshing is handled automatically. Where possible, <see href="https://aka.ms/azsdk/net/identity/credential-reuse">reuse credential instances</see>
/// to optimize cache effectiveness.
/// </summary>
/// <param name="requestContext">The details of the authentication request.</param>
/// <param name="cancellationToken">A <see cref="CancellationToken"/> controlling the request lifetime.</param>
Expand Down
4 changes: 2 additions & 2 deletions sdk/identity/Azure.Identity/src/Credentials/DefaultAzureCredential.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ internal DefaultAzureCredential(DefaultAzureCredentialFactory factory)
/// <summary>
/// Sequentially calls <see cref="TokenCredential.GetToken"/> on all the included credentials, returning the first successfully
/// obtained <see cref="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
/// by the credential instance. Token lifetime and refreshing is handled automatically. Where possible, <see href="https://aka.ms/azsdk/net/identity/credential-reuse">reuse credential instances</see>
/// to optimize cache effectiveness.
/// </summary>
/// <remarks>
Expand All @@ -121,7 +121,7 @@ public override AccessToken GetToken(TokenRequestContext requestContext, Cancell
/// <summary>
/// Sequentially calls <see cref="TokenCredential.GetToken"/> on all the included credentials, returning the first successfully
/// obtained <see cref="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
/// by the credential instance. Token lifetime and refreshing is handled automatically. Where possible, <see href="https://aka.ms/azsdk/net/identity/credential-reuse">reuse credential instances</see>
/// to optimize cache effectiveness.
/// </summary>
/// <remarks>
Expand Down
8 changes: 4 additions & 4 deletions sdk/identity/Azure.Identity/src/Credentials/DeviceCodeCredential.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,8 +160,8 @@ public virtual async Task<AuthenticationRecord> AuthenticateAsync(TokenRequestCo
/// <summary>
/// Obtains a token for a user account, authenticating them through the device code authentication flow.
/// 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.
/// credential instance. Token lifetime and refreshing is handled automatically. Where possible, <see href="https://aka.ms/azsdk/net/identity/credential-reuse">reuse
/// credential instances</see> to optimize cache effectiveness.
/// </summary>
/// <param name="requestContext">The details of the authentication request.</param>
/// <param name="cancellationToken">A <see cref="CancellationToken"/> controlling the request lifetime.</param>
Expand All @@ -175,8 +175,8 @@ public override AccessToken GetToken(TokenRequestContext requestContext, Cancell
/// <summary>
/// Obtains a token for a user account, authenticating them through the device code authentication flow.
/// 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.
/// credential instance. Token lifetime and refreshing is handled automatically. Where possible, <see href="https://aka.ms/azsdk/net/identity/credential-reuse">reuse
/// credential instances</see> to optimize cache effectiveness.
/// </summary>
/// <param name="requestContext">The details of the authentication request.</param>
/// <param name="cancellationToken">A <see cref="CancellationToken"/> controlling the request lifetime.</param>
Expand Down
4 changes: 2 additions & 2 deletions sdk/identity/Azure.Identity/src/Credentials/EnvironmentCredential.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ internal EnvironmentCredential(CredentialPipeline pipeline, TokenCredential cred
/// Obtains a token from Microsoft Entra ID, using the client details specified in the environment variables
/// AZURE_TENANT_ID, AZURE_CLIENT_ID, and AZURE_CLIENT_SECRET or AZURE_USERNAME and AZURE_PASSWORD to authenticate.
/// 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
/// instance. Token lifetime and refreshing is handled automatically. Where possible, <see href="https://aka.ms/azsdk/net/identity/credential-reuse">reuse credential instances</see>
/// to optimize cache effectiveness.
/// </summary>
/// <remarks>
Expand All @@ -149,7 +149,7 @@ public override AccessToken GetToken(TokenRequestContext requestContext, Cancell
/// Obtains a token from Microsoft Entra ID, using the client details specified in the environment variables
/// AZURE_TENANT_ID, AZURE_CLIENT_ID, and AZURE_CLIENT_SECRET or AZURE_USERNAME and AZURE_PASSWORD to authenticate.
/// 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
/// instance. Token lifetime and refreshing is handled automatically. Where possible, <see href="https://aka.ms/azsdk/net/identity/credential-reuse">reuse credential instances</see>
/// to optimize cache effectiveness.
/// </summary>
/// <remarks>
Expand Down
8 changes: 4 additions & 4 deletions sdk/identity/Azure.Identity/src/Credentials/InteractiveBrowserCredential.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,8 +151,8 @@ public virtual async Task<AuthenticationRecord> AuthenticateAsync(TokenRequestCo
/// <summary>
/// Silently obtains an <see cref="AccessToken"/> for a user account if the user has already authenticated. Otherwise, the default browser is launched
/// to authenticate the user. 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.
/// credential instance. Token lifetime and refreshing is handled automatically. Where possible, <see href="https://aka.ms/azsdk/net/identity/credential-reuse">reuse credential instances</see>
/// to optimize cache effectiveness.
/// </summary>
/// <param name="requestContext">The details of the authentication request.</param>
/// <param name="cancellationToken">A <see cref="CancellationToken"/> controlling the request lifetime.</param>
Expand All @@ -166,8 +166,8 @@ public override AccessToken GetToken(TokenRequestContext requestContext, Cancell
/// <summary>
/// Silently obtains an <see cref="AccessToken"/> for a user account if the user has already authenticated. Otherwise, the default browser is launched
/// to authenticate the user. 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.
/// credential instance. Token lifetime and refreshing is handled automatically. Where possible, <see href="https://aka.ms/azsdk/net/identity/credential-reuse">reuse credential instances</see>
/// to optimize cache effectiveness.
/// </summary>
/// <param name="requestContext">The details of the authentication request.</param>
/// <param name="cancellationToken">A <see cref="CancellationToken"/> controlling the request lifetime.</param>
Expand Down
8 changes: 4 additions & 4 deletions sdk/identity/Azure.Identity/src/Credentials/ManagedIdentityCredential.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,8 +110,8 @@ internal ManagedIdentityCredential(ManagedIdentityClient client)
/// <summary>
/// Obtains an <see cref="AccessToken"/> from the Managed Identity service, if available. 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.
/// lifetime and refreshing is handled automatically. Where possible, <see href="https://aka.ms/azsdk/net/identity/credential-reuse">reuse credential instances</see>
/// to optimize cache effectiveness.
/// </summary>
/// <param name="requestContext">The details of the authentication request.</param>
/// <param name="cancellationToken">A <see cref="CancellationToken"/> controlling the request lifetime.</param>
Expand All @@ -125,8 +125,8 @@ public override async ValueTask<AccessToken> GetTokenAsync(TokenRequestContext r
/// <summary>
/// Obtains an <see cref="AccessToken"/> from the Managed Identity service, if available. 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.
/// lifetime and refreshing is handled automatically. Where possible, <see href="https://aka.ms/azsdk/net/identity/credential-reuse">reuse credential instances</see>
/// to optimize cache effectiveness.
/// </summary>
/// <param name="requestContext">The details of the authentication request.</param>
/// <param name="cancellationToken">A <see cref="CancellationToken"/> controlling the request lifetime.</param>
Expand Down
Loading
Loading