Vaults | @azure/arm-keyvault

Interface representing a Vaults.

Hierarchy

Vaults

Implemented by

VaultsImpl

Index

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, vaultName: string, parameters: VaultCreateOrUpdateParameters, options?: VaultsCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<VaultsCreateOrUpdateResponse>, VaultsCreateOrUpdateResponse>>

- Defined in operationsInterfaces/vaults.ts:81
Create or update a key vault in the specified subscription.

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
- Optional options: VaultsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<VaultsCreateOrUpdateResponse>, VaultsCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

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

- Defined in operationsInterfaces/vaults.ts:99
Create or update a key vault in the specified subscription.

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
- Optional options: VaultsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<VaultsCreateOrUpdateResponse>

beginPurgeDeleted

beginPurgeDeleted(vaultName: string, location: string, options?: VaultsPurgeDeletedOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

- Defined in operationsInterfaces/vaults.ts:172
Permanently deletes the specified vault. aka Purges the deleted Azure key vault.

Parameters
- vaultName: string
  
  The name of the soft-deleted vault.
- location: string
  
  The location of the soft-deleted vault.
- Optional options: VaultsPurgeDeletedOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginPurgeDeletedAndWait

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

- Defined in operationsInterfaces/vaults.ts:183
Permanently deletes the specified vault. aka Purges the deleted Azure key vault.

Parameters
- vaultName: string
  
  The name of the soft-deleted vault.
- location: string
  
  The location of the soft-deleted vault.
- Optional options: VaultsPurgeDeletedOptionalParams
  
  The options parameters.
Returns Promise<void>

checkNameAvailability

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

- Defined in operationsInterfaces/vaults.ts:193
Checks that the vault name is valid and is not already in use.

Parameters
- vaultName: VaultCheckNameAvailabilityParameters
  
  The name of the vault.
- Optional options: VaultsCheckNameAvailabilityOptionalParams
  
  The options parameters.
Returns Promise<VaultsCheckNameAvailabilityResponse>

delete

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

- Defined in operationsInterfaces/vaults.ts:124
Deletes the specified Azure key vault.

Parameters
- resourceGroupName: string
  
  The name of the Resource Group to which the vault belongs.
- vaultName: string
  
  The name of the vault to delete
- Optional options: VaultsDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

get

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

- Defined in operationsInterfaces/vaults.ts:135
Gets the specified Azure key vault.

Parameters
- resourceGroupName: string
  
  The name of the Resource Group to which the vault belongs.
- vaultName: string
  
  The name of the vault.
- Optional options: VaultsGetOptionalParams
  
  The options parameters.
Returns Promise<VaultsGetResponse>

getDeleted

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

- Defined in operationsInterfaces/vaults.ts:161
Gets the deleted Azure key vault.

Parameters
- vaultName: string
  
  The name of the vault.
- location: string
  
  The location of the deleted vault.
- Optional options: VaultsGetDeletedOptionalParams
  
  The options parameters.
Returns Promise<VaultsGetDeletedResponse>

list

list(options?: VaultsListOptionalParams): PagedAsyncIterableIterator<Resource>

- Defined in operationsInterfaces/vaults.ts:71
The List operation gets information about the vaults associated with the subscription.

Parameters
- Optional options: VaultsListOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<Resource>

listByResourceGroup

listByResourceGroup(resourceGroupName: string, options?: VaultsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Vault>

- Defined in operationsInterfaces/vaults.ts:49
The List operation gets information about the vaults associated with the subscription and within the specified resource group.

Parameters
- resourceGroupName: string
  
  The name of the Resource Group to which the vault belongs.
- Optional options: VaultsListByResourceGroupOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<Vault>

listBySubscription

listBySubscription(options?: VaultsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<Vault>

- Defined in operationsInterfaces/vaults.ts:57
The List operation gets information about the vaults associated with the subscription.

Parameters
- Optional options: VaultsListBySubscriptionOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<Vault>

listDeleted

listDeleted(options?: VaultsListDeletedOptionalParams): PagedAsyncIterableIterator<DeletedVault>

- Defined in operationsInterfaces/vaults.ts:64
Gets information about the deleted vaults in a subscription.

Parameters
- Optional options: VaultsListDeletedOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<DeletedVault>

update

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

- Defined in operationsInterfaces/vaults.ts:112
Update a key vault in the specified subscription.

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
- Optional options: VaultsUpdateOptionalParams
  
  The options parameters.
Returns Promise<VaultsUpdateResponse>

updateAccessPolicy

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

- Defined in operationsInterfaces/vaults.ts:148
Update access policies in a key vault in the specified subscription.

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
- Optional options: VaultsUpdateAccessPolicyOptionalParams
  
  The options parameters.
Returns Promise<VaultsUpdateAccessPolicyResponse>

Hierarchy

Implemented by

Index

Methods

Methods

beginCreateOrUpdate

Parameters

resourceGroupName: string

vaultName: string

parameters: VaultCreateOrUpdateParameters

Optional options: VaultsCreateOrUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<VaultsCreateOrUpdateResponse>, VaultsCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

Parameters

resourceGroupName: string

vaultName: string

parameters: VaultCreateOrUpdateParameters

Optional options: VaultsCreateOrUpdateOptionalParams

Returns Promise<VaultsCreateOrUpdateResponse>

beginPurgeDeleted

Parameters

vaultName: string

location: string

Optional options: VaultsPurgeDeletedOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginPurgeDeletedAndWait

Parameters

vaultName: string

location: string

Optional options: VaultsPurgeDeletedOptionalParams

Returns Promise<void>

checkNameAvailability

Parameters

vaultName: VaultCheckNameAvailabilityParameters

Optional options: VaultsCheckNameAvailabilityOptionalParams

Returns Promise<VaultsCheckNameAvailabilityResponse>

delete

Parameters

resourceGroupName: string

vaultName: string

Optional options: VaultsDeleteOptionalParams

Returns Promise<void>

get

Parameters

resourceGroupName: string

vaultName: string

Optional options: VaultsGetOptionalParams

Returns Promise<VaultsGetResponse>

getDeleted

Parameters

vaultName: string

location: string

Optional options: VaultsGetDeletedOptionalParams

Returns Promise<VaultsGetDeletedResponse>

list

Parameters

Optional options: VaultsListOptionalParams

Returns PagedAsyncIterableIterator<Resource>

listByResourceGroup

Parameters

resourceGroupName: string

Optional options: VaultsListByResourceGroupOptionalParams

Returns PagedAsyncIterableIterator<Vault>

listBySubscription

Parameters

Optional options: VaultsListBySubscriptionOptionalParams

Returns PagedAsyncIterableIterator<Vault>

listDeleted

Parameters

Optional options: VaultsListDeletedOptionalParams

Returns PagedAsyncIterableIterator<DeletedVault>

update

Parameters

resourceGroupName: string

vaultName: string

parameters: VaultPatchParameters

Optional options: VaultsUpdateOptionalParams

Returns Promise<VaultsUpdateResponse>

updateAccessPolicy

Parameters