Vaults class

Class representing a Vaults.

Constructors

Vaults(KeyVaultManagementClientContext)

Create a Vaults.

Methods

beginCreateOrUpdate(string, string, VaultCreateOrUpdateParameters, msRest.RequestOptionsBase)

Create or update a key vault in the specified subscription.

beginPurgeDeleted(string, string, msRest.RequestOptionsBase)

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

checkNameAvailability(VaultCheckNameAvailabilityParameters, msRest.RequestOptionsBase)

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

checkNameAvailability(VaultCheckNameAvailabilityParameters, RequestOptionsBase, ServiceCallback<CheckNameAvailabilityResult>)
checkNameAvailability(VaultCheckNameAvailabilityParameters, ServiceCallback<CheckNameAvailabilityResult>)
createOrUpdate(string, string, VaultCreateOrUpdateParameters, msRest.RequestOptionsBase)

Create or update a key vault in the specified subscription.

deleteMethod(string, string, msRest.RequestOptionsBase)

Deletes the specified Azure key vault.

deleteMethod(string, string, RequestOptionsBase, ServiceCallback<void>)
deleteMethod(string, string, ServiceCallback<void>)
get(string, string, msRest.RequestOptionsBase)

Gets the specified Azure key vault.

get(string, string, RequestOptionsBase, ServiceCallback<Vault>)
get(string, string, ServiceCallback<Vault>)
getDeleted(string, string, msRest.RequestOptionsBase)

Gets the deleted Azure key vault.

getDeleted(string, string, RequestOptionsBase, ServiceCallback<DeletedVault>)
getDeleted(string, string, ServiceCallback<DeletedVault>)
list(Models.VaultsListOptionalParams)

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

list(ServiceCallback<ResourceListResult>)
list(VaultsListOptionalParams, ServiceCallback<ResourceListResult>)
listByResourceGroup(string, Models.VaultsListByResourceGroupOptionalParams)

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

listByResourceGroup(string, ServiceCallback<VaultListResult>)
listByResourceGroup(string, VaultsListByResourceGroupOptionalParams, ServiceCallback<VaultListResult>)
listByResourceGroupNext(string, msRest.RequestOptionsBase)

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

listByResourceGroupNext(string, RequestOptionsBase, ServiceCallback<VaultListResult>)
listByResourceGroupNext(string, ServiceCallback<VaultListResult>)
listBySubscription(Models.VaultsListBySubscriptionOptionalParams)

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

listBySubscription(ServiceCallback<VaultListResult>)
listBySubscription(VaultsListBySubscriptionOptionalParams, ServiceCallback<VaultListResult>)
listBySubscriptionNext(string, msRest.RequestOptionsBase)

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

listBySubscriptionNext(string, RequestOptionsBase, ServiceCallback<VaultListResult>)
listBySubscriptionNext(string, ServiceCallback<VaultListResult>)
listDeleted(msRest.RequestOptionsBase)

Gets information about the deleted vaults in a subscription.

listDeleted(RequestOptionsBase, ServiceCallback<DeletedVaultListResult>)
listDeleted(ServiceCallback<DeletedVaultListResult>)
listDeletedNext(string, msRest.RequestOptionsBase)

Gets information about the deleted vaults in a subscription.

listDeletedNext(string, RequestOptionsBase, ServiceCallback<DeletedVaultListResult>)
listDeletedNext(string, ServiceCallback<DeletedVaultListResult>)
listNext(string, msRest.RequestOptionsBase)

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

listNext(string, RequestOptionsBase, ServiceCallback<ResourceListResult>)
listNext(string, ServiceCallback<ResourceListResult>)
purgeDeleted(string, string, msRest.RequestOptionsBase)

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

update(string, string, VaultPatchParameters, msRest.RequestOptionsBase)

Update a key vault in the specified subscription.

update(string, string, VaultPatchParameters, RequestOptionsBase, ServiceCallback<Vault>)
update(string, string, VaultPatchParameters, ServiceCallback<Vault>)
updateAccessPolicy(string, string, Models.AccessPolicyUpdateKind, VaultAccessPolicyParameters, msRest.RequestOptionsBase)

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

updateAccessPolicy(string, string, Models.AccessPolicyUpdateKind, VaultAccessPolicyParameters, RequestOptionsBase, ServiceCallback<VaultAccessPolicyParameters>)
updateAccessPolicy(string, string, Models.AccessPolicyUpdateKind, VaultAccessPolicyParameters, ServiceCallback<VaultAccessPolicyParameters>)

Constructor Details

Vaults(KeyVaultManagementClientContext)

Create a Vaults.

