Package com.azure.security.keyvault.administration

Class KeyVaultAccessControlClientBuilder

java.lang.Object
com.azure.security.keyvault.administration.KeyVaultAccessControlClientBuilder
All Implemented Interfaces:
com.azure.core.client.traits.ConfigurationTrait<KeyVaultAccessControlClientBuilder>, com.azure.core.client.traits.HttpTrait<KeyVaultAccessControlClientBuilder>, com.azure.core.client.traits.TokenCredentialTrait<KeyVaultAccessControlClientBuilder>
public final class KeyVaultAccessControlClientBuilder extends Object implements com.azure.core.client.traits.TokenCredentialTrait<KeyVaultAccessControlClientBuilder>, com.azure.core.client.traits.HttpTrait<KeyVaultAccessControlClientBuilder>, com.azure.core.client.traits.ConfigurationTrait<KeyVaultAccessControlClientBuilder>
This class provides a fluent builder API to help aid the configuration and instantiation of the KeyVaultAccessControlAsyncClient and KeyVaultAccessControlClient, by calling buildAsyncClient() and buildClient() respectively. It constructs an instance of the desired client.

The minimal configuration options required by KeyVaultAccessControlClientBuilder to build an an KeyVaultAccessControlAsyncClient are vaultUrl and credential.

Samples to construct a sync client

 KeyVaultAccessControlClient keyVaultAccessControlClient = new KeyVaultAccessControlClientBuilder()
     .vaultUrl("<your-managed-hsm-url>")
     .credential(new DefaultAzureCredentialBuilder().build())
     .buildClient();

Samples to construct an async client

 KeyVaultAccessControlAsyncClient keyVaultAccessControlAsyncClient = new KeyVaultAccessControlClientBuilder()
     .vaultUrl("<your-managed-hsm-url>")
     .credential(new DefaultAzureCredentialBuilder().build())
     .buildAsyncClient();
