Package com.azure.security.keyvault.administration

Class KeyVaultSettingsClient

java.lang.Object
com.azure.security.keyvault.administration.KeyVaultSettingsClient
public final class KeyVaultSettingsClient extends Object
The KeyVaultSettingsClient 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.buildClient() method on a KeyVaultSettingsClientBuilder object.

See Also:

  • Method Details

    • updateSetting

      public KeyVaultSetting updateSetting(KeyVaultSetting setting)
      Updates a given account setting.
      Parameters:
      setting - The account setting to update.
      Returns:
      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.

    • updateSettingWithResponse

      public com.azure.core.http.rest.Response<KeyVaultSetting> updateSettingWithResponse(KeyVaultSetting setting, com.azure.core.util.Context context)
      Updates a given account setting.
      Parameters:
      setting - The account setting to update.
      context - Additional Context that is passed through the HTTP pipeline during the service call.
      Returns:
      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 KeyVaultSetting getSetting(String name)
      Get the value of a specific account setting.
      Parameters:
      name - The name of setting to retrieve the value of.
      Returns:
      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 com.azure.core.http.rest.Response<KeyVaultSetting> getSettingWithResponse(String name, com.azure.core.util.Context context)
      Get the value of a specific account setting.
      Parameters:
      name - The name of setting to retrieve the value of.
      context - Additional Context that is passed through the HTTP pipeline during the service call.
      Returns:
      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 KeyVaultListSettingsResult listSettings()
      List the account's settings.
      Returns:
      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 com.azure.core.http.rest.Response<KeyVaultListSettingsResult> listSettingsWithResponse(com.azure.core.util.Context context)
      List the account's settings.
      Parameters:
      context - Additional Context that is passed through the HTTP pipeline during the service call.
      Returns:
      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.