Vaults | @azure/arm-keyvault-profile-2019-03-01-hybrid

Class representing a Vaults.

Hierarchy

Vaults

Index

Constructors

constructor

Methods

Constructors

constructor

new Vaults(client: KeyVaultManagementClientContext): Vaults

- Defined in operations/vaults.ts:20
Create a Vaults.

Parameters
- client: KeyVaultManagementClientContext
  
  Reference to the service client.
Returns Vaults

Methods

beginPurgeDeleted

beginPurgeDeleted(vaultName: string, location: string, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

- Defined in operations/vaults.ts:386
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: msRest.RequestOptionsBase
Returns Promise<msRestAzure.LROPoller>

Promise<msRestAzure.LROPoller>

checkNameAvailability

checkNameAvailability(vaultName: VaultCheckNameAvailabilityParameters, options?: msRest.RequestOptionsBase): Promise<Models.VaultsCheckNameAvailabilityResponse>
checkNameAvailability(vaultName: VaultCheckNameAvailabilityParameters, callback: msRest.ServiceCallback<CheckNameAvailabilityResult>): void
checkNameAvailability(vaultName: VaultCheckNameAvailabilityParameters, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<CheckNameAvailabilityResult>): void

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

Parameters
- vaultName: VaultCheckNameAvailabilityParameters
  
  The name of the vault.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.VaultsCheckNameAvailabilityResponse>

Promise<Models.VaultsCheckNameAvailabilityResponse>
- Defined in operations/vaults.ts:362
Parameters
- vaultName: VaultCheckNameAvailabilityParameters
  
  The name of the vault.
- callback: msRest.ServiceCallback<CheckNameAvailabilityResult>
  
  The callback
Returns void
- Defined in operations/vaults.ts:368
Parameters
- vaultName: VaultCheckNameAvailabilityParameters
  
  The name of the vault.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<CheckNameAvailabilityResult>
  
  The callback
Returns void

createOrUpdate

createOrUpdate(resourceGroupName: string, vaultName: string, parameters: VaultCreateOrUpdateParameters, options?: msRest.RequestOptionsBase): Promise<Models.VaultsCreateOrUpdateResponse>
createOrUpdate(resourceGroupName: string, vaultName: string, parameters: VaultCreateOrUpdateParameters, callback: msRest.ServiceCallback<Vault>): void
createOrUpdate(resourceGroupName: string, vaultName: string, parameters: VaultCreateOrUpdateParameters, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<Vault>): void

- Defined in operations/vaults.ts:38
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: msRest.RequestOptionsBase
Returns Promise<Models.VaultsCreateOrUpdateResponse>

Promise<Models.VaultsCreateOrUpdateResponse>
- Defined in operations/vaults.ts:45
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
- callback: msRest.ServiceCallback<Vault>
  
  The callback
Returns void
- Defined in operations/vaults.ts:53
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
  
  The optional parameters
- callback: msRest.ServiceCallback<Vault>
  
  The callback
Returns void

deleteMethod

deleteMethod(resourceGroupName: string, vaultName: string, options?: msRest.RequestOptionsBase): Promise<msRest.RestResponse>
deleteMethod(resourceGroupName: string, vaultName: string, callback: msRest.ServiceCallback<void>): void
deleteMethod(resourceGroupName: string, vaultName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<void>): void

- Defined in operations/vaults.ts:109
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: msRest.RequestOptionsBase
Returns Promise<msRest.RestResponse>

Promise<msRest.RestResponse>
- Defined in operations/vaults.ts:115
Parameters
- resourceGroupName: string
  
  The name of the Resource Group to which the vault belongs.
- vaultName: string
  
  The name of the vault to delete
- callback: msRest.ServiceCallback<void>
  
  The callback
Returns void
- Defined in operations/vaults.ts:122
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
  
  The optional parameters
- callback: msRest.ServiceCallback<void>
  
  The callback
Returns void

get

get(resourceGroupName: string, vaultName: string, options?: msRest.RequestOptionsBase): Promise<Models.VaultsGetResponse>
get(resourceGroupName: string, vaultName: string, callback: msRest.ServiceCallback<Vault>): void
get(resourceGroupName: string, vaultName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<Vault>): void

- Defined in operations/vaults.ts:141
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: msRest.RequestOptionsBase
Returns Promise<Models.VaultsGetResponse>

Promise<Models.VaultsGetResponse>
- Defined in operations/vaults.ts:147
Parameters
- resourceGroupName: string
  
  The name of the Resource Group to which the vault belongs.
- vaultName: string
  
  The name of the vault.
- callback: msRest.ServiceCallback<Vault>
  
  The callback
Returns void
- Defined in operations/vaults.ts:154
Parameters
- resourceGroupName: string
  
  The name of the Resource Group to which the vault belongs.
- vaultName: string
  
  The name of the vault.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<Vault>
  
  The callback
Returns void

getDeleted

getDeleted(vaultName: string, location: string, options?: msRest.RequestOptionsBase): Promise<Models.VaultsGetDeletedResponse>
getDeleted(vaultName: string, location: string, callback: msRest.ServiceCallback<DeletedVault>): void
getDeleted(vaultName: string, location: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<DeletedVault>): void

- Defined in operations/vaults.ts:290
Gets the deleted Azure key vault.

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

Promise<Models.VaultsGetDeletedResponse>
- Defined in operations/vaults.ts:296
Parameters
- vaultName: string
  
  The name of the vault.
- location: string
  
  The location of the deleted vault.
- callback: msRest.ServiceCallback<DeletedVault>
  
  The callback
Returns void
- Defined in operations/vaults.ts:303
Parameters
- vaultName: string
  
  The name of the vault.
- location: string
  
  The location of the deleted vault.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<DeletedVault>
  
  The callback
Returns void

list

list(options?: Models.VaultsListOptionalParams): Promise<Models.VaultsListResponse>
list(callback: msRest.ServiceCallback<ResourceListResult>): void
list(options: VaultsListOptionalParams, callback: msRest.ServiceCallback<ResourceListResult>): void

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

Parameters
- Optional options: Models.VaultsListOptionalParams
Returns Promise<Models.VaultsListResponse>

Promise<Models.VaultsListResponse>
- Defined in operations/vaults.ts:336
Parameters
- callback: msRest.ServiceCallback<ResourceListResult>
  
  The callback
Returns void
- Defined in operations/vaults.ts:341
Parameters
- options: VaultsListOptionalParams
  
  The optional parameters
- callback: msRest.ServiceCallback<ResourceListResult>
  
  The callback
Returns void

listByResourceGroup

listByResourceGroup(resourceGroupName: string, options?: Models.VaultsListByResourceGroupOptionalParams): Promise<Models.VaultsListByResourceGroupResponse>
listByResourceGroup(resourceGroupName: string, callback: msRest.ServiceCallback<VaultListResult>): void
listByResourceGroup(resourceGroupName: string, options: VaultsListByResourceGroupOptionalParams, callback: msRest.ServiceCallback<VaultListResult>): void

- Defined in operations/vaults.ts:213
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: Models.VaultsListByResourceGroupOptionalParams
Returns Promise<Models.VaultsListByResourceGroupResponse>

Promise<Models.VaultsListByResourceGroupResponse>
- Defined in operations/vaults.ts:218
Parameters
- resourceGroupName: string
  
  The name of the Resource Group to which the vault belongs.
- callback: msRest.ServiceCallback<VaultListResult>
  
  The callback
Returns void
- Defined in operations/vaults.ts:224
Parameters
- resourceGroupName: string
  
  The name of the Resource Group to which the vault belongs.
- options: VaultsListByResourceGroupOptionalParams
  
  The optional parameters
- callback: msRest.ServiceCallback<VaultListResult>
  
  The callback
Returns void

listByResourceGroupNext

listByResourceGroupNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.VaultsListByResourceGroupNextResponse>
listByResourceGroupNext(nextPageLink: string, callback: msRest.ServiceCallback<VaultListResult>): void
listByResourceGroupNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<VaultListResult>): void

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

Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.VaultsListByResourceGroupNextResponse>

