ProtectedItem interface

Package:

@azure/arm-recoveryservicesdatareplication

Interface representing a ProtectedItem.

Methods

beginCreate(string, string, string, ProtectedItemCreateOptionalParams)	Creates the protected item.
beginCreateAndWait(string, string, string, ProtectedItemCreateOptionalParams)	Creates the protected item.
beginDelete(string, string, string, ProtectedItemDeleteOptionalParams)	Removes the protected item.
beginDeleteAndWait(string, string, string, ProtectedItemDeleteOptionalParams)	Removes the protected item.
beginPlannedFailover(string, string, string, ProtectedItemPlannedFailoverOptionalParams)	Performs the planned failover on the protected item.
beginPlannedFailoverAndWait(string, string, string, ProtectedItemPlannedFailoverOptionalParams)	Performs the planned failover on the protected item.
get(string, string, string, ProtectedItemGetOptionalParams)	Gets the details of the protected item.
list(string, string, ProtectedItemListOptionalParams)	Gets the list of protected items in the given vault.

Method Details

beginCreate(string, string, string, ProtectedItemCreateOptionalParams)

Creates the protected item.

function beginCreate(resourceGroupName: string, vaultName: string, protectedItemName: string, options?: ProtectedItemCreateOptionalParams): Promise<SimplePollerLike<OperationState<ProtectedItemModel>, ProtectedItemModel>>

Parameters

resourceGroupName

string

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

vaultName

string

The vault name.

protectedItemName

string

The protected item name.

options

ProtectedItemCreateOptionalParams

The options parameters.

Returns

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

beginCreateAndWait(string, string, string, ProtectedItemCreateOptionalParams)

Creates the protected item.

function beginCreateAndWait(resourceGroupName: string, vaultName: string, protectedItemName: string, options?: ProtectedItemCreateOptionalParams): Promise<ProtectedItemModel>

Parameters

resourceGroupName

string

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

vaultName

string

The vault name.

protectedItemName

string

The protected item name.

options

ProtectedItemCreateOptionalParams

The options parameters.

Returns

Promise<ProtectedItemModel>

beginDelete(string, string, string, ProtectedItemDeleteOptionalParams)

Removes the protected item.

function beginDelete(resourceGroupName: string, vaultName: string, protectedItemName: string, options?: ProtectedItemDeleteOptionalParams): Promise<SimplePollerLike<OperationState<ProtectedItemDeleteHeaders>, ProtectedItemDeleteHeaders>>

Parameters

resourceGroupName

string

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

vaultName

string

The vault name.

protectedItemName

string

The protected item name.

options

ProtectedItemDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, string, ProtectedItemDeleteOptionalParams)

Removes the protected item.

function beginDeleteAndWait(resourceGroupName: string, vaultName: string, protectedItemName: string, options?: ProtectedItemDeleteOptionalParams): Promise<ProtectedItemDeleteHeaders>

Parameters

resourceGroupName

string

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

vaultName

string

The vault name.

protectedItemName

string

The protected item name.

options

ProtectedItemDeleteOptionalParams

The options parameters.

Returns

Promise<ProtectedItemDeleteHeaders>

beginPlannedFailover(string, string, string, ProtectedItemPlannedFailoverOptionalParams)

Performs the planned failover on the protected item.

function beginPlannedFailover(resourceGroupName: string, vaultName: string, protectedItemName: string, options?: ProtectedItemPlannedFailoverOptionalParams): Promise<SimplePollerLike<OperationState<PlannedFailoverModel>, PlannedFailoverModel>>

Parameters

resourceGroupName

string

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

vaultName

string

The vault name.

protectedItemName

string

The protected item name.

options

ProtectedItemPlannedFailoverOptionalParams

The options parameters.

Returns

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

beginPlannedFailoverAndWait(string, string, string, ProtectedItemPlannedFailoverOptionalParams)

Performs the planned failover on the protected item.

function beginPlannedFailoverAndWait(resourceGroupName: string, vaultName: string, protectedItemName: string, options?: ProtectedItemPlannedFailoverOptionalParams): Promise<PlannedFailoverModel>

Parameters

resourceGroupName

string

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

vaultName

string

The vault name.

protectedItemName

string

The protected item name.

options

ProtectedItemPlannedFailoverOptionalParams

The options parameters.

Returns

Promise<PlannedFailoverModel>

get(string, string, string, ProtectedItemGetOptionalParams)

Gets the details of the protected item.

function get(resourceGroupName: string, vaultName: string, protectedItemName: string, options?: ProtectedItemGetOptionalParams): Promise<ProtectedItemModel>

Parameters

resourceGroupName

string

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

vaultName

string

The vault name.

protectedItemName

string

The protected item name.

options

ProtectedItemGetOptionalParams

The options parameters.

Returns

Promise<ProtectedItemModel>

list(string, string, ProtectedItemListOptionalParams)

Gets the list of protected items in the given vault.

function list(resourceGroupName: string, vaultName: string, options?: ProtectedItemListOptionalParams): PagedAsyncIterableIterator<ProtectedItemModel, ProtectedItemModel[], PageSettings>

Parameters

resourceGroupName

string

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

vaultName

string

The vault name.

options

ProtectedItemListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ProtectedItemModel, ProtectedItemModel[], PageSettings>