See Also:

  • Constructor Details

  • Method Details

    • buildClient

      public KeyVaultAccessControlClient buildClient()
      Creates an KeyVaultAccessControlClient based on options set in the Builder. Every time buildClient() is called a new instance of KeyVaultAccessControlClient is created.

      If pipeline is set, then only the pipeline and vaultUrl are used to create the client. All other builder settings are ignored.

      Returns:
      An KeyVaultAccessControlClient with the options set from the builder.
      Throws:
      NullPointerException - If vaultUrl is null.
      IllegalStateException - If both retryOptions(RetryOptions) and retryPolicy(RetryPolicy) have been set.

    • buildAsyncClient

      public KeyVaultAccessControlAsyncClient buildAsyncClient()
      Creates a KeyVaultAccessControlAsyncClient based on options set in the Builder. Every time buildAsyncClient() is called a new instance of KeyVaultAccessControlAsyncClient is created.

      If pipeline is set, then only the pipeline and endpoint are used to create the client. All other builder settings are ignored.

      Returns:
      An KeyVaultAccessControlAsyncClient with the options set from the builder.
      Throws:
      NullPointerException - If vaultUrl is null.
      IllegalStateException - If both retryOptions(RetryOptions) and retryPolicy(RetryPolicy) have been set.

    • vaultUrl

      public KeyVaultAccessControlClientBuilder vaultUrl(String vaultUrl)
      Sets the URL to the Key Vault on which the client operates. Appears as "DNS Name" in the Azure portal. You should validate that this URL references a valid Key Vault or Managed HSM resource. Refer to the following documentation for details.
      Parameters:
      vaultUrl - The vault URL is used as destination on Azure to send requests to.
      Returns:
      The updated KeyVaultAccessControlClientBuilder object.
      Throws:
      IllegalArgumentException - If vaultUrl cannot be parsed into a valid URL.
      NullPointerException - If credential is null.

    • credential

      public KeyVaultAccessControlClientBuilder credential(com.azure.core.credential.TokenCredential credential)
      Sets the TokenCredential used to authorize requests sent to the service. Refer to the Azure SDK for Java identity and authentication documentation for more details on proper usage of the TokenCredential type.
      Specified by:
      credential in interface com.azure.core.client.traits.TokenCredentialTrait<KeyVaultAccessControlClientBuilder>
      Parameters:
      credential - TokenCredential used to authorize requests sent to the service.
      Returns:
      The updated KeyVaultAccessControlClientBuilder object.
      Throws:
      NullPointerException - If credential is null.

    • httpLogOptions

      public KeyVaultAccessControlClientBuilder httpLogOptions(com.azure.core.http.policy.HttpLogOptions logOptions)
      Sets the logging configuration to use when sending and receiving requests to and from the service. If a logLevel is not provided, default value of HttpLogDetailLevel.NONE is set.

      Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if a HttpPipeline is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no HttpPipeline is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if an HttpPipeline is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.

      Specified by:
      httpLogOptions in interface com.azure.core.client.traits.HttpTrait<KeyVaultAccessControlClientBuilder>
      Parameters:
      logOptions - The logging configuration to use when sending and receiving requests to and from the service.
      Returns:
      The updated KeyVaultAccessControlClientBuilder object.

    • addPolicy

      public KeyVaultAccessControlClientBuilder addPolicy(com.azure.core.http.policy.HttpPipelinePolicy policy)
      Adds a pipeline policy to apply on each request sent.

      Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if a HttpPipeline is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no HttpPipeline is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if an HttpPipeline is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.

      Specified by:
      addPolicy in interface com.azure.core.client.traits.HttpTrait<KeyVaultAccessControlClientBuilder>
      Parameters:
      policy - A pipeline policy.
      Returns:
      The updated KeyVaultAccessControlClientBuilder object.
      Throws:
      NullPointerException - If policy is null.

    • httpClient

      public KeyVaultAccessControlClientBuilder httpClient(com.azure.core.http.HttpClient client)
      Sets the HttpClient to use for sending and receiving requests to and from the service.

      Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if a HttpPipeline is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no HttpPipeline is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if an HttpPipeline is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.

      Specified by:
      httpClient in interface com.azure.core.client.traits.HttpTrait<KeyVaultAccessControlClientBuilder>
      Parameters:
      client - The HttpClient to use for requests.
      Returns:
      The updated KeyVaultAccessControlClientBuilder object.

    • pipeline

      public KeyVaultAccessControlClientBuilder pipeline(com.azure.core.http.HttpPipeline pipeline)
      Sets the HttpPipeline to use for the service client.

      Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if a HttpPipeline is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no HttpPipeline is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if an HttpPipeline is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.

      The vaultUrl is not ignored when pipeline is set.

      Specified by:
      pipeline in interface com.azure.core.client.traits.HttpTrait<KeyVaultAccessControlClientBuilder>
      Parameters:
      pipeline - HttpPipeline to use for sending service requests and receiving responses.
      Returns:
      The updated KeyVaultAccessControlClientBuilder object.

    • configuration

      public KeyVaultAccessControlClientBuilder 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.

      Specified by:
      configuration in interface com.azure.core.client.traits.ConfigurationTrait<KeyVaultAccessControlClientBuilder>
      Parameters:
      configuration - The configuration store used to get configuration details.
      Returns:
      The updated KeyVaultAccessControlClientBuilder object.

    • retryPolicy

      public KeyVaultAccessControlClientBuilder 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.

      Setting this is mutually exclusive with using retryOptions(RetryOptions).

      Parameters:
      retryPolicy - User's retry policy applied to each request.
      Returns:
      The updated KeyVaultAccessControlClientBuilder object.

    • retryOptions

      public KeyVaultAccessControlClientBuilder retryOptions(com.azure.core.http.policy.RetryOptions retryOptions)
      Sets the RetryOptions for all the requests made through the client.

      Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if a HttpPipeline is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no HttpPipeline is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if an HttpPipeline is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.

      Setting this is mutually exclusive with using retryPolicy(RetryPolicy).

      Specified by:
      retryOptions in interface com.azure.core.client.traits.HttpTrait<KeyVaultAccessControlClientBuilder>
      Parameters:
      retryOptions - The RetryOptions to use for all the requests made through the client.
      Returns:
      The updated KeyVaultAccessControlClientBuilder object.

    • clientOptions

      public KeyVaultAccessControlClientBuilder clientOptions(com.azure.core.util.ClientOptions clientOptions)
      Allows for setting common properties such as application ID, headers, proxy configuration, etc. Note that it is recommended that this method be called with an instance of the HttpClientOptions class (a subclass of the ClientOptions base class). The HttpClientOptions subclass provides more configuration options suitable for HTTP clients, which is applicable for any class that implements this HttpTrait interface.

      Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if a HttpPipeline is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no HttpPipeline is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if an HttpPipeline is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.

      Specified by:
      clientOptions in interface com.azure.core.client.traits.HttpTrait<KeyVaultAccessControlClientBuilder>
      Parameters:
      clientOptions - A configured instance of HttpClientOptions.
      Returns:
      The updated KeyVaultAccessControlClientBuilder object.
      See Also:
      • HttpClientOptions

    • serviceVersion

      public KeyVaultAccessControlClientBuilder serviceVersion(KeyVaultAdministrationServiceVersion serviceVersion)
      Sets the KeyVaultAdministrationServiceVersion 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:
      serviceVersion - KeyVaultAdministrationServiceVersion of the service API used when making requests.
      Returns:
      The updated KeyVaultAccessControlClientBuilder object.

    • disableChallengeResourceVerification

      public KeyVaultAccessControlClientBuilder disableChallengeResourceVerification()
      Disables verifying if the authentication challenge resource matches the Key Vault or Managed HSM domain. This verification is performed by default.
      Returns:
      The updated KeyVaultAccessControlClientBuilder object.