Package com.azure.resourcemanager.keyvault.models

Interface Vaults

All Superinterfaces:
com.azure.resourcemanager.resources.fluentcore.arm.models.HasManager<KeyVaultManager>, com.azure.resourcemanager.resources.fluentcore.collection.SupportsCreating<Vault.DefinitionStages.Blank>, com.azure.resourcemanager.resources.fluentcore.collection.SupportsDeletingById, com.azure.resourcemanager.resources.fluentcore.arm.collection.SupportsDeletingByResourceGroup, com.azure.resourcemanager.resources.fluentcore.arm.collection.SupportsGettingById<Vault>, com.azure.resourcemanager.resources.fluentcore.arm.collection.SupportsGettingByResourceGroup<Vault>, com.azure.resourcemanager.resources.fluentcore.arm.collection.SupportsListingByResourceGroup<Vault>
public interface Vaults extends com.azure.resourcemanager.resources.fluentcore.collection.SupportsCreating<Vault.DefinitionStages.Blank>, com.azure.resourcemanager.resources.fluentcore.collection.SupportsDeletingById, com.azure.resourcemanager.resources.fluentcore.arm.collection.SupportsListingByResourceGroup<Vault>, com.azure.resourcemanager.resources.fluentcore.arm.collection.SupportsGettingByResourceGroup<Vault>, com.azure.resourcemanager.resources.fluentcore.arm.collection.SupportsGettingById<Vault>, com.azure.resourcemanager.resources.fluentcore.arm.collection.SupportsDeletingByResourceGroup, com.azure.resourcemanager.resources.fluentcore.arm.models.HasManager<KeyVaultManager>
Entry point for key vaults management API.

  • Method Summary

    Modifier and Type
    Method
    Description
    CheckNameAvailabilityResult
    checkNameAvailability(String name)
    Checks that the vault name is valid and is not already in use.
    Mono<CheckNameAvailabilityResult>
    checkNameAvailabilityAsync(String name)
    Checks that the vault name is valid and is not already in use.
    DeletedVault
    getDeleted(String vaultName, String location)
    Gets the deleted Azure key vault.
    Mono<DeletedVault>
    getDeletedAsync(String vaultName, String location)
    Gets the deleted Azure key vault.
    com.azure.core.http.rest.PagedIterable<DeletedVault>
    listDeleted()
    Gets information about the deleted vaults in a subscription.
    com.azure.core.http.rest.PagedFlux<DeletedVault>
    listDeletedAsync()
    Gets information about the deleted vaults in a subscription.
    void
    purgeDeleted(String vaultName, String location)
    Permanently deletes the specified vault. aka Purges the deleted Azure key vault.
    Mono<Void>
    purgeDeletedAsync(String vaultName, String location)
    Permanently deletes the specified vault. aka Purges the deleted Azure key vault.
    Vault
    recoverSoftDeletedVault(String resourceGroupName, String vaultName, String location)
    Recovers a soft deleted vault.
    Mono<Vault>
    recoverSoftDeletedVaultAsync(String resourceGroupName, String vaultName, String location)
    Recovers a soft deleted vault.

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.HasManager

    manager

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.collection.SupportsCreating

    define

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.collection.SupportsDeletingById

    deleteById, deleteByIdAsync

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.collection.SupportsDeletingByResourceGroup

    deleteByResourceGroup, deleteByResourceGroupAsync

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.collection.SupportsGettingById

    getById, getByIdAsync

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.collection.SupportsGettingByResourceGroup

    getByResourceGroup, getByResourceGroupAsync

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.collection.SupportsListingByResourceGroup

    listByResourceGroup, listByResourceGroupAsync

  • 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