Package org.springframework.vault.authentication

Class AzureMsiAuthenticationOptions

java.lang.Object

org.springframework.vault.authentication.AzureMsiAuthenticationOptions

public class AzureMsiAuthenticationOptions
extends Object

Authentication options for AzureMsiAuthentication.

Authentication options provide the path, role, an optional AzureVmEnvironment, and instance metadata/OAuth2 token URIs. AzureMsiAuthenticationOptions can be constructed using builder(). Instances of this class are immutable once constructed.

Since:

2.1

Author:

Mark Paluch

See Also:

• AzureMsiAuthenticationOptions
• builder()

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AzureMsiAuthenticationOptions.AzureMsiAuthenticationOptionsBuilder	Builder for AzureMsiAuthenticationOptions.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_AZURE_AUTHENTICATION_PATH
static final URI	DEFAULT_IDENTITY_TOKEN_SERVICE_URI
static final URI	DEFAULT_INSTANCE_METADATA_SERVICE_URI

Method Summary

Modifier and Type	Method	Description
static AzureMsiAuthenticationOptions.AzureMsiAuthenticationOptionsBuilder	builder()
URI	getIdentityTokenServiceUri()
URI	getInstanceMetadataServiceUri()
String	getPath()
String	getRole()
AzureVmEnvironment	getVmEnvironment()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

DEFAULT_AZURE_AUTHENTICATION_PATH

public static final String DEFAULT_AZURE_AUTHENTICATION_PATH

See Also:

• Constant Field Values

DEFAULT_INSTANCE_METADATA_SERVICE_URI

public static final URI DEFAULT_INSTANCE_METADATA_SERVICE_URI

DEFAULT_IDENTITY_TOKEN_SERVICE_URI

public static final URI DEFAULT_IDENTITY_TOKEN_SERVICE_URI

Method Details

builder

public static AzureMsiAuthenticationOptions.AzureMsiAuthenticationOptionsBuilder builder()

Returns:

a new AzureMsiAuthenticationOptions.AzureMsiAuthenticationOptionsBuilder.

getPath

public String getPath()

Returns:

the path of the azure authentication backend mount.

getRole

public String getRole()

Returns:

the role against which the login is being attempted.

getVmEnvironment

@Nullable
public AzureVmEnvironment getVmEnvironment()

Returns:

the AzureVmEnvironment. If null, the environment is retrieved from the VM instance metadata service.

getInstanceMetadataServiceUri

public URI getInstanceMetadataServiceUri()

Returns:

URI to the instance metadata endpoint.

getIdentityTokenServiceUri

public URI getIdentityTokenServiceUri()

Returns:

URI to the token service for the managed identity.