Index (Azure SDK for Java Reference Documentation)

A B C D E G H I K M P R S T U V

A

AadCredentialBuilderBase<T extends AadCredentialBuilderBase<T>> - Class in com.azure.identity: The base class for credential builders that allow specifying a client ID and tenant ID for an Azure Active Directory.
AadCredentialBuilderBase() - Constructor for class com.azure.identity.AadCredentialBuilderBase
addAll(Collection<? extends TokenCredential>) - Method in class com.azure.identity.ChainedTokenCredentialBuilder: Adds all of the credentials in the specified collection at the end of this chain, as if by calling ChainedTokenCredentialBuilder.addLast(TokenCredential) on each one, in the order that they are returned by the collection's iterator.
addFirst(TokenCredential) - Method in class com.azure.identity.ChainedTokenCredentialBuilder: Adds a credential to try to authenticate at the front of the chain.
addLast(TokenCredential) - Method in class com.azure.identity.ChainedTokenCredentialBuilder: Adds a credential to try to authenticate at the last of the chain.
authenticate(TokenRequestContext) - Method in class com.azure.identity.DeviceCodeCredential: Authenticates a user via the device code flow.
authenticate() - Method in class com.azure.identity.DeviceCodeCredential: Authenticates a user via the device code flow.
authenticate(TokenRequestContext) - Method in class com.azure.identity.InteractiveBrowserCredential: Interactively authenticates a user via the default browser.
authenticate() - Method in class com.azure.identity.InteractiveBrowserCredential: Interactively authenticates a user via the default browser.
authenticate(TokenRequestContext) - Method in class com.azure.identity.UsernamePasswordCredential: Authenticates the user using the specified username and password.
authenticate() - Method in class com.azure.identity.UsernamePasswordCredential: Authenticates the user using the specified username and password.
AuthenticationRecord - Class in com.azure.identity: Represents the account information relating to an authentication request
authenticationRecord(AuthenticationRecord) - Method in class com.azure.identity.DeviceCodeCredentialBuilder: Sets the AuthenticationRecord captured from a previous authentication.
authenticationRecord(AuthenticationRecord) - Method in class com.azure.identity.InteractiveBrowserCredentialBuilder: Sets the AuthenticationRecord captured from a previous authentication.
authenticationRecord(AuthenticationRecord) - Method in class com.azure.identity.SharedTokenCacheCredentialBuilder: Sets the AuthenticationRecord captured from a previous authentication.
AuthenticationRequiredException - Exception in com.azure.identity: The exception thrown to indicate that interactive authentication is required.
AuthenticationRequiredException(String, TokenRequestContext) - Constructor for exception com.azure.identity.AuthenticationRequiredException: Initializes a new instance of the AuthenticationRequiredException class.
AuthenticationRequiredException(String, TokenRequestContext, Throwable) - Constructor for exception com.azure.identity.AuthenticationRequiredException: Initializes a new instance of the AuthenticationRequiredException class.
authorityHost(String) - Method in class com.azure.identity.AadCredentialBuilderBase: Specifies the Azure Active Directory endpoint to acquire tokens.
authorityHost(String) - Method in class com.azure.identity.DefaultAzureCredentialBuilder: Specifies the Azure Active Directory endpoint to acquire tokens.
authorityHost(String) - Method in class com.azure.identity.EnvironmentCredentialBuilder: Specifies the Azure Active Directory endpoint to acquire tokens.
authorizationCode(String) - Method in class com.azure.identity.AuthorizationCodeCredentialBuilder: Sets the authorization code on the builder.
AuthorizationCodeCredential - Class in com.azure.identity: An AAD credential that acquires a token with an Oauth 2.0 authorization code grant for an AAD application.
AuthorizationCodeCredentialBuilder - Class in com.azure.identity: Fluent credential builder for instantiating a AuthorizationCodeCredential.
AuthorizationCodeCredentialBuilder() - Constructor for class com.azure.identity.AuthorizationCodeCredentialBuilder
AZURE_CHINA - Static variable in class com.azure.identity.AzureAuthorityHosts: The host of the Azure Active Directory authority for tenants in the Azure China Cloud.
AZURE_GERMANY - Static variable in class com.azure.identity.AzureAuthorityHosts: The host of the Azure Active Directory authority for tenants in the Azure German Cloud.
AZURE_GOVERNMENT - Static variable in class com.azure.identity.AzureAuthorityHosts: The host of the Azure Active Directory authority for tenants in the Azure US Government Cloud.
AZURE_PUBLIC_CLOUD - Static variable in class com.azure.identity.AzureAuthorityHosts: The host of the Azure Active Directory authority for tenants in the Azure Public Cloud.
AzureAuthorityHosts - Class in com.azure.identity: Defines fields exposing the well known authority hosts for the Azure Public Cloud and sovereign clouds.
AzureCliCredential - Class in com.azure.identity: A credential provider that provides token credentials based on Azure CLI command.
AzureCliCredentialBuilder - Class in com.azure.identity: Fluent credential builder for instantiating a AzureCliCredential.
AzureCliCredentialBuilder() - Constructor for class com.azure.identity.AzureCliCredentialBuilder
AzurePowerShellCredential - Class in com.azure.identity: A credential provider that provides token credentials based on Azure Power Shell command.
AzurePowerShellCredentialBuilder - Class in com.azure.identity: Fluent credential builder for instantiating a AzurePowerShellCredential.
AzurePowerShellCredentialBuilder() - Constructor for class com.azure.identity.AzurePowerShellCredentialBuilder

