org.springframework.vault.authentication

Class AzureMsiAuthenticationOptions.AzureMsiAuthenticationOptionsBuilder

java.lang.Object

org.springframework.vault.authentication.AzureMsiAuthenticationOptions.AzureMsiAuthenticationOptionsBuilder

Enclosing class:

AzureMsiAuthenticationOptions

public static class AzureMsiAuthenticationOptions.AzureMsiAuthenticationOptionsBuilder
extends Object

Builder for AzureMsiAuthenticationOptions.

Method Summary

Modifier and Type	Method and Description
AzureMsiAuthenticationOptions	build() Build a new AzureMsiAuthenticationOptions instance.
AzureMsiAuthenticationOptions.AzureMsiAuthenticationOptionsBuilder	identityTokenServiceUri(URI identityTokenServiceUri) Configure the managed identity service token URI.
AzureMsiAuthenticationOptions.AzureMsiAuthenticationOptionsBuilder	instanceMetadataUri(URI instanceMetadataServiceUri) Configure the instance metadata URI.
AzureMsiAuthenticationOptions.AzureMsiAuthenticationOptionsBuilder	path(String path) Configure the mount path, defaults to azure.
AzureMsiAuthenticationOptions.AzureMsiAuthenticationOptionsBuilder	role(String role) Configure the name of the role against which the login is being attempted.
AzureMsiAuthenticationOptions.AzureMsiAuthenticationOptionsBuilder	vmEnvironment(AzureVmEnvironment vmEnvironment) Configure a VM environment (subscriptionId, resource group name, VM name).

Methods inherited from class java.lang.Object

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

Method Detail

path

public AzureMsiAuthenticationOptions.AzureMsiAuthenticationOptionsBuilder path(String path)

Configure the mount path, defaults to azure.

Parameters:

path - must not be empty or null.

Returns:

this AzureMsiAuthenticationOptions.AzureMsiAuthenticationOptionsBuilder.

role

public AzureMsiAuthenticationOptions.AzureMsiAuthenticationOptionsBuilder role(String role)

Configure the name of the role against which the login is being attempted.

Parameters:

role - must not be empty or null.

Returns:

this AzureMsiAuthenticationOptions.AzureMsiAuthenticationOptionsBuilder.

vmEnvironment

public AzureMsiAuthenticationOptions.AzureMsiAuthenticationOptionsBuilder vmEnvironment(AzureVmEnvironment vmEnvironment)

Configure a VM environment (subscriptionId, resource group name, VM name). Environment details are passed to Vault as login body. If left unconfigured, AzureMsiAuthentication looks up the details from the instance metadata service.

Parameters:

vmEnvironment - must not be null.

Returns:

this AzureMsiAuthenticationOptions.AzureMsiAuthenticationOptionsBuilder.

instanceMetadataUri

public AzureMsiAuthenticationOptions.AzureMsiAuthenticationOptionsBuilder instanceMetadataUri(URI instanceMetadataServiceUri)

Configure the instance metadata URI.

Parameters:

instanceMetadataServiceUri - must not be null.

Returns:

this AzureMsiAuthenticationOptions.AzureMsiAuthenticationOptionsBuilder.

See Also:

AzureMsiAuthenticationOptions.DEFAULT_IDENTITY_TOKEN_SERVICE_URI

identityTokenServiceUri

public AzureMsiAuthenticationOptions.AzureMsiAuthenticationOptionsBuilder identityTokenServiceUri(URI identityTokenServiceUri)

Configure the managed identity service token URI.

Parameters:

identityTokenServiceUri - must not be null.

Returns:

this AzureMsiAuthenticationOptions.AzureMsiAuthenticationOptionsBuilder.

See Also:

AzureMsiAuthenticationOptions.DEFAULT_IDENTITY_TOKEN_SERVICE_URI

build

public AzureMsiAuthenticationOptions build()

Build a new AzureMsiAuthenticationOptions instance.

Returns:

a new AzureMsiAuthenticationOptions.