Package com.azure.resourcemanager.keyvault.models

Interface Vaults

All Superinterfaces:
HasManager<KeyVaultManager>, SupportsCreating<Vault.DefinitionStages.Blank>, SupportsDeletingById, SupportsDeletingByResourceGroup, SupportsGettingById<Vault>, SupportsGettingByResourceGroup<Vault>, SupportsListingByResourceGroup<Vault>
public interface Vaults extends SupportsCreating<Vault.DefinitionStages.Blank>, SupportsDeletingById, SupportsListingByResourceGroup<Vault>, SupportsGettingByResourceGroup<Vault>, SupportsGettingById<Vault>, SupportsDeletingByResourceGroup, HasManager<KeyVaultManager>
Entry point for key vaults management API.

  • Method Details

    • listDeleted

      com.azure.core.http.rest.PagedIterable<DeletedVault> listDeleted()
      Gets information about the deleted vaults in a subscription.
      Returns:
      the PagedList<DeletedVault> object if successful.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent

    • listDeletedAsync

      com.azure.core.http.rest.PagedFlux<DeletedVault> listDeletedAsync()
      Gets information about the deleted vaults in a subscription.
      Returns:
      the observable to the PagedList<DeletedVault> object
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation

    • getDeleted

      DeletedVault getDeleted(String vaultName, String location)
      Gets the deleted Azure key vault.
      Parameters:
      vaultName - The name of the vault.
      location - The location of the deleted vault.
      Returns:
      the DeletedVault object if successful.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent

    • getDeletedAsync

      Mono<DeletedVault> getDeletedAsync(String vaultName, String location)
      Gets the deleted Azure key vault.
      Parameters:
      vaultName - The name of the vault.
      location - The location of the deleted vault.
      Returns:
      the Mono object
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation

    • purgeDeleted

      void purgeDeleted(String vaultName, String location)
      Permanently deletes the specified vault. aka Purges the deleted Azure key vault.
      Parameters:
      vaultName - The name of the soft-deleted vault.
      location - The location of the soft-deleted vault.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent

    • purgeDeletedAsync

      Mono<Void> purgeDeletedAsync(String vaultName, String location)
      Permanently deletes the specified vault. aka Purges the deleted Azure key vault.
      Parameters:
      vaultName - The name of the soft-deleted vault.
      location - The location of the soft-deleted vault.
      Returns:
      the observable for the request
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation

    • checkNameAvailability

      CheckNameAvailabilityResult checkNameAvailability(String name)
      Checks that the vault name is valid and is not already in use.
      Parameters:
      name - The vault name.
      Returns:
      the CheckNameAvailabilityResult object if successful.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent

    • checkNameAvailabilityAsync

      Mono<CheckNameAvailabilityResult> checkNameAvailabilityAsync(String name)
      Checks that the vault name is valid and is not already in use.
      Parameters:
      name - The vault name.
      Returns:
      the observable to the CheckNameAvailabilityResult object
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation

    • recoverSoftDeletedVault

      Vault recoverSoftDeletedVault(String resourceGroupName, String vaultName, String location)
      Recovers a soft deleted vault.
      Parameters:
      resourceGroupName - The name of the Resource Group to which the server belongs.
      vaultName - Name of the vault
      location - The location of the deleted vault.
      Returns:
      the recovered Vault object if successful

    • recoverSoftDeletedVaultAsync

      Mono<Vault> recoverSoftDeletedVaultAsync(String resourceGroupName, String vaultName, String location)
      Recovers a soft deleted vault.
      Parameters:
      resourceGroupName - The name of the Resource Group to which the server belongs.
      vaultName - Name of the vault
      location - The location of the deleted vault.
      Returns:
      the recovered Vault object if successful