new Vaults(client: KeyVaultManagementClientContext)

Parameters

client
KeyVaultManagementClientContext

Reference to the service client.

Method Details

beginCreateOrUpdate(string, string, VaultCreateOrUpdateParameters, msRest.RequestOptionsBase)

Create or update a key vault in the specified subscription.

function beginCreateOrUpdate(resourceGroupName: string, vaultName: string, parameters: VaultCreateOrUpdateParameters, options?: msRest.RequestOptionsBase)

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
msRest.RequestOptionsBase

Returns

Promise<LROPoller>

Promise<msRestAzure.LROPoller>

beginPurgeDeleted(string, string, msRest.RequestOptionsBase)

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

function beginPurgeDeleted(vaultName: string, location: string, options?: msRest.RequestOptionsBase)

Parameters

vaultName

string

The name of the soft-deleted vault.

location

string

The location of the soft-deleted vault.

options
msRest.RequestOptionsBase

Returns

Promise<LROPoller>

Promise<msRestAzure.LROPoller>

checkNameAvailability(VaultCheckNameAvailabilityParameters, msRest.RequestOptionsBase)

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

function checkNameAvailability(vaultName: VaultCheckNameAvailabilityParameters, options?: msRest.RequestOptionsBase)

Parameters

vaultName
VaultCheckNameAvailabilityParameters

The name of the vault.

options
msRest.RequestOptionsBase

Returns

Promise<Models.VaultsCheckNameAvailabilityResponse>

Promise<Models.VaultsCheckNameAvailabilityResponse>

checkNameAvailability(VaultCheckNameAvailabilityParameters, RequestOptionsBase, ServiceCallback<CheckNameAvailabilityResult>)

function checkNameAvailability(vaultName: VaultCheckNameAvailabilityParameters, options: RequestOptionsBase, callback: ServiceCallback<CheckNameAvailabilityResult>)

Parameters

vaultName
VaultCheckNameAvailabilityParameters

The name of the vault.

options

RequestOptionsBase

The optional parameters

callback

ServiceCallback<CheckNameAvailabilityResult>

The callback

checkNameAvailability(VaultCheckNameAvailabilityParameters, ServiceCallback<CheckNameAvailabilityResult>)

function checkNameAvailability(vaultName: VaultCheckNameAvailabilityParameters, callback: ServiceCallback<CheckNameAvailabilityResult>)

Parameters

vaultName
VaultCheckNameAvailabilityParameters

The name of the vault.

callback

ServiceCallback<CheckNameAvailabilityResult>

The callback

createOrUpdate(string, string, VaultCreateOrUpdateParameters, msRest.RequestOptionsBase)

Create or update a key vault in the specified subscription.

function createOrUpdate(resourceGroupName: string, vaultName: string, parameters: VaultCreateOrUpdateParameters, options?: msRest.RequestOptionsBase)

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
msRest.RequestOptionsBase

Returns

Promise<Models.VaultsCreateOrUpdateResponse>

Promise<Models.VaultsCreateOrUpdateResponse>

deleteMethod(string, string, msRest.RequestOptionsBase)

Deletes the specified Azure key vault.

function deleteMethod(resourceGroupName: string, vaultName: string, options?: msRest.RequestOptionsBase)

Parameters

resourceGroupName

string

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

vaultName

string

The name of the vault to delete

options
msRest.RequestOptionsBase

Returns

Promise<RestResponse>

Promise<msRest.RestResponse>

deleteMethod(string, string, RequestOptionsBase, ServiceCallback<void>)

