Vaults interface

Package:

@azure/arm-keyvault

Interface representing a Vaults.

Methods

beginCreateOrUpdate(string, string, VaultCreateOrUpdateParameters, VaultsCreateOrUpdateOptionalParams)	Create or update a key vault in the specified subscription.
beginCreateOrUpdateAndWait(string, string, VaultCreateOrUpdateParameters, VaultsCreateOrUpdateOptionalParams)	Create or update a key vault in the specified subscription.
beginPurgeDeleted(string, string, VaultsPurgeDeletedOptionalParams)	Permanently deletes the specified vault. aka Purges the deleted Azure key vault.
beginPurgeDeletedAndWait(string, string, VaultsPurgeDeletedOptionalParams)	Permanently deletes the specified vault. aka Purges the deleted Azure key vault.
checkNameAvailability(VaultCheckNameAvailabilityParameters, VaultsCheckNameAvailabilityOptionalParams)	Checks that the vault name is valid and is not already in use.
delete(string, string, VaultsDeleteOptionalParams)	Deletes the specified Azure key vault.
get(string, string, VaultsGetOptionalParams)	Gets the specified Azure key vault.
getDeleted(string, string, VaultsGetDeletedOptionalParams)	Gets the deleted Azure key vault.
list(VaultsListOptionalParams)	The List operation gets information about the vaults associated with the subscription.
listByResourceGroup(string, VaultsListByResourceGroupOptionalParams)	The List operation gets information about the vaults associated with the subscription and within the specified resource group.
listBySubscription(VaultsListBySubscriptionOptionalParams)	The List operation gets information about the vaults associated with the subscription.
listDeleted(VaultsListDeletedOptionalParams)	Gets information about the deleted vaults in a subscription.
update(string, string, VaultPatchParameters, VaultsUpdateOptionalParams)	Update a key vault in the specified subscription.
updateAccessPolicy(string, string, AccessPolicyUpdateKind, VaultAccessPolicyParameters, VaultsUpdateAccessPolicyOptionalParams)	Update access policies in a key vault in the specified subscription.

Method Details

beginCreateOrUpdate(string, string, VaultCreateOrUpdateParameters, VaultsCreateOrUpdateOptionalParams)

Create or update a key vault in the specified subscription.

