Share via

Vaults interface

  • Reference
Package:
@azure/arm-recoveryservices

Interface representing a Vaults.

Methods

beginCreateOrUpdate(string, string, Vault, VaultsCreateOrUpdateOptionalParams)

Creates or updates a Recovery Services vault.
beginCreateOrUpdateAndWait(string, string, Vault, VaultsCreateOrUpdateOptionalParams)

Creates or updates a Recovery Services vault.
beginDelete(string, string, VaultsDeleteOptionalParams)

Deletes a vault.
beginDeleteAndWait(string, string, VaultsDeleteOptionalParams)

Deletes a vault.
beginUpdate(string, string, PatchVault, VaultsUpdateOptionalParams)

Updates the vault.
beginUpdateAndWait(string, string, PatchVault, VaultsUpdateOptionalParams)

Updates the vault.
get(string, string, VaultsGetOptionalParams)

Get the Vault details.
listByResourceGroup(string, VaultsListByResourceGroupOptionalParams)

Retrieve a list of Vaults.
listBySubscriptionId(VaultsListBySubscriptionIdOptionalParams)

Fetches all the resources of the specified type in the subscription.

Method Details

beginCreateOrUpdate(string, string, Vault, VaultsCreateOrUpdateOptionalParams)

Creates or updates a Recovery Services vault.

function beginCreateOrUpdate(resourceGroupName: string, vaultName: string, vault: Vault, options?: VaultsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Vault>, Vault>>

Parameters

resourceGroupName

string

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

vaultName

string

The name of the recovery services vault.

vault
Vault

Recovery Services Vault to be created.

options
VaultsCreateOrUpdateOptionalParams

The options parameters.

Returns

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

beginCreateOrUpdateAndWait(string, string, Vault, VaultsCreateOrUpdateOptionalParams)

Creates or updates a Recovery Services vault.

function beginCreateOrUpdateAndWait(resourceGroupName: string, vaultName: string, vault: Vault, options?: VaultsCreateOrUpdateOptionalParams): Promise<Vault>

Parameters

resourceGroupName

string

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

vaultName

string

The name of the recovery services vault.

vault
Vault

Recovery Services Vault to be created.

options
VaultsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<Vault>

beginDelete(string, string, VaultsDeleteOptionalParams)

Deletes a vault.

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

Parameters

resourceGroupName

string

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

vaultName

string

The name of the recovery services vault.

options
VaultsDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, VaultsDeleteOptionalParams)

Deletes a vault.

function beginDeleteAndWait(resourceGroupName: string, vaultName: string, options?: VaultsDeleteOptionalParams): Promise<VaultsDeleteHeaders>

Parameters

resourceGroupName

string

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

vaultName

string

The name of the recovery services vault.

options
VaultsDeleteOptionalParams

The options parameters.

Returns

Promise<VaultsDeleteHeaders>

beginUpdate(string, string, PatchVault, VaultsUpdateOptionalParams)

Updates the vault.

function beginUpdate(resourceGroupName: string, vaultName: string, vault: PatchVault, options?: VaultsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Vault>, Vault>>

Parameters

resourceGroupName

string

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

vaultName

string

The name of the recovery services vault.

vault
PatchVault

Recovery Services Vault to be created.

options
VaultsUpdateOptionalParams

The options parameters.

Returns

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

beginUpdateAndWait(string, string, PatchVault, VaultsUpdateOptionalParams)

Updates the vault.

function beginUpdateAndWait(resourceGroupName: string, vaultName: string, vault: PatchVault, options?: VaultsUpdateOptionalParams): Promise<Vault>

Parameters

resourceGroupName

string

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

vaultName

string

The name of the recovery services vault.

vault
PatchVault

Recovery Services Vault to be created.

options
VaultsUpdateOptionalParams

The options parameters.

Returns

Promise<Vault>

get(string, string, VaultsGetOptionalParams)

Get the Vault details.

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

Parameters

resourceGroupName

string

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

vaultName

string

The name of the recovery services vault.

options
VaultsGetOptionalParams

The options parameters.

Returns

Promise<Vault>

listByResourceGroup(string, VaultsListByResourceGroupOptionalParams)

Retrieve a list of Vaults.

function listByResourceGroup(resourceGroupName: string, options?: VaultsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Vault, Vault[], PageSettings>

Parameters

resourceGroupName

string

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

options
VaultsListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Vault, Vault[], PageSettings>

listBySubscriptionId(VaultsListBySubscriptionIdOptionalParams)

Fetches all the resources of the specified type in the subscription.

function listBySubscriptionId(options?: VaultsListBySubscriptionIdOptionalParams): PagedAsyncIterableIterator<Vault, Vault[], PageSettings>

Parameters

options
VaultsListBySubscriptionIdOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Vault, Vault[], PageSettings>