diff --git a/sdk/identity/Azure.Identity/src/AuthorizationCodeCredential.cs b/sdk/identity/Azure.Identity/src/AuthorizationCodeCredential.cs index f486aa923f8e0..448d93fd7fa5c 100644 --- a/sdk/identity/Azure.Identity/src/AuthorizationCodeCredential.cs +++ b/sdk/identity/Azure.Identity/src/AuthorizationCodeCredential.cs @@ -73,7 +73,7 @@ public AuthorizationCodeCredential(string tenantId, string clientId, string clie } /// - /// Obtains a token from the Azure Active Directory service, using the specified authorization code authenticate. This method is called by Azure SDK clients. It isn't intended for use in application code. + /// Obtains a token from the Azure Active Directory service, using the specified authorization code authenticate. This method is called automatically by Azure SDK client libraries. You may call this method directly, but you must also handle token caching and token refreshing. /// /// The details of the authentication request. /// A controlling the request lifetime. @@ -84,7 +84,7 @@ public override AccessToken GetToken(TokenRequestContext requestContext, Cancell } /// - /// Obtains a token from the Azure Active Directory service, using the specified authorization code authenticate. This method is called by Azure SDK clients. It isn't intended for use in application code. + /// Obtains a token from the Azure Active Directory service, using the specified authorization code authenticate. This method is called automatically by Azure SDK client libraries. You may call this method directly, but you must also handle token caching and token refreshing. /// /// The details of the authentication request. /// A controlling the request lifetime. diff --git a/sdk/identity/Azure.Identity/src/ChainedTokenCredential.cs b/sdk/identity/Azure.Identity/src/ChainedTokenCredential.cs index d3df121fc6a24..81eaa2ec9983e 100644 --- a/sdk/identity/Azure.Identity/src/ChainedTokenCredential.cs +++ b/sdk/identity/Azure.Identity/src/ChainedTokenCredential.cs @@ -55,7 +55,7 @@ public ChainedTokenCredential(params TokenCredential[] sources) } /// - /// Sequentially calls on all the specified sources, returning the first successfully obtained . This method is called by Azure SDK clients. It isn't intended for use in application code. + /// Sequentially calls on all the specified sources, returning the first successfully obtained . This method is called automatically by Azure SDK client libraries. You may call this method directly, but you must also handle token caching and token refreshing. /// /// The details of the authentication request. /// A controlling the request lifetime. @@ -64,7 +64,7 @@ public override AccessToken GetToken(TokenRequestContext requestContext, Cancell => GetTokenImplAsync(false, requestContext, cancellationToken).EnsureCompleted(); /// - /// Sequentially calls on all the specified sources, returning the first successfully obtained . This method is called by Azure SDK clients. It isn't intended for use in application code. + /// Sequentially calls on all the specified sources, returning the first successfully obtained . This method is called automatically by Azure SDK client libraries. You may call this method directly, but you must also handle token caching and token refreshing. /// /// The details of the authentication request. /// A controlling the request lifetime. diff --git a/sdk/identity/Azure.Identity/src/ClientCertificateCredential.cs b/sdk/identity/Azure.Identity/src/ClientCertificateCredential.cs index 803444cb965ae..9d40938435043 100644 --- a/sdk/identity/Azure.Identity/src/ClientCertificateCredential.cs +++ b/sdk/identity/Azure.Identity/src/ClientCertificateCredential.cs @@ -137,7 +137,7 @@ internal ClientCertificateCredential(string tenantId, string clientId, IX509Cert } /// - /// Obtains a token from the Azure Active Directory service, using the specified X509 certificate to authenticate. This method is called by Azure SDK clients. It isn't intended for use in application code. + /// Obtains a token from the Azure Active Directory service, using the specified X509 certificate to authenticate. This method is called automatically by Azure SDK client libraries. You may call this method directly, but you must also handle token caching and token refreshing. /// /// The details of the authentication request. /// A controlling the request lifetime. @@ -159,7 +159,7 @@ public override AccessToken GetToken(TokenRequestContext requestContext, Cancell } /// - /// Obtains a token from the Azure Active Directory service, using the specified X509 certificate to authenticate. This method is called by Azure SDK clients. It isn't intended for use in application code. + /// Obtains a token from the Azure Active Directory service, using the specified X509 certificate to authenticate. This method is called automatically by Azure SDK client libraries. You may call this method directly, but you must also handle token caching and token refreshing. /// /// The details of the authentication request. /// A controlling the request lifetime. diff --git a/sdk/identity/Azure.Identity/src/ClientSecretCredential.cs b/sdk/identity/Azure.Identity/src/ClientSecretCredential.cs index cd502ca93dd33..124265e38659b 100644 --- a/sdk/identity/Azure.Identity/src/ClientSecretCredential.cs +++ b/sdk/identity/Azure.Identity/src/ClientSecretCredential.cs @@ -91,7 +91,7 @@ internal ClientSecretCredential(string tenantId, string clientId, string clientS } /// - /// Obtains a token from the Azure Active Directory service, using the specified client secret to authenticate. This method is called by Azure SDK clients. It isn't intended for use in application code. + /// Obtains a token from the Azure Active Directory service, using the specified client secret to authenticate. This method is called automatically by Azure SDK client libraries. You may call this method directly, but you must also handle token caching and token refreshing. /// /// The details of the authentication request. /// A controlling the request lifetime. @@ -113,7 +113,7 @@ public override async ValueTask GetTokenAsync(TokenRequestContext r } /// - /// Obtains a token from the Azure Active Directory service, using the specified client secret to authenticate. This method is called by Azure SDK clients. It isn't intended for use in application code. + /// Obtains a token from the Azure Active Directory service, using the specified client secret to authenticate. This method is called automatically by Azure SDK client libraries. You may call this method directly, but you must also handle token caching and token refreshing. /// /// The details of the authentication request. /// A controlling the request lifetime. diff --git a/sdk/identity/Azure.Identity/src/DefaultAzureCredential.cs b/sdk/identity/Azure.Identity/src/DefaultAzureCredential.cs index 19e3438c7beb5..220f8c5a74a68 100644 --- a/sdk/identity/Azure.Identity/src/DefaultAzureCredential.cs +++ b/sdk/identity/Azure.Identity/src/DefaultAzureCredential.cs @@ -70,7 +70,7 @@ internal DefaultAzureCredential(DefaultAzureCredentialFactory factory, DefaultAz /// /// Sequentially calls on all the included credentials in the order , , , - /// and returning the first successfully obtained . This method is called by Azure SDK clients. It isn't intended for use in application code. + /// and returning the first successfully obtained . This method is called automatically by Azure SDK client libraries. You may call this method directly, but you must also handle token caching and token refreshing. /// /// /// Note that credentials requiring user interaction, such as the , are not included by default. @@ -85,7 +85,7 @@ public override AccessToken GetToken(TokenRequestContext requestContext, Cancell /// /// Sequentially calls on all the included credentials in the order , , , - /// and returning the first successfully obtained . This method is called by Azure SDK clients. It isn't intended for use in application code. + /// and returning the first successfully obtained . This method is called automatically by Azure SDK client libraries. You may call this method directly, but you must also handle token caching and token refreshing. /// /// /// Note that credentials requiring user interaction, such as the , are not included by default. diff --git a/sdk/identity/Azure.Identity/src/DeviceCodeCredential.cs b/sdk/identity/Azure.Identity/src/DeviceCodeCredential.cs index 373db8c88c22e..d45b346c9d86c 100644 --- a/sdk/identity/Azure.Identity/src/DeviceCodeCredential.cs +++ b/sdk/identity/Azure.Identity/src/DeviceCodeCredential.cs @@ -140,7 +140,7 @@ public virtual async Task AuthenticateAsync(TokenRequestCo } /// - /// Obtains a token for a user account, authenticating them through the device code authentication flow. This method is called by Azure SDK clients. It isn't intended for use in application code. + /// Obtains a token for a user account, authenticating them through the device code authentication flow. This method is called automatically by Azure SDK client libraries. You may call this method directly, but you must also handle token caching and token refreshing. /// /// The details of the authentication request. /// A controlling the request lifetime. @@ -151,7 +151,7 @@ public override AccessToken GetToken(TokenRequestContext requestContext, Cancell } /// - /// Obtains a token for a user account, authenticating them through the device code authentication flow. This method is called by Azure SDK clients. It isn't intended for use in application code. + /// Obtains a token for a user account, authenticating them through the device code authentication flow. This method is called automatically by Azure SDK client libraries. You may call this method directly, but you must also handle token caching and token refreshing. /// /// The details of the authentication request. /// A controlling the request lifetime. diff --git a/sdk/identity/Azure.Identity/src/EnvironmentCredential.cs b/sdk/identity/Azure.Identity/src/EnvironmentCredential.cs index 449a786878e6b..29874bda400df 100644 --- a/sdk/identity/Azure.Identity/src/EnvironmentCredential.cs +++ b/sdk/identity/Azure.Identity/src/EnvironmentCredential.cs @@ -91,7 +91,7 @@ internal EnvironmentCredential(CredentialPipeline pipeline, TokenCredential cred /// /// Obtains a token from the Azure Active Directory service, using the specified 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. - /// This method is called by Azure SDK clients. It isn't intended for use in application code. + /// This method is called automatically by Azure SDK client libraries. You may call this method directly, but you must also handle token caching and token refreshing. /// /// /// If the environment variables AZURE_TENANT_ID, AZURE_CLIENT_ID, and AZURE_CLIENT_SECRET are not specified, the default @@ -107,7 +107,7 @@ public override AccessToken GetToken(TokenRequestContext requestContext, Cancell /// /// Obtains a token from the Azure Active Directory service, using the specified 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. - /// This method is called by Azure SDK clients. It isn't intended for use in application code. + /// This method is called automatically by Azure SDK client libraries. You may call this method directly, but you must also handle token caching and token refreshing. /// /// /// If the environment variables AZURE_TENANT_ID, AZURE_CLIENT_ID, and AZURE_CLIENT_SECRET are not specifeid, the default diff --git a/sdk/identity/Azure.Identity/src/InteractiveBrowserCredential.cs b/sdk/identity/Azure.Identity/src/InteractiveBrowserCredential.cs index ccb5b6b5efc8b..498dec8e468a5 100644 --- a/sdk/identity/Azure.Identity/src/InteractiveBrowserCredential.cs +++ b/sdk/identity/Azure.Identity/src/InteractiveBrowserCredential.cs @@ -132,7 +132,7 @@ public virtual async Task AuthenticateAsync(TokenRequestCo } /// - /// Obtains an token for a user account silently if the user has already authenticated, otherwise the default browser is launched to authenticate the user. This method is called by Azure SDK clients. It isn't intended for use in application code. + /// Obtains an token for a user account silently if the user has already authenticated, otherwise the default browser is launched to authenticate the user. This method is called automatically by Azure SDK client libraries. You may call this method directly, but you must also handle token caching and token refreshing. /// /// The details of the authentication request. /// A controlling the request lifetime. @@ -143,7 +143,7 @@ public override AccessToken GetToken(TokenRequestContext requestContext, Cancell } /// - /// Obtains an token for a user account silently if the user has already authenticated, otherwise the default browser is launched to authenticate the user. This method is called by Azure SDK clients. It isn't intended for use in application code. + /// Obtains an token for a user account silently if the user has already authenticated, otherwise the default browser is launched to authenticate the user. This method is called automatically by Azure SDK client libraries. You may call this method directly, but you must also handle token caching and token refreshing. /// /// The details of the authentication request. /// A controlling the request lifetime. diff --git a/sdk/identity/Azure.Identity/src/ManagedIdentityCredential.cs b/sdk/identity/Azure.Identity/src/ManagedIdentityCredential.cs index 0121884dcf344..92ce046689e31 100644 --- a/sdk/identity/Azure.Identity/src/ManagedIdentityCredential.cs +++ b/sdk/identity/Azure.Identity/src/ManagedIdentityCredential.cs @@ -60,7 +60,7 @@ internal ManagedIdentityCredential(CredentialPipeline pipeline, ManagedIdentityC } /// - /// Obtains an from the Managed Identity service if available. This method is called by Azure SDK clients. It isn't intended for use in application code. + /// Obtains an from the Managed Identity service if available. This method is called automatically by Azure SDK client libraries. You may call this method directly, but you must also handle token caching and token refreshing. /// /// The details of the authentication request. /// A controlling the request lifetime. @@ -71,7 +71,7 @@ public override async ValueTask GetTokenAsync(TokenRequestContext r } /// - /// Obtains an from the Managed Identity service if available. This method is called by Azure SDK clients. It isn't intended for use in application code. + /// Obtains an from the Managed Identity service if available. This method is called automatically by Azure SDK client libraries. You may call this method directly, but you must also handle token caching and token refreshing. /// /// The details of the authentication request. /// A controlling the request lifetime. diff --git a/sdk/identity/Azure.Identity/src/SharedTokenCacheCredential.cs b/sdk/identity/Azure.Identity/src/SharedTokenCacheCredential.cs index a3dcf7565089a..5b50ecec93af9 100644 --- a/sdk/identity/Azure.Identity/src/SharedTokenCacheCredential.cs +++ b/sdk/identity/Azure.Identity/src/SharedTokenCacheCredential.cs @@ -79,7 +79,7 @@ internal SharedTokenCacheCredential(string tenantId, string username, TokenCrede } /// - /// Obtains an token for a user account silently if the user has already authenticated to another Microsoft application participating in SSO through a shared MSAL cache. This method is called by Azure SDK clients. It isn't intended for use in application code. + /// Obtains an token for a user account silently if the user has already authenticated to another Microsoft application participating in SSO through a shared MSAL cache. This method is called automatically by Azure SDK client libraries. You may call this method directly, but you must also handle token caching and token refreshing. /// /// The details of the authentication request. /// A controlling the request lifetime @@ -90,7 +90,7 @@ public override AccessToken GetToken(TokenRequestContext requestContext, Cancell } /// - /// Obtains an token for a user account silently if the user has already authenticated to another Microsoft application participating in SSO through a shared MSAL cache. This method is called by Azure SDK clients. It isn't intended for use in application code. + /// Obtains an token for a user account silently if the user has already authenticated to another Microsoft application participating in SSO through a shared MSAL cache. This method is called automatically by Azure SDK client libraries. You may call this method directly, but you must also handle token caching and token refreshing. /// /// The details of the authentication request. /// A controlling the request lifetime diff --git a/sdk/identity/Azure.Identity/src/UsernamePasswordCredential.cs b/sdk/identity/Azure.Identity/src/UsernamePasswordCredential.cs index 193db05c939f5..ed42344eacc89 100644 --- a/sdk/identity/Azure.Identity/src/UsernamePasswordCredential.cs +++ b/sdk/identity/Azure.Identity/src/UsernamePasswordCredential.cs @@ -143,7 +143,7 @@ public virtual async Task AuthenticateAsync(TokenRequestCo /// /// Obtains a token for a user account, authenticating them using the given username and password. Note: This will fail with - /// an if the specified user account has MFA enabled. This method is called by Azure SDK clients. It isn't intended for use in application code. + /// an if the specified user account has MFA enabled. This method is called automatically by Azure SDK client libraries. You may call this method directly, but you must also handle token caching and token refreshing. /// /// The details of the authentication request. /// A controlling the request lifetime. @@ -155,7 +155,7 @@ public override AccessToken GetToken(TokenRequestContext requestContext, Cancell /// /// Obtains a token for a user account, authenticating them using the given username and password. Note: This will fail with - /// an if the specified user account has MFA enabled. This method is called by Azure SDK clients. It isn't intended for use in application code. + /// an if the specified user account has MFA enabled. This method is called automatically by Azure SDK client libraries. You may call this method directly, but you must also handle token caching and token refreshing. /// /// The details of the authentication request. /// A controlling the request lifetime.