B

build() - Method in class com.azure.identity.AuthorizationCodeCredentialBuilder: Creates a new AuthorizationCodeCredential with the current configurations.
build() - Method in class com.azure.identity.AzureCliCredentialBuilder: Creates a new AzureCliCredential with the current configurations.
build() - Method in class com.azure.identity.AzurePowerShellCredentialBuilder: Creates a new AzurePowerShellCredential with the current configurations.
build() - Method in class com.azure.identity.ChainedTokenCredentialBuilder: Creates a new ChainedTokenCredential with the current configurations.
build() - Method in class com.azure.identity.ClientCertificateCredentialBuilder: Creates a new ClientCertificateCredential with the current configurations.
build() - Method in class com.azure.identity.ClientSecretCredentialBuilder: Creates a new ClientCertificateCredential with the current configurations.
build() - Method in class com.azure.identity.DefaultAzureCredentialBuilder: Creates new DefaultAzureCredential with the configured options set.
build() - Method in class com.azure.identity.DeviceCodeCredentialBuilder: Creates a new DeviceCodeCredential with the current configurations.
build() - Method in class com.azure.identity.EnvironmentCredentialBuilder: Creates a new EnvironmentCredential with the current configurations.
build() - Method in class com.azure.identity.IntelliJCredentialBuilder: Creates a new IntelliJCredential with the current configurations.
build() - Method in class com.azure.identity.InteractiveBrowserCredentialBuilder: Creates a new InteractiveBrowserCredential with the current configurations.
build() - Method in class com.azure.identity.ManagedIdentityCredentialBuilder: Creates a new ManagedIdentityCredential with the current configurations.
build() - Method in class com.azure.identity.SharedTokenCacheCredentialBuilder: Creates a new SharedTokenCacheCredentialBuilder with the current configurations.
build() - Method in class com.azure.identity.UsernamePasswordCredentialBuilder: Creates a new UsernamePasswordCredential with the current configurations.
build() - Method in class com.azure.identity.VisualStudioCodeCredentialBuilder: Creates a new VisualStudioCodeCredential with the current configurations.

C