Promise<Models.VaultsListByResourceGroupNextResponse>
- Defined in operations/vaults.ts:409
Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- callback: msRest.ServiceCallback<VaultListResult>
  
  The callback
Returns void
- Defined in operations/vaults.ts:415
Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<VaultListResult>
  
  The callback
Returns void

listBySubscription

listBySubscription(options?: Models.VaultsListBySubscriptionOptionalParams): Promise<Models.VaultsListBySubscriptionResponse>
listBySubscription(callback: msRest.ServiceCallback<VaultListResult>): void
listBySubscription(options: VaultsListBySubscriptionOptionalParams, callback: msRest.ServiceCallback<VaultListResult>): void

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

Parameters
- Optional options: Models.VaultsListBySubscriptionOptionalParams
Returns Promise<Models.VaultsListBySubscriptionResponse>

Promise<Models.VaultsListBySubscriptionResponse>
- Defined in operations/vaults.ts:244
Parameters
- callback: msRest.ServiceCallback<VaultListResult>
  
  The callback
Returns void
- Defined in operations/vaults.ts:249
Parameters
- options: VaultsListBySubscriptionOptionalParams
  
  The optional parameters
- callback: msRest.ServiceCallback<VaultListResult>
  
  The callback
Returns void

listBySubscriptionNext

listBySubscriptionNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.VaultsListBySubscriptionNextResponse>
listBySubscriptionNext(nextPageLink: string, callback: msRest.ServiceCallback<VaultListResult>): void
listBySubscriptionNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<VaultListResult>): void

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

Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.VaultsListBySubscriptionNextResponse>

Promise<Models.VaultsListBySubscriptionNextResponse>
- Defined in operations/vaults.ts:437
Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- callback: msRest.ServiceCallback<VaultListResult>
  
  The callback
Returns void
- Defined in operations/vaults.ts:443
Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<VaultListResult>
  
  The callback
Returns void

listDeleted

listDeleted(options?: msRest.RequestOptionsBase): Promise<Models.VaultsListDeletedResponse>
listDeleted(callback: msRest.ServiceCallback<DeletedVaultListResult>): void
listDeleted(options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<DeletedVaultListResult>): void

- Defined in operations/vaults.ts:264
Gets information about the deleted vaults in a subscription.

Parameters
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.VaultsListDeletedResponse>

Promise<Models.VaultsListDeletedResponse>
- Defined in operations/vaults.ts:268
Parameters
- callback: msRest.ServiceCallback<DeletedVaultListResult>
  
  The callback
Returns void
- Defined in operations/vaults.ts:273
Parameters
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<DeletedVaultListResult>
  
  The callback
Returns void

listDeletedNext

listDeletedNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.VaultsListDeletedNextResponse>
listDeletedNext(nextPageLink: string, callback: msRest.ServiceCallback<DeletedVaultListResult>): void
listDeletedNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<DeletedVaultListResult>): void

- Defined in operations/vaults.ts:460
Gets information about the deleted vaults in a subscription.

Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.VaultsListDeletedNextResponse>

Promise<Models.VaultsListDeletedNextResponse>
- Defined in operations/vaults.ts:465
Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- callback: msRest.ServiceCallback<DeletedVaultListResult>
  
  The callback
Returns void
- Defined in operations/vaults.ts:471
Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<DeletedVaultListResult>
  
  The callback
Returns void

listNext

listNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.VaultsListNextResponse>
listNext(nextPageLink: string, callback: msRest.ServiceCallback<ResourceListResult>): void
listNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<ResourceListResult>): void

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

Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.VaultsListNextResponse>

Promise<Models.VaultsListNextResponse>
- Defined in operations/vaults.ts:493
Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- callback: msRest.ServiceCallback<ResourceListResult>
  
  The callback
Returns void
- Defined in operations/vaults.ts:499
Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<ResourceListResult>
  
  The callback
Returns void

purgeDeleted

purgeDeleted(vaultName: string, location: string, options?: msRest.RequestOptionsBase): Promise<msRest.RestResponse>

- Defined in operations/vaults.ts:322
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: msRest.RequestOptionsBase
Returns Promise<msRest.RestResponse>

Promise<msRest.RestResponse>

update

update(resourceGroupName: string, vaultName: string, parameters: VaultPatchParameters, options?: msRest.RequestOptionsBase): Promise<Models.VaultsUpdateResponse>
update(resourceGroupName: string, vaultName: string, parameters: VaultPatchParameters, callback: msRest.ServiceCallback<Vault>): void
update(resourceGroupName: string, vaultName: string, parameters: VaultPatchParameters, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<Vault>): void

