Package com.azure.security.keyvault.secrets

Class SecretClientBuilder

  • public final class SecretClientBuilder
extends Object
    This class provides a fluent builder API to help aid the configuration and instantiation of the secret async client and secret client, by calling buildAsyncClient and buildClient respectively. It constructs an instance of the desired client.

    The minimal configuration options required by secretClientBuilder to build SecretAsyncClient are vaultUrl and credential. 

     SecretAsyncClient secretAsyncClient = new SecretClientBuilder()
     .credential(new DefaultAzureCredentialBuilder().build())
     .vaultUrl("https://myvault.vault.azure.net/")
     .httpLogOptions(new HttpLogOptions().setLogLevel(HttpLogDetailLevel.BODY_AND_HEADERS))
     .buildAsyncClient();

    Samples to construct the sync client

     SecretClient secretClient = new SecretClientBuilder()
     .credential(new DefaultAzureCredentialBuilder().build())
     .vaultUrl("https://myvault.vault.azure.net/")
     .httpLogOptions(new HttpLogOptions().setLogLevel(HttpLogDetailLevel.BODY_AND_HEADERS))
     .buildClient();

    The log detail level, multiple custom policies and custom http client can be optionally configured in the SecretClientBuilder.

     SecretAsyncClient secretAsyncClient = new SecretClientBuilder()
     .httpLogOptions(new HttpLogOptions().setLogLevel(HttpLogDetailLevel.BODY_AND_HEADERS))
     .vaultUrl("https://myvault.azure.net/")
     .credential(new DefaultAzureCredentialBuilder().build())
     .httpClient(HttpClient.createDefault())
     .buildAsyncClient();

    Alternatively, custom http pipeline with custom HttpPipelinePolicy policies and vaultUrl can be specified. It provides finer control over the construction of client

     HttpPipeline pipeline = new HttpPipelineBuilder()
     .policies(new KeyVaultCredentialPolicy(credential), new RetryPolicy())
     .build();
 SecretAsyncClient secretAsyncClient = new SecretClientBuilder()
     .pipeline(pipeline)
     .vaultUrl("https://myvault.azure.net/")
     .buildAsyncClient();
    See Also:
    SecretClient, SecretAsyncClient

    • Constructor Detail

      • SecretClientBuilder

        public SecretClientBuilder()
        The constructor with defaults.

    • Method Detail

      • credential

        public SecretClientBuilder credential​(com.azure.core.credential.TokenCredential credential)
        Sets the credential to use when authenticating HTTP requests.
        Parameters:
        credential - The credential to use for authenticating HTTP requests.
        Returns:
        The updated SecretClientBuilder object.
        Throws:
        NullPointerException - If credential is null.

      • httpLogOptions

        public SecretClientBuilder httpLogOptions​(com.azure.core.http.policy.HttpLogOptions logOptions)
        Sets the logging configuration for HTTP requests and responses.

        If logLevel is not provided, default value of HttpLogDetailLevel.NONE is set.

        Parameters:
        logOptions - The logging configuration to use when sending and receiving HTTP requests/responses.
        Returns:
        The updated SecretClientBuilder object.

      • httpClient

        public SecretClientBuilder httpClient​(com.azure.core.http.HttpClient client)
        Sets the HTTP client to use for sending and receiving requests to and from the service.
        Parameters:
        client - The HTTP client to use for requests.
        Returns:
        The updated SecretClientBuilder object.

      • pipeline

        public SecretClientBuilder pipeline​(com.azure.core.http.HttpPipeline pipeline)
        Sets the HTTP pipeline to use for the service client. If pipeline is set, all other settings are ignored, aside from vaultUrl to build SecretAsyncClient or SecretClient.
        Parameters:
        pipeline - The HTTP pipeline to use for sending service requests and receiving responses.
        Returns:
        The updated SecretClientBuilder object.

      • configuration

        public SecretClientBuilder configuration​(com.azure.core.util.Configuration configuration)
        Sets the configuration store that is used during construction of the service client. The default configuration store is a clone of the global configuration store, use Configuration.NONE to bypass using configuration settings during construction.
        Parameters:
        configuration - The configuration store used to
        Returns:
        The updated SecretClientBuilder object.

      • serviceVersion

        public SecretClientBuilder serviceVersion​(SecretServiceVersion version)
        Sets the SecretServiceVersion that is used when making API requests.

        If a service version is not provided, the service version that will be used will be the latest known service version based on the version of the client library being used. If no service version is specified, updating to a newer version the client library will have the result of potentially moving to a newer service version.

        Parameters:
        version - SecretServiceVersion of the service API used when making requests.
        Returns:
        The updated SecretClientBuilder object.

      • retryPolicy

        public SecretClientBuilder retryPolicy​(com.azure.core.http.policy.RetryPolicy retryPolicy)
        Sets the RetryPolicy that is used when each request is sent. The default retry policy will be used in the pipeline, if not provided.
        Parameters:
        retryPolicy - user's retry policy applied to each request.
        Returns:
        The updated SecretClientBuilder object.

      • clientOptions

        public SecretClientBuilder clientOptions​(com.azure.core.util.ClientOptions clientOptions)
        Sets the ClientOptions which enables various options to be set on the client. For example setting an applicationId using ClientOptions.setApplicationId(String) to configure the UserAgentPolicy for telemetry/monitoring purposes.

        More About Azure Core: Telemetry policy

        Parameters:
        clientOptions - the ClientOptions to be set on the client.
        Returns:
        The updated SecretClientBuilder object.