ChainedTokenCredential - Class in com.azure.identity: A token credential provider that can provide a credential from a list of providers.
ChainedTokenCredentialBuilder - Class in com.azure.identity: Fluent credential builder for instantiating a ChainedTokenCredential.
ChainedTokenCredentialBuilder() - Constructor for class com.azure.identity.ChainedTokenCredentialBuilder: Creates an instance of the builder to config the credential.
challengeConsumer(Consumer<DeviceCodeInfo>) - Method in class com.azure.identity.DeviceCodeCredentialBuilder: Sets the consumer to meet the device code challenge.
ClientCertificateCredential - Class in com.azure.identity: An AAD credential that acquires a token with a client certificate for an AAD application.
ClientCertificateCredentialBuilder - Class in com.azure.identity: Fluent credential builder for instantiating a ClientCertificateCredential.
ClientCertificateCredentialBuilder() - Constructor for class com.azure.identity.ClientCertificateCredentialBuilder
clientId(String) - Method in class com.azure.identity.AadCredentialBuilderBase: Sets the client ID of the application.
clientId(String) - Method in class com.azure.identity.ManagedIdentityCredentialBuilder: Specifies the client ID of user assigned or system assigned identity.
clientSecret(String) - Method in class com.azure.identity.AuthorizationCodeCredentialBuilder: Sets the client secret for the authentication.
clientSecret(String) - Method in class com.azure.identity.ClientSecretCredentialBuilder: Sets the client secret for the authentication.
ClientSecretCredential - Class in com.azure.identity: An AAD credential that acquires a token with a client secret for an AAD application.
ClientSecretCredentialBuilder - Class in com.azure.identity: Fluent credential builder for instantiating a ClientSecretCredential.
ClientSecretCredentialBuilder() - Constructor for class com.azure.identity.ClientSecretCredentialBuilder
com.azure.identity - package com.azure.identity: Package containing various types of credentials and classes for retrieving access tokens from various configurations.
CredentialBuilderBase<T extends CredentialBuilderBase<T>> - Class in com.azure.identity: The base class for all the credential builders.
CredentialUnavailableException - Exception in com.azure.identity: The exception thrown when a TokenCredential did not attempt to authenticate and retrieve AccessToken, as its prerequisite information or state was not available.
CredentialUnavailableException(String) - Constructor for exception com.azure.identity.CredentialUnavailableException: Initializes a new instance of the CredentialUnavailableException class.
CredentialUnavailableException(String, Throwable) - Constructor for exception com.azure.identity.CredentialUnavailableException: Initializes a new instance of the CredentialUnavailableException class.

D

DefaultAzureCredential - Class in com.azure.identity: Creates a credential using environment variables or the shared token cache.
DefaultAzureCredentialBuilder - Class in com.azure.identity: Fluent credential builder for instantiating a DefaultAzureCredential.
DefaultAzureCredentialBuilder() - Constructor for class com.azure.identity.DefaultAzureCredentialBuilder: Creates an instance of a DefaultAzureCredentialBuilder.
deserialize(InputStream) - Static method in class com.azure.identity.AuthenticationRecord: Deserializes the AuthenticationRecord from the specified InputStream
deserializeAsync(InputStream) - Static method in class com.azure.identity.AuthenticationRecord: Deserializes the AuthenticationRecord from the specified InputStream
DeviceCodeCredential - Class in com.azure.identity: An AAD credential that acquires a token with a device code for an AAD application.
DeviceCodeCredentialBuilder - Class in com.azure.identity: Fluent credential builder for instantiating a DeviceCodeCredential.
DeviceCodeCredentialBuilder() - Constructor for class com.azure.identity.DeviceCodeCredentialBuilder
DeviceCodeInfo - Class in com.azure.identity: Response returned from the STS device code endpoint containing information necessary for device code flow.
DeviceCodeInfo(String, String, String, OffsetDateTime, String) - Constructor for class com.azure.identity.DeviceCodeInfo: Creates an instance of a device code info.
disableAutomaticAuthentication() - Method in class com.azure.identity.DeviceCodeCredentialBuilder: Disables the automatic authentication and prevents the DeviceCodeCredential from automatically prompting the user.
disableAutomaticAuthentication() - Method in class com.azure.identity.InteractiveBrowserCredentialBuilder: Disables the automatic authentication and prevents the InteractiveBrowserCredential from automatically prompting the user.

E

