Share via

Vaults Interface

  • Reference
Package:
com.azure.resourcemanager.keyvault.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-keyvault:2.44.0

Implements

SupportsDeletingByResourceGroup SupportsGettingById<Vault> SupportsGettingByResourceGroup<Vault> SupportsListingByResourceGroup<Vault> HasManager<KeyVaultManager> SupportsCreating<Blank> SupportsDeletingById

public interface Vaults
extends SupportsCreating<Blank>, SupportsDeletingById, SupportsListingByResourceGroup<Vault>, SupportsGettingByResourceGroup<Vault>, SupportsGettingById<Vault>, SupportsDeletingByResourceGroup, HasManager<KeyVaultManager>

Entry point for key vaults management API.

Method Summary

Modifier and Type Method and Description
abstract CheckNameAvailabilityResult checkNameAvailability(String name)

Checks that the vault name is valid and is not already in use.
abstract Mono<CheckNameAvailabilityResult> checkNameAvailabilityAsync(String name)

Checks that the vault name is valid and is not already in use.
abstract DeletedVault getDeleted(String vaultName, String location)

Gets the deleted Azure key vault.
abstract Mono<DeletedVault> getDeletedAsync(String vaultName, String location)

Gets the deleted Azure key vault.
abstract PagedIterable<DeletedVault> listDeleted()

Gets information about the deleted vaults in a subscription.
abstract PagedFlux<DeletedVault> listDeletedAsync()

Gets information about the deleted vaults in a subscription.
abstract void purgeDeleted(String vaultName, String location)

Permanently deletes the specified vault.
abstract Mono<Void> purgeDeletedAsync(String vaultName, String location)

Permanently deletes the specified vault.
abstract Vault recoverSoftDeletedVault(String resourceGroupName, String vaultName, String location)

Recovers a soft deleted vault.
abstract Mono<Vault> recoverSoftDeletedVaultAsync(String resourceGroupName, String vaultName, String location)

Recovers a soft deleted vault.

Method Details

checkNameAvailability

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

checkNameAvailabilityAsync

public abstract Mono 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

getDeleted

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

getDeletedAsync

public abstract Mono 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

listDeleted

public abstract PagedIterable listDeleted()

Gets information about the deleted vaults in a subscription.

Returns:

the PagedList<DeletedVault> object if successful.

listDeletedAsync

public abstract PagedFlux listDeletedAsync()

Gets information about the deleted vaults in a subscription.

Returns:

the observable to the PagedList<DeletedVault> object

purgeDeleted

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

purgeDeletedAsync

public abstract Mono 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

recoverSoftDeletedVault

public abstract 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

public abstract Mono 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

Applies to