Vault interface

Package:

@azure/arm-recoveryservicesdatareplication

Interface representing a Vault.

Methods

beginCreate(string, string, VaultCreateOptionalParams)	Creates the vault.
beginCreateAndWait(string, string, VaultCreateOptionalParams)	Creates the vault.
beginDelete(string, string, VaultDeleteOptionalParams)	Removes the vault.
beginDeleteAndWait(string, string, VaultDeleteOptionalParams)	Removes the vault.
beginUpdate(string, string, VaultUpdateOptionalParams)	Performs update on the vault.
beginUpdateAndWait(string, string, VaultUpdateOptionalParams)	Performs update on the vault.
get(string, string, VaultGetOptionalParams)	Gets the details of the vault.
list(string, VaultListOptionalParams)	Gets the list of vaults in the given subscription and resource group.
listBySubscription(VaultListBySubscriptionOptionalParams)	Gets the list of vaults in the given subscription.

Method Details

beginCreate(string, string, VaultCreateOptionalParams)

Creates the vault.

function beginCreate(resourceGroupName: string, vaultName: string, options?: VaultCreateOptionalParams): Promise<SimplePollerLike<OperationState<VaultModel>, VaultModel>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

vaultName

string

The vault name.

options

VaultCreateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<VaultModel>, VaultModel>>

beginCreateAndWait(string, string, VaultCreateOptionalParams)

Creates the vault.

function beginCreateAndWait(resourceGroupName: string, vaultName: string, options?: VaultCreateOptionalParams): Promise<VaultModel>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

vaultName

string

The vault name.

options

VaultCreateOptionalParams

The options parameters.

Returns

Promise<VaultModel>

beginDelete(string, string, VaultDeleteOptionalParams)

Removes the vault.

function beginDelete(resourceGroupName: string, vaultName: string, options?: VaultDeleteOptionalParams): Promise<SimplePollerLike<OperationState<VaultDeleteHeaders>, VaultDeleteHeaders>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

vaultName

string

The vault name.

options

VaultDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<VaultDeleteHeaders>, VaultDeleteHeaders>>

beginDeleteAndWait(string, string, VaultDeleteOptionalParams)

Removes the vault.

function beginDeleteAndWait(resourceGroupName: string, vaultName: string, options?: VaultDeleteOptionalParams): Promise<VaultDeleteHeaders>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

vaultName

string

The vault name.

options

VaultDeleteOptionalParams

The options parameters.

Returns

Promise<VaultDeleteHeaders>

beginUpdate(string, string, VaultUpdateOptionalParams)

Performs update on the vault.

function beginUpdate(resourceGroupName: string, vaultName: string, options?: VaultUpdateOptionalParams): Promise<SimplePollerLike<OperationState<VaultModel>, VaultModel>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

vaultName

string

The vault name.

options

VaultUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<VaultModel>, VaultModel>>

beginUpdateAndWait(string, string, VaultUpdateOptionalParams)

Performs update on the vault.

function beginUpdateAndWait(resourceGroupName: string, vaultName: string, options?: VaultUpdateOptionalParams): Promise<VaultModel>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

vaultName

string

The vault name.

options

VaultUpdateOptionalParams

The options parameters.

Returns

Promise<VaultModel>

get(string, string, VaultGetOptionalParams)

Gets the details of the vault.

function get(resourceGroupName: string, vaultName: string, options?: VaultGetOptionalParams): Promise<VaultModel>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

vaultName

string

The vault name.

options

VaultGetOptionalParams

The options parameters.

Returns

Promise<VaultModel>

list(string, VaultListOptionalParams)

Gets the list of vaults in the given subscription and resource group.

function list(resourceGroupName: string, options?: VaultListOptionalParams): PagedAsyncIterableIterator<VaultModel, VaultModel[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

options

VaultListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<VaultModel, VaultModel[], PageSettings>

listBySubscription(VaultListBySubscriptionOptionalParams)

Gets the list of vaults in the given subscription.

function listBySubscription(options?: VaultListBySubscriptionOptionalParams): PagedAsyncIterableIterator<VaultModel, VaultModel[], PageSettings>

Parameters

options

VaultListBySubscriptionOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<VaultModel, VaultModel[], PageSettings>