function beginCreateOrUpdate(resourceGroupName: string, vaultName: string, parameters: VaultCreateOrUpdateParameters, options?: VaultsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Vault>, Vault>>

Parameters

resourceGroupName

string

The name of the Resource Group to which the server belongs.

vaultName

string

Name of the vault

parameters

VaultCreateOrUpdateParameters

Parameters to create or update the vault

options

VaultsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<Vault>, Vault>>

beginCreateOrUpdateAndWait(string, string, VaultCreateOrUpdateParameters, VaultsCreateOrUpdateOptionalParams)

Create or update a key vault in the specified subscription.

function beginCreateOrUpdateAndWait(resourceGroupName: string, vaultName: string, parameters: VaultCreateOrUpdateParameters, options?: VaultsCreateOrUpdateOptionalParams): Promise<Vault>

Parameters

resourceGroupName

string

The name of the Resource Group to which the server belongs.

vaultName

string

Name of the vault

parameters

VaultCreateOrUpdateParameters

Parameters to create or update the vault

options

VaultsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<Vault>

beginPurgeDeleted(string, string, VaultsPurgeDeletedOptionalParams)

Permanently deletes the specified vault. aka Purges the deleted Azure key vault.

function beginPurgeDeleted(vaultName: string, location: string, options?: VaultsPurgeDeletedOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

vaultName

string

The name of the soft-deleted vault.

location

string

The location of the soft-deleted vault.

options

VaultsPurgeDeletedOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<void>, void>>

beginPurgeDeletedAndWait(string, string, VaultsPurgeDeletedOptionalParams)

Permanently deletes the specified vault. aka Purges the deleted Azure key vault.

function beginPurgeDeletedAndWait(vaultName: string, location: string, options?: VaultsPurgeDeletedOptionalParams): Promise<void>

Parameters

vaultName

string

The name of the soft-deleted vault.

location

string

The location of the soft-deleted vault.

options

VaultsPurgeDeletedOptionalParams

The options parameters.

Returns

Promise<void>

checkNameAvailability(VaultCheckNameAvailabilityParameters, VaultsCheckNameAvailabilityOptionalParams)

Checks that the vault name is valid and is not already in use.

function checkNameAvailability(vaultName: VaultCheckNameAvailabilityParameters, options?: VaultsCheckNameAvailabilityOptionalParams): Promise<CheckNameAvailabilityResult>

Parameters

vaultName

VaultCheckNameAvailabilityParameters

The name of the vault.

options

VaultsCheckNameAvailabilityOptionalParams

The options parameters.

Returns

Promise<CheckNameAvailabilityResult>

delete(string, string, VaultsDeleteOptionalParams)

Deletes the specified Azure key vault.

function delete(resourceGroupName: string, vaultName: string, options?: VaultsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the Resource Group to which the vault belongs.

vaultName

string

The name of the vault to delete

options

VaultsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, VaultsGetOptionalParams)

Gets the specified Azure key vault.

function get(resourceGroupName: string, vaultName: string, options?: VaultsGetOptionalParams): Promise<Vault>

Parameters

resourceGroupName

string

The name of the Resource Group to which the vault belongs.

vaultName

string

The name of the vault.

options

VaultsGetOptionalParams

The options parameters.

Returns

Promise<Vault>

getDeleted(string, string, VaultsGetDeletedOptionalParams)

Gets the deleted Azure key vault.

function getDeleted(vaultName: string, location: string, options?: VaultsGetDeletedOptionalParams): Promise<DeletedVault>

Parameters

vaultName

string

The name of the vault.

location

string

The location of the deleted vault.

options

VaultsGetDeletedOptionalParams

The options parameters.

Returns

Promise<DeletedVault>

list(VaultsListOptionalParams)

The List operation gets information about the vaults associated with the subscription.

function list(options?: VaultsListOptionalParams): PagedAsyncIterableIterator<Resource, Resource[], PageSettings>

Parameters

options

VaultsListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Resource, Resource[], PageSettings>

listByResourceGroup(string, VaultsListByResourceGroupOptionalParams)

The List operation gets information about the vaults associated with the subscription and within the specified resource group.

function listByResourceGroup(resourceGroupName: string, options?: VaultsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Vault, Vault[], PageSettings>

Parameters

resourceGroupName

string

The name of the Resource Group to which the vault belongs.

options

VaultsListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Vault, Vault[], PageSettings>

listBySubscription(VaultsListBySubscriptionOptionalParams)

The List operation gets information about the vaults associated with the subscription.

function listBySubscription(options?: VaultsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<Vault, Vault[], PageSettings>

Parameters

options

VaultsListBySubscriptionOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Vault, Vault[], PageSettings>

listDeleted(VaultsListDeletedOptionalParams)

Gets information about the deleted vaults in a subscription.

function listDeleted(options?: VaultsListDeletedOptionalParams): PagedAsyncIterableIterator<DeletedVault, DeletedVault[], PageSettings>

Parameters

options

VaultsListDeletedOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<DeletedVault, DeletedVault[], PageSettings>

update(string, string, VaultPatchParameters, VaultsUpdateOptionalParams)

Update a key vault in the specified subscription.

function update(resourceGroupName: string, vaultName: string, parameters: VaultPatchParameters, options?: VaultsUpdateOptionalParams): Promise<Vault>

Parameters

resourceGroupName

string

The name of the Resource Group to which the server belongs.

vaultName

string

Name of the vault

parameters

VaultPatchParameters

Parameters to patch the vault

options

VaultsUpdateOptionalParams

The options parameters.

Returns

Promise<Vault>

updateAccessPolicy(string, string, AccessPolicyUpdateKind, VaultAccessPolicyParameters, VaultsUpdateAccessPolicyOptionalParams)

Update access policies in a key vault in the specified subscription.

function updateAccessPolicy(resourceGroupName: string, vaultName: string, operationKind: AccessPolicyUpdateKind, parameters: VaultAccessPolicyParameters, options?: VaultsUpdateAccessPolicyOptionalParams): Promise<VaultAccessPolicyParameters>

Parameters

resourceGroupName

string

The name of the Resource Group to which the vault belongs.

vaultName

string

Name of the vault

operationKind

AccessPolicyUpdateKind

Name of the operation

parameters

VaultAccessPolicyParameters

Access policy to merge into the vault

options

VaultsUpdateAccessPolicyOptionalParams

The options parameters.

Returns

Promise<VaultAccessPolicyParameters>