- Defined in operations/vaults.ts:74
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: msRest.RequestOptionsBase
Returns Promise<Models.VaultsUpdateResponse>

Promise<Models.VaultsUpdateResponse>
- Defined in operations/vaults.ts:81
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: msRest.ServiceCallback<Vault>
  
  The callback
Returns void
- Defined in operations/vaults.ts:89
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
  
  The optional parameters
- callback: msRest.ServiceCallback<Vault>
  
  The callback
Returns void

updateAccessPolicy

updateAccessPolicy(resourceGroupName: string, vaultName: string, operationKind: Models.AccessPolicyUpdateKind, parameters: VaultAccessPolicyParameters, options?: msRest.RequestOptionsBase): Promise<Models.VaultsUpdateAccessPolicyResponse>
updateAccessPolicy(resourceGroupName: string, vaultName: string, operationKind: Models.AccessPolicyUpdateKind, parameters: VaultAccessPolicyParameters, callback: msRest.ServiceCallback<VaultAccessPolicyParameters>): void
updateAccessPolicy(resourceGroupName: string, vaultName: string, operationKind: Models.AccessPolicyUpdateKind, parameters: VaultAccessPolicyParameters, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<VaultAccessPolicyParameters>): void

- Defined in operations/vaults.ts:175
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: Models.AccessPolicyUpdateKind
  
  Name of the operation. Possible values include: 'add', 'replace', 'remove'
- parameters: VaultAccessPolicyParameters
  
  Access policy to merge into the vault
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.VaultsUpdateAccessPolicyResponse>

Promise<Models.VaultsUpdateAccessPolicyResponse>
- Defined in operations/vaults.ts:183
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: msRest.ServiceCallback<VaultAccessPolicyParameters>
  
  The callback
Returns void
- Defined in operations/vaults.ts:192
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
  
  The optional parameters
- callback: msRest.ServiceCallback<VaultAccessPolicyParameters>
  
  The callback
Returns void

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

client: KeyVaultManagementClientContext

Returns Vaults

Methods

beginPurgeDeleted

Parameters

vaultName: string

location: string

Optional options: msRest.RequestOptionsBase

Returns Promise<msRestAzure.LROPoller>

checkNameAvailability

Parameters

vaultName: VaultCheckNameAvailabilityParameters

Optional options: msRest.RequestOptionsBase

Returns Promise<Models.VaultsCheckNameAvailabilityResponse>

Parameters

vaultName: VaultCheckNameAvailabilityParameters

callback: msRest.ServiceCallback<CheckNameAvailabilityResult>

Returns void

Parameters

vaultName: VaultCheckNameAvailabilityParameters

options: msRest.RequestOptionsBase

callback: msRest.ServiceCallback<CheckNameAvailabilityResult>

Returns void

createOrUpdate

Parameters

resourceGroupName: string

vaultName: string

parameters: VaultCreateOrUpdateParameters

Optional options: msRest.RequestOptionsBase

Returns Promise<Models.VaultsCreateOrUpdateResponse>

Parameters

resourceGroupName: string

vaultName: string

parameters: VaultCreateOrUpdateParameters

callback: msRest.ServiceCallback<Vault>

Returns void

Parameters

resourceGroupName: string

vaultName: string

parameters: VaultCreateOrUpdateParameters

options: msRest.RequestOptionsBase

callback: msRest.ServiceCallback<Vault>

Returns void

deleteMethod

Parameters

resourceGroupName: string

vaultName: string

Optional options: msRest.RequestOptionsBase

Returns Promise<msRest.RestResponse>

Parameters

resourceGroupName: string

vaultName: string

callback: msRest.ServiceCallback<void>

Returns void

Parameters

resourceGroupName: string

vaultName: string

options: msRest.RequestOptionsBase

callback: msRest.ServiceCallback<void>

Returns void

get

Parameters

resourceGroupName: string

vaultName: string

Optional options: msRest.RequestOptionsBase

Returns Promise<Models.VaultsGetResponse>

Parameters

resourceGroupName: string

vaultName: string

callback: msRest.ServiceCallback<Vault>

Returns void

Parameters

resourceGroupName: string