Package version:

Interface Vaults

Interface representing a Vaults.

interface Vaults {
    beginCreateOrUpdate(resourceGroupName: string, vaultName: string, parameters: VaultCreateOrUpdateParameters, options?: VaultsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Vault>, Vault>>;
    beginCreateOrUpdateAndWait(resourceGroupName: string, vaultName: string, parameters: VaultCreateOrUpdateParameters, options?: VaultsCreateOrUpdateOptionalParams): Promise<Vault>;
    beginPurgeDeleted(vaultName: string, location: string, options?: VaultsPurgeDeletedOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
    beginPurgeDeletedAndWait(vaultName: string, location: string, options?: VaultsPurgeDeletedOptionalParams): Promise<void>;
    checkNameAvailability(vaultName: VaultCheckNameAvailabilityParameters, options?: VaultsCheckNameAvailabilityOptionalParams): Promise<CheckNameAvailabilityResult>;
    delete(resourceGroupName: string, vaultName: string, options?: VaultsDeleteOptionalParams): Promise<void>;
    get(resourceGroupName: string, vaultName: string, options?: VaultsGetOptionalParams): Promise<Vault>;
    getDeleted(vaultName: string, location: string, options?: VaultsGetDeletedOptionalParams): Promise<DeletedVault>;
    list(options?: VaultsListOptionalParams): PagedAsyncIterableIterator<TrackedResource>;
    listByResourceGroup(resourceGroupName: string, options?: VaultsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Vault>;
    listBySubscription(options?: VaultsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<Vault>;
    listDeleted(options?: VaultsListDeletedOptionalParams): PagedAsyncIterableIterator<DeletedVault>;
    update(resourceGroupName: string, vaultName: string, parameters: VaultPatchParameters, options?: VaultsUpdateOptionalParams): Promise<Vault>;
    updateAccessPolicy(resourceGroupName: string, vaultName: string, operationKind: AccessPolicyUpdateKind, parameters: VaultAccessPolicyParameters, options?: VaultsUpdateAccessPolicyOptionalParams): Promise<VaultAccessPolicyParameters>;
}

Index

Methods

beginCreateOrUpdate beginCreateOrUpdateAndWait beginPurgeDeleted beginPurgeDeletedAndWait checkNameAvailability delete get getDeleted list listByResourceGroup listBySubscription listDeleted update updateAccessPolicy

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName, vaultName, parameters, options?): Promise<SimplePollerLike<OperationState<Vault>, Vault>>
Create or update a key vault in the specified subscription.
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- vaultName: string
  The name of the vault.
- parameters: VaultCreateOrUpdateParameters
  Parameters to create or update the vault
- Optionaloptions: VaultsCreateOrUpdateOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<Vault>, Vault>>
- Defined in operationsInterfaces/vaults.ts:128

beginCreateOrUpdateAndWait

beginCreateOrUpdateAndWait(resourceGroupName, vaultName, parameters, options?): Promise<Vault>
Create or update a key vault in the specified subscription.
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- vaultName: string
  The name of the vault.
- parameters: VaultCreateOrUpdateParameters
  Parameters to create or update the vault
- Optionaloptions: VaultsCreateOrUpdateOptionalParams
  The options parameters.
Returns Promise<Vault>
- Defined in operationsInterfaces/vaults.ts:143

beginPurgeDeleted

beginPurgeDeleted(vaultName, location, options?): Promise<SimplePollerLike<OperationState<void>, void>>
Permanently deletes the specified vault. aka Purges the deleted Azure key vault.
Parameters
- vaultName: string
  The name of the vault.
- location: string
  The name of the Azure region.
- Optionaloptions: VaultsPurgeDeletedOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/vaults.ts:94

beginPurgeDeletedAndWait

beginPurgeDeletedAndWait(vaultName, location, options?): Promise<void>
Permanently deletes the specified vault. aka Purges the deleted Azure key vault.
Parameters
- vaultName: string
  The name of the vault.
- location: string
  The name of the Azure region.
- Optionaloptions: VaultsPurgeDeletedOptionalParams
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/vaults.ts:105

checkNameAvailability

checkNameAvailability(vaultName, options?): Promise<CheckNameAvailabilityResult>
Checks that the vault name is valid and is not already in use.
Parameters
- vaultName: VaultCheckNameAvailabilityParameters
  The name of the vault.
- Optionaloptions: VaultsCheckNameAvailabilityOptionalParams
  The options parameters.
Returns Promise<CheckNameAvailabilityResult>
- Defined in operationsInterfaces/vaults.ts:73

delete

delete(resourceGroupName, vaultName, options?): Promise<void>
Deletes the specified Azure key vault.
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- vaultName: string
  The name of the vault.
- Optionaloptions: VaultsDeleteOptionalParams
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/vaults.ts:168

get

get(resourceGroupName, vaultName, options?): Promise<Vault>
Gets the specified Azure key vault.
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- vaultName: string
  The name of the vault.
- Optionaloptions: VaultsGetOptionalParams
  The options parameters.
Returns Promise<Vault>
- Defined in operationsInterfaces/vaults.ts:116

getDeleted

getDeleted(vaultName, location, options?): Promise<DeletedVault>
Gets the deleted Azure key vault.
Parameters
- vaultName: string
  The name of the vault.
- location: string
  The name of the Azure region.
- Optionaloptions: VaultsGetDeletedOptionalParams
  The options parameters.
Returns Promise<DeletedVault>
- Defined in operationsInterfaces/vaults.ts:83

list

list(options?): PagedAsyncIterableIterator<TrackedResource>
The List operation gets information about the vaults associated with the subscription.
Parameters
- Optionaloptions: VaultsListOptionalParams
  The options parameters.
Returns PagedAsyncIterableIterator<TrackedResource>
- Defined in operationsInterfaces/vaults.ts:67

listByResourceGroup

listByResourceGroup(resourceGroupName, options?): PagedAsyncIterableIterator<Vault>
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. The name is case insensitive.
- Optionaloptions: VaultsListByResourceGroupOptionalParams
  The options parameters.
Returns PagedAsyncIterableIterator<Vault>
- Defined in operationsInterfaces/vaults.ts:59

listBySubscription

listBySubscription(options?): PagedAsyncIterableIterator<Vault>
The List operation gets information about the vaults associated with the subscription.
Parameters
- Optionaloptions: VaultsListBySubscriptionOptionalParams
  The options parameters.
Returns PagedAsyncIterableIterator<Vault>
- Defined in operationsInterfaces/vaults.ts:50

listDeleted

listDeleted(options?): PagedAsyncIterableIterator<DeletedVault>
Gets information about the deleted vaults in a subscription.
Parameters
- Optionaloptions: VaultsListDeletedOptionalParams
  The options parameters.
Returns PagedAsyncIterableIterator<DeletedVault>
- Defined in operationsInterfaces/vaults.ts:45

update

update(resourceGroupName, vaultName, parameters, options?): Promise<Vault>
Update a key vault in the specified subscription.
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- vaultName: string
  The name of the vault.
- parameters: VaultPatchParameters
  Parameters to patch the vault
- Optionaloptions: VaultsUpdateOptionalParams
  The options parameters.
Returns Promise<Vault>
- Defined in operationsInterfaces/vaults.ts:156

updateAccessPolicy

updateAccessPolicy(resourceGroupName, vaultName, operationKind, parameters, options?): Promise<VaultAccessPolicyParameters>
Update access policies in a key vault in the specified subscription.
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- vaultName: string
  Name of the vault
- operationKind: AccessPolicyUpdateKind
  Name of the operation
- parameters: VaultAccessPolicyParameters
  Access policy to merge into the vault
- Optionaloptions: VaultsUpdateAccessPolicyOptionalParams
  The options parameters.
Returns Promise<VaultAccessPolicyParameters>
- Defined in operationsInterfaces/vaults.ts:181

Interface Vaults

Index

Methods

Methods

beginCreateOrUpdate

Parameters

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

beginCreateOrUpdateAndWait

Parameters

Returns Promise<Vault>

beginPurgeDeleted

Parameters

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

beginPurgeDeletedAndWait

Parameters

Returns Promise<void>

checkNameAvailability

Parameters

Returns Promise<CheckNameAvailabilityResult>

delete

Parameters

Returns Promise<void>

get

Parameters

Returns Promise<Vault>

getDeleted

Parameters

Returns Promise<DeletedVault>

list

Parameters

Returns PagedAsyncIterableIterator<TrackedResource>

listByResourceGroup

Parameters

Returns PagedAsyncIterableIterator<Vault>

listBySubscription

Parameters

Returns PagedAsyncIterableIterator<Vault>

listDeleted

Parameters

Returns PagedAsyncIterableIterator<DeletedVault>

update

Parameters

Returns Promise<Vault>

updateAccessPolicy

Parameters

Returns Promise<VaultAccessPolicyParameters>

Settings