Package com.azure.security.keyvault.administration

Class KeyVaultSettingsAsyncClient

java.lang.Object
com.azure.security.keyvault.administration.KeyVaultSettingsAsyncClient
public final class KeyVaultSettingsAsyncClient extends Object
The KeyVaultSettingsAsyncClient provides asynchronous methods to create, update, get and list settings for the Azure Key Vault.

Instances of this client are obtained by calling the KeyVaultSettingsClientBuilder.buildAsyncClient() method on a KeyVaultSettingsClientBuilder object.

See Also:

  • Method Details

    • updateSetting

      public Mono<KeyVaultSetting> updateSetting(KeyVaultSetting setting)
      Updates a given account setting.
      Parameters:
      setting - The account setting to update.
      Returns:
      A Mono containing the updated account setting.
      Throws:
      NullPointerException - if setting is null.
      IllegalArgumentException - thrown if name or value is null or empty.
      com.azure.security.keyvault.administration.implementation.models.KeyVaultErrorException - thrown if the request is rejected by the server.

    • updateSettingWithResponse

      public Mono<com.azure.core.http.rest.Response<KeyVaultSetting>> updateSettingWithResponse(KeyVaultSetting setting)
      Updates a given account setting.
      Parameters:
      setting - The account setting to update.
      Returns:
      A Mono containing a Response whose value contains the updated account setting.
      Throws:
      NullPointerException - if setting is null.
      IllegalArgumentException - thrown if name is null or empty.
      com.azure.security.keyvault.administration.implementation.models.KeyVaultErrorException - thrown if the request is rejected by the server.

    • getSetting

      public Mono<KeyVaultSetting> getSetting(String name)
      Get the value of a specific account setting.
      Parameters:
      name - The name of setting to retrieve the value of.
      Returns:
      A Mono containing the account setting.
      Throws:
      IllegalArgumentException - thrown if name is null or empty.
      com.azure.security.keyvault.administration.implementation.models.KeyVaultErrorException - thrown if the request is rejected by the server.

    • getSettingWithResponse

      public Mono<com.azure.core.http.rest.Response<KeyVaultSetting>> getSettingWithResponse(String name)
      Get the value of a specific account setting.
      Parameters:
      name - The name of setting to retrieve the value of.
      Returns:
      A Mono containing a Response whose value contains the account setting.
      Throws:
      IllegalArgumentException - thrown if name is null or empty.
      com.azure.security.keyvault.administration.implementation.models.KeyVaultErrorException - thrown if the request is rejected by the server.

    • listSettings

      public Mono<KeyVaultListSettingsResult> listSettings()
      List the account's settings.
      Returns:
      A Mono containing a result object wrapping the list of account settings.
      Throws:
      com.azure.security.keyvault.administration.implementation.models.KeyVaultErrorException - thrown if the request is rejected by the server.

    • listSettingsWithResponse

      public Mono<com.azure.core.http.rest.Response<KeyVaultListSettingsResult>> listSettingsWithResponse()
      List the account's settings.
      Returns:
      A Mono containing a Response whose value contains a result object wrapping the list of account settings.
      Throws:
      com.azure.security.keyvault.administration.implementation.models.KeyVaultErrorException - thrown if the request is rejected by the server.