function deleteMethod(resourceGroupName: string, vaultName: string, options: RequestOptionsBase, callback: ServiceCallback<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

RequestOptionsBase

The optional parameters

callback

ServiceCallback<void>

The callback

deleteMethod(string, string, ServiceCallback<void>)

function deleteMethod(resourceGroupName: string, vaultName: string, callback: ServiceCallback<void>)

Parameters

resourceGroupName

string

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

vaultName

string

The name of the vault to delete

callback

ServiceCallback<void>

The callback

get(string, string, msRest.RequestOptionsBase)

Gets the specified Azure key vault.

function get(resourceGroupName: string, vaultName: string, options?: msRest.RequestOptionsBase)

Parameters

resourceGroupName

string

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

vaultName

string

The name of the vault.

options
msRest.RequestOptionsBase

Returns

Promise<Models.VaultsGetResponse>

Promise<Models.VaultsGetResponse>

get(string, string, RequestOptionsBase, ServiceCallback<Vault>)

function get(resourceGroupName: string, vaultName: string, options: RequestOptionsBase, callback: ServiceCallback<Vault>)

Parameters

resourceGroupName

string

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

vaultName

string

The name of the vault.

options

RequestOptionsBase

The optional parameters

callback

ServiceCallback<Vault>

The callback

get(string, string, ServiceCallback<Vault>)

function get(resourceGroupName: string, vaultName: string, callback: ServiceCallback<Vault>)

Parameters

resourceGroupName

string

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

vaultName

string

The name of the vault.

callback

ServiceCallback<Vault>

The callback

getDeleted(string, string, msRest.RequestOptionsBase)

Gets the deleted Azure key vault.

function getDeleted(vaultName: string, location: string, options?: msRest.RequestOptionsBase)

Parameters

vaultName

string

The name of the vault.

location

string

The location of the deleted vault.

options
msRest.RequestOptionsBase

Returns

Promise<Models.VaultsGetDeletedResponse>

Promise<Models.VaultsGetDeletedResponse>

getDeleted(string, string, RequestOptionsBase, ServiceCallback<DeletedVault>)

function getDeleted(vaultName: string, location: string, options: RequestOptionsBase, callback: ServiceCallback<DeletedVault>)

Parameters

vaultName

string

The name of the vault.

location

string

The location of the deleted vault.

options

RequestOptionsBase

The optional parameters

callback

ServiceCallback<DeletedVault>

The callback

getDeleted(string, string, ServiceCallback<DeletedVault>)

function getDeleted(vaultName: string, location: string, callback: ServiceCallback<DeletedVault>)

Parameters

vaultName

string

The name of the vault.

location

string

The location of the deleted vault.

callback

ServiceCallback<DeletedVault>

The callback

list(Models.VaultsListOptionalParams)

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

function list(options?: Models.VaultsListOptionalParams)

Parameters

options
Models.VaultsListOptionalParams

Returns

Promise<Models.VaultsListResponse>

Promise<Models.VaultsListResponse>

list(ServiceCallback<ResourceListResult>)

function list(callback: ServiceCallback<ResourceListResult>)

Parameters

callback

ServiceCallback<ResourceListResult>

The callback

list(VaultsListOptionalParams, ServiceCallback<ResourceListResult>)

function list(options: VaultsListOptionalParams, callback: ServiceCallback<ResourceListResult>)

Parameters

options
VaultsListOptionalParams

The optional parameters

callback

ServiceCallback<ResourceListResult>

The callback

listByResourceGroup(string, Models.VaultsListByResourceGroupOptionalParams)

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

function listByResourceGroup(resourceGroupName: string, options?: Models.VaultsListByResourceGroupOptionalParams)

Parameters

resourceGroupName

string

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

options
Models.VaultsListByResourceGroupOptionalParams

Returns

Promise<Models.VaultsListByResourceGroupResponse>

Promise<Models.VaultsListByResourceGroupResponse>

listByResourceGroup(string, ServiceCallback<VaultListResult>)

function listByResourceGroup(resourceGroupName: string, callback: ServiceCallback<VaultListResult>)

Parameters

resourceGroupName

string

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

callback

ServiceCallback<VaultListResult>

The callback

listByResourceGroup(string, VaultsListByResourceGroupOptionalParams, ServiceCallback<VaultListResult>)

function listByResourceGroup(resourceGroupName: string, options: VaultsListByResourceGroupOptionalParams, callback: ServiceCallback<VaultListResult>)

Parameters

resourceGroupName

string

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

options
VaultsListByResourceGroupOptionalParams

The optional parameters

callback

ServiceCallback<VaultListResult>

The callback

listByResourceGroupNext(string, msRest.RequestOptionsBase)

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

function listByResourceGroupNext(nextPageLink: string, options?: msRest.RequestOptionsBase)

Parameters

nextPageLink

string

The NextLink from the previous successful call to List operation.

options
msRest.RequestOptionsBase

Returns

Promise<Models.VaultsListByResourceGroupNextResponse>

Promise<Models.VaultsListByResourceGroupNextResponse>

listByResourceGroupNext(string, RequestOptionsBase, ServiceCallback<VaultListResult>)

function listByResourceGroupNext(nextPageLink: string, options: RequestOptionsBase, callback: ServiceCallback<VaultListResult>)

Parameters

nextPageLink

string

The NextLink from the previous successful call to List operation.

options

RequestOptionsBase

The optional parameters

callback

ServiceCallback<VaultListResult>

The callback

listByResourceGroupNext(string, ServiceCallback<VaultListResult>)

function listByResourceGroupNext(nextPageLink: string, callback: ServiceCallback<VaultListResult>)

Parameters

nextPageLink

string

The NextLink from the previous successful call to List operation.

callback

ServiceCallback<VaultListResult>

The callback

listBySubscription(Models.VaultsListBySubscriptionOptionalParams)

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

function listBySubscription(options?: Models.VaultsListBySubscriptionOptionalParams)

Parameters

options
Models.VaultsListBySubscriptionOptionalParams

Returns

Promise<Models.VaultsListBySubscriptionResponse>

Promise<Models.VaultsListBySubscriptionResponse>

listBySubscription(ServiceCallback<VaultListResult>)

function listBySubscription(callback: ServiceCallback<VaultListResult>)

Parameters

callback

ServiceCallback<VaultListResult>

The callback

listBySubscription(VaultsListBySubscriptionOptionalParams, ServiceCallback<VaultListResult>)

function listBySubscription(options: VaultsListBySubscriptionOptionalParams, callback: ServiceCallback<VaultListResult>)

Parameters

options
VaultsListBySubscriptionOptionalParams

The optional parameters

callback

ServiceCallback<VaultListResult>

The callback

listBySubscriptionNext(string, msRest.RequestOptionsBase)

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

function listBySubscriptionNext(nextPageLink: string, options?: msRest.RequestOptionsBase)

Parameters

nextPageLink

string

The NextLink from the previous successful call to List operation.

options
msRest.RequestOptionsBase

Returns

Promise<Models.VaultsListBySubscriptionNextResponse>

Promise<Models.VaultsListBySubscriptionNextResponse>

listBySubscriptionNext(string, RequestOptionsBase, ServiceCallback<VaultListResult>)

function listBySubscriptionNext(nextPageLink: string, options: RequestOptionsBase, callback: ServiceCallback<VaultListResult>)

Parameters

nextPageLink

string

The NextLink from the previous successful call to List operation.

options

RequestOptionsBase

The optional parameters

callback

ServiceCallback<VaultListResult>

The callback

listBySubscriptionNext(string, ServiceCallback<VaultListResult>)

function listBySubscriptionNext(nextPageLink: string, callback: ServiceCallback<VaultListResult>)

Parameters

nextPageLink

string

The NextLink from the previous successful call to List operation.

callback

ServiceCallback<VaultListResult>

The callback

listDeleted(msRest.RequestOptionsBase)

Gets information about the deleted vaults in a subscription.

function listDeleted(options?: msRest.RequestOptionsBase)

Parameters

options
msRest.RequestOptionsBase

Returns

Promise<Models.VaultsListDeletedResponse>

Promise<Models.VaultsListDeletedResponse>

listDeleted(RequestOptionsBase, ServiceCallback<DeletedVaultListResult>)

function listDeleted(options: RequestOptionsBase, callback: ServiceCallback<DeletedVaultListResult>)

Parameters

options

RequestOptionsBase

The optional parameters

callback

ServiceCallback<DeletedVaultListResult>

The callback

listDeleted(ServiceCallback<DeletedVaultListResult>)

function listDeleted(callback: ServiceCallback<DeletedVaultListResult>)

Parameters

callback

ServiceCallback<DeletedVaultListResult>

The callback

listDeletedNext(string, msRest.RequestOptionsBase)

Gets information about the deleted vaults in a subscription.

function listDeletedNext(nextPageLink: string, options?: msRest.RequestOptionsBase)

Parameters

nextPageLink

string

The NextLink from the previous successful call to List operation.

options
msRest.RequestOptionsBase

Returns

Promise<Models.VaultsListDeletedNextResponse>

Promise<Models.VaultsListDeletedNextResponse>

listDeletedNext(string, RequestOptionsBase, ServiceCallback<DeletedVaultListResult>)

function listDeletedNext(nextPageLink: string, options: RequestOptionsBase, callback: ServiceCallback<DeletedVaultListResult>)

Parameters

nextPageLink

string

The NextLink from the previous successful call to List operation.

options

RequestOptionsBase

The optional parameters

callback

ServiceCallback<DeletedVaultListResult>

The callback

listDeletedNext(string, ServiceCallback<DeletedVaultListResult>)

function listDeletedNext(nextPageLink: string, callback: ServiceCallback<DeletedVaultListResult>)

Parameters

nextPageLink

string

The NextLink from the previous successful call to List operation.

callback

ServiceCallback<DeletedVaultListResult>

The callback

listNext(string, msRest.RequestOptionsBase)

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

function listNext(nextPageLink: string, options?: msRest.RequestOptionsBase)

Parameters

nextPageLink

string

The NextLink from the previous successful call to List operation.

options
msRest.RequestOptionsBase

Returns

Promise<Models.VaultsListNextResponse>

Promise<Models.VaultsListNextResponse>

listNext(string, RequestOptionsBase, ServiceCallback<ResourceListResult>)

function listNext(nextPageLink: string, options: RequestOptionsBase, callback: ServiceCallback<ResourceListResult>)

Parameters

nextPageLink

string

The NextLink from the previous successful call to List operation.

options

RequestOptionsBase

The optional parameters

callback

ServiceCallback<ResourceListResult>

The callback

listNext(string, ServiceCallback<ResourceListResult>)

function listNext(nextPageLink: string, callback: ServiceCallback<ResourceListResult>)

Parameters

nextPageLink

string

The NextLink from the previous successful call to List operation.

callback

ServiceCallback<ResourceListResult>

The callback

purgeDeleted(string, string, msRest.RequestOptionsBase)

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

function purgeDeleted(vaultName: string, location: string, options?: msRest.RequestOptionsBase)

Parameters

vaultName

string

The name of the soft-deleted vault.

location

string

The location of the soft-deleted vault.

options
msRest.RequestOptionsBase

Returns

Promise<RestResponse>

Promise<msRest.RestResponse>

update(string, string, VaultPatchParameters, msRest.RequestOptionsBase)

Update a key vault in the specified subscription.

function update(resourceGroupName: string, vaultName: string, parameters: VaultPatchParameters, options?: msRest.RequestOptionsBase)

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
msRest.RequestOptionsBase

Returns

Promise<Models.VaultsUpdateResponse>

Promise<Models.VaultsUpdateResponse>

update(string, string, VaultPatchParameters, RequestOptionsBase, ServiceCallback<Vault>)

function update(resourceGroupName: string, vaultName: string, parameters: VaultPatchParameters, options: RequestOptionsBase, callback: ServiceCallback<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

RequestOptionsBase

The optional parameters

callback

ServiceCallback<Vault>

The callback

update(string, string, VaultPatchParameters, ServiceCallback<Vault>)

function update(resourceGroupName: string, vaultName: string, parameters: VaultPatchParameters, callback: ServiceCallback<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

callback

ServiceCallback<Vault>

The callback

updateAccessPolicy(string, string, Models.AccessPolicyUpdateKind, VaultAccessPolicyParameters, msRest.RequestOptionsBase)

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

function updateAccessPolicy(resourceGroupName: string, vaultName: string, operationKind: Models.AccessPolicyUpdateKind, parameters: VaultAccessPolicyParameters, options?: msRest.RequestOptionsBase)

Parameters

resourceGroupName

string

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

vaultName

string

Name of the vault

operationKind
Models.AccessPolicyUpdateKind

Name of the operation. Possible values include: 'add', 'replace', 'remove'

parameters
VaultAccessPolicyParameters

Access policy to merge into the vault

options
msRest.RequestOptionsBase

Returns

Promise<Models.VaultsUpdateAccessPolicyResponse>

Promise<Models.VaultsUpdateAccessPolicyResponse>

updateAccessPolicy(string, string, Models.AccessPolicyUpdateKind, VaultAccessPolicyParameters, RequestOptionsBase, ServiceCallback<VaultAccessPolicyParameters>)

function updateAccessPolicy(resourceGroupName: string, vaultName: string, operationKind: Models.AccessPolicyUpdateKind, parameters: VaultAccessPolicyParameters, options: RequestOptionsBase, callback: ServiceCallback<VaultAccessPolicyParameters>)

Parameters

resourceGroupName

string

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

vaultName

string

Name of the vault

operationKind
Models.AccessPolicyUpdateKind

Name of the operation. Possible values include: 'add', 'replace', 'remove'

parameters
VaultAccessPolicyParameters

Access policy to merge into the vault

options

RequestOptionsBase

The optional parameters

callback

ServiceCallback<VaultAccessPolicyParameters>

The callback

updateAccessPolicy(string, string, Models.AccessPolicyUpdateKind, VaultAccessPolicyParameters, ServiceCallback<VaultAccessPolicyParameters>)

function updateAccessPolicy(resourceGroupName: string, vaultName: string, operationKind: Models.AccessPolicyUpdateKind, parameters: VaultAccessPolicyParameters, callback: ServiceCallback<VaultAccessPolicyParameters>)

Parameters

resourceGroupName

string

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

vaultName

string

Name of the vault

operationKind
Models.AccessPolicyUpdateKind

Name of the operation. Possible values include: 'add', 'replace', 'remove'

parameters
VaultAccessPolicyParameters

Access policy to merge into the vault

callback

ServiceCallback<VaultAccessPolicyParameters>

The callback