EnvironmentCredential - Class in com.azure.identity: A credential provider that provides token credentials based on environment variables.
EnvironmentCredentialBuilder - Class in com.azure.identity: Fluent credential builder for instantiating a EnvironmentCredential.
EnvironmentCredentialBuilder() - Constructor for class com.azure.identity.EnvironmentCredentialBuilder
executorService(ExecutorService) - Method in class com.azure.identity.AadCredentialBuilderBase: Specifies the ExecutorService to be used to execute the authentication requests.
executorService(ExecutorService) - Method in class com.azure.identity.DefaultAzureCredentialBuilder: Specifies the ExecutorService to be used to execute the authentication requests.
executorService(ExecutorService) - Method in class com.azure.identity.EnvironmentCredentialBuilder: Specifies the ExecutorService to be used to execute the authentication requests.

G

getAuthority() - Method in class com.azure.identity.AuthenticationRecord: Get the authority host used to authenticate the account.
getClientId() - Method in class com.azure.identity.AuthenticationRecord: Get the client id of the application used for authentication.
getClientId() - Method in class com.azure.identity.ManagedIdentityCredential: Gets the client ID of user assigned or system assigned identity.
getDeviceCode() - Method in class com.azure.identity.DeviceCodeInfo: Gets the code which should be included in the request for the access token.
getExpiresOn() - Method in class com.azure.identity.DeviceCodeInfo: Gets the expiration time of device code.
getHomeAccountId() - Method in class com.azure.identity.AuthenticationRecord: Get the unique identifier of the account.
getMessage() - Method in class com.azure.identity.DeviceCodeInfo: Gets the message which should be displayed to the user.
getName() - Method in class com.azure.identity.TokenCachePersistenceOptions: Get the name uniquely identifying the cache.
getTenantId() - Method in class com.azure.identity.AuthenticationRecord: Get the tenant, which the account authenticated in.
getToken(TokenRequestContext) - Method in class com.azure.identity.AuthorizationCodeCredential
getToken(TokenRequestContext) - Method in class com.azure.identity.AzureCliCredential
getToken(TokenRequestContext) - Method in class com.azure.identity.AzurePowerShellCredential
getToken(TokenRequestContext) - Method in class com.azure.identity.ChainedTokenCredential: Sequentially calls TokenCredential.getToken(TokenRequestContext) on all the specified credentials, returning the first successfully obtained AccessToken.
getToken(TokenRequestContext) - Method in class com.azure.identity.ClientCertificateCredential
getToken(TokenRequestContext) - Method in class com.azure.identity.ClientSecretCredential
getToken(TokenRequestContext) - Method in class com.azure.identity.DeviceCodeCredential
getToken(TokenRequestContext) - Method in class com.azure.identity.EnvironmentCredential
getToken(TokenRequestContext) - Method in class com.azure.identity.IntelliJCredential
getToken(TokenRequestContext) - Method in class com.azure.identity.InteractiveBrowserCredential
getToken(TokenRequestContext) - Method in class com.azure.identity.ManagedIdentityCredential
getToken(TokenRequestContext) - Method in class com.azure.identity.SharedTokenCacheCredential: Gets token from shared token cache
getToken(TokenRequestContext) - Method in class com.azure.identity.UsernamePasswordCredential
getToken(TokenRequestContext) - Method in class com.azure.identity.VisualStudioCodeCredential
getTokenRequestContext() - Method in exception com.azure.identity.AuthenticationRequiredException: Get the details of the authentication request which resulted in the authentication failure.
getUserCode() - Method in class com.azure.identity.DeviceCodeInfo: Gets the code which user needs to provide when authenticating at the verification URL.
getUsername() - Method in class com.azure.identity.AuthenticationRecord: Get the user principal name of the account.
getVerificationUrl() - Method in class com.azure.identity.DeviceCodeInfo: Gets the URL where user can authenticate.

H

httpClient(HttpClient) - Method in class com.azure.identity.CredentialBuilderBase: Sets the HTTP client to use for sending and receiving requests to and from the service.
httpPipeline(HttpPipeline) - Method in class com.azure.identity.CredentialBuilderBase: Specifies the HttpPipeline to send all requests.

I

IntelliJCredential - Class in com.azure.identity: A credential provider that provides token credentials from Azure Tools for IntelliJ plugin credential cache.
IntelliJCredentialBuilder - Class in com.azure.identity: Fluent credential builder for instantiating a IntelliJCredential.
IntelliJCredentialBuilder() - Constructor for class com.azure.identity.IntelliJCredentialBuilder
intelliJKeePassDatabasePath(String) - Method in class com.azure.identity.DefaultAzureCredentialBuilder: Specifies the KeePass database path to read the cached credentials of Azure toolkit for IntelliJ plugin.
InteractiveBrowserCredential - Class in com.azure.identity: An AAD credential that acquires a token for an AAD application by prompting the login in the default browser.
InteractiveBrowserCredentialBuilder - Class in com.azure.identity: Fluent credential builder for instantiating a InteractiveBrowserCredential.
InteractiveBrowserCredentialBuilder() - Constructor for class com.azure.identity.InteractiveBrowserCredentialBuilder
isUnencryptedStorageAllowed() - Method in class com.azure.identity.TokenCachePersistenceOptions: Gets the status whether unencrypted storage is allowed for the persistent token cache.

K

keePassDatabasePath(String) - Method in class com.azure.identity.IntelliJCredentialBuilder: Specifies the KeePass database path to read the cached credentials of Azure toolkit for IntelliJ plugin.

M

managedIdentityClientId(String) - Method in class com.azure.identity.DefaultAzureCredentialBuilder: Specifies the client ID of user assigned or system assigned identity, when this credential is running in an environment with managed identities.
ManagedIdentityCredential - Class in com.azure.identity: The base class for Managed Service Identity token based credentials.
ManagedIdentityCredentialBuilder - Class in com.azure.identity: Fluent credential builder for instantiating a ManagedIdentityCredential.
ManagedIdentityCredentialBuilder() - Constructor for class com.azure.identity.ManagedIdentityCredentialBuilder
maxRetry(int) - Method in class com.azure.identity.CredentialBuilderBase: Specifies the max number of retries when an authentication request fails.

P

password(String) - Method in class com.azure.identity.UsernamePasswordCredentialBuilder: Sets the password of the user.
pemCertificate(String) - Method in class com.azure.identity.ClientCertificateCredentialBuilder: Sets the path of the PEM certificate for authenticating to AAD.
pfxCertificate(String, String) - Method in class com.azure.identity.ClientCertificateCredentialBuilder: Sets the path and password of the PFX certificate for authenticating to AAD.
port(int) - Method in class com.azure.identity.InteractiveBrowserCredentialBuilder: Deprecated.
Configure the redirect URL as http://localhost:{port} via InteractiveBrowserCredentialBuilder.redirectUrl(String) instead.
proxyOptions(ProxyOptions) - Method in class com.azure.identity.CredentialBuilderBase: Deprecated.
Configure the proxy options on the HttpClient instead and then set that client on the credential using CredentialBuilderBase.httpClient(HttpClient).

R

redirectUrl(String) - Method in class com.azure.identity.AuthorizationCodeCredentialBuilder: Sets redirect URL for the Oauth 2.0 login request, which must be registered as a valid redirect URL on the application.
redirectUrl(String) - Method in class com.azure.identity.InteractiveBrowserCredentialBuilder: Sets the Redirect URL where STS will callback the application with the security code.
retryTimeout(Function<Duration, Duration>) - Method in class com.azure.identity.CredentialBuilderBase: Specifies a Function to calculate seconds of timeout on every retried request.

S

sendCertificateChain(boolean) - Method in class com.azure.identity.ClientCertificateCredentialBuilder: Specifies if the x5c claim (public key of the certificate) should be sent as part of the authentication request and enable subject name / issuer based authentication.
serialize(OutputStream) - Method in class com.azure.identity.AuthenticationRecord: Serializes the AuthenticationRecord to the specified OutputStream
serializeAsync(OutputStream) - Method in class com.azure.identity.AuthenticationRecord: Serializes the AuthenticationRecord to the specified OutputStream
setName(String) - Method in class com.azure.identity.TokenCachePersistenceOptions: Set the name uniquely identifying the cache.
setUnencryptedStorageAllowed(boolean) - Method in class com.azure.identity.TokenCachePersistenceOptions: Allows to use an unprotected file specified by cacheFileLocation() instead of Gnome keyring on Linux.
SharedTokenCacheCredential - Class in com.azure.identity: A credential provider that provides token credentials from the MSAL shared token cache.
SharedTokenCacheCredentialBuilder - Class in com.azure.identity: Fluent credential builder for instantiating a SharedTokenCacheCredential.
SharedTokenCacheCredentialBuilder() - Constructor for class com.azure.identity.SharedTokenCacheCredentialBuilder

T

tenantId(String) - Method in class com.azure.identity.AadCredentialBuilderBase: Sets the tenant ID of the application.
tenantId(String) - Method in class com.azure.identity.DefaultAzureCredentialBuilder: Sets the tenant id of the user to authenticate through the DefaultAzureCredential.
tenantId(String) - Method in class com.azure.identity.IntelliJCredentialBuilder: Sets the tenant id of the user to authenticate through the IntelliJCredential.
tenantId(String) - Method in class com.azure.identity.VisualStudioCodeCredentialBuilder: Sets the tenant id of the user to authenticate through the VisualStudioCodeCredential.
tokenCachePersistenceOptions(TokenCachePersistenceOptions) - Method in class com.azure.identity.ClientCertificateCredentialBuilder: Configures the persistent shared token cache options and enables the persistent token cache which is disabled by default.
tokenCachePersistenceOptions(TokenCachePersistenceOptions) - Method in class com.azure.identity.ClientSecretCredentialBuilder: Configures the persistent shared token cache options and enables the persistent token cache which is disabled by default.
tokenCachePersistenceOptions(TokenCachePersistenceOptions) - Method in class com.azure.identity.DeviceCodeCredentialBuilder: Configures the persistent shared token cache options and enables the persistent token cache which is disabled by default.
tokenCachePersistenceOptions(TokenCachePersistenceOptions) - Method in class com.azure.identity.InteractiveBrowserCredentialBuilder: Configures the persistent shared token cache options and enables the persistent token cache which is disabled by default.
tokenCachePersistenceOptions(TokenCachePersistenceOptions) - Method in class com.azure.identity.SharedTokenCacheCredentialBuilder: Configures the persistent shared token cache options and enables the persistent token cache which is disabled by default.
TokenCachePersistenceOptions - Class in com.azure.identity: Represents the Persistence Token Cache options used to setup the persistent access token cache.
TokenCachePersistenceOptions() - Constructor for class com.azure.identity.TokenCachePersistenceOptions
tokenCachePersistenceOptions(TokenCachePersistenceOptions) - Method in class com.azure.identity.UsernamePasswordCredentialBuilder: Configures the persistent shared token cache options and enables the persistent token cache which is disabled by default.

U

username(String) - Method in class com.azure.identity.SharedTokenCacheCredentialBuilder: Sets the username for the account.
username(String) - Method in class com.azure.identity.UsernamePasswordCredentialBuilder: Sets the username of the user.
UsernamePasswordCredential - Class in com.azure.identity: An AAD credential that acquires a token with a username and a password.
UsernamePasswordCredentialBuilder - Class in com.azure.identity: Fluent credential builder for instantiating a UsernamePasswordCredential.
UsernamePasswordCredentialBuilder() - Constructor for class com.azure.identity.UsernamePasswordCredentialBuilder

V

VisualStudioCodeCredential - Class in com.azure.identity: Enables authentication to Azure Active Directory using data from Visual Studio Code
VisualStudioCodeCredentialBuilder - Class in com.azure.identity: Fluent credential builder for instantiating a VisualStudioCodeCredential.
VisualStudioCodeCredentialBuilder() - Constructor for class com.azure.identity.VisualStudioCodeCredentialBuilder

A B C D E G H I K M P R S T U V