ProtectedItems interface

Package:

@azure/arm-recoveryservicesbackup

Interface representing a ProtectedItems.

Methods

createOrUpdate(string, string, string, string, string, ProtectedItemResource, ProtectedItemsCreateOrUpdateOptionalParams)	Enables backup of an item or to modifies the backup policy information of an already backed up item. This is an asynchronous operation. To know the status of the operation, call the GetItemOperationResult API.
delete(string, string, string, string, string, ProtectedItemsDeleteOptionalParams)	Used to disable backup of an item within a container. This is an asynchronous operation. To know the status of the request, call the GetItemOperationResult API.
get(string, string, string, string, string, ProtectedItemsGetOptionalParams)	Provides the details of the backed up item. This is an asynchronous operation. To know the status of the operation, call the GetItemOperationResult API.

Method Details

createOrUpdate(string, string, string, string, string, ProtectedItemResource, ProtectedItemsCreateOrUpdateOptionalParams)

Enables backup of an item or to modifies the backup policy information of an already backed up item. This is an asynchronous operation. To know the status of the operation, call the GetItemOperationResult API.

function createOrUpdate(vaultName: string, resourceGroupName: string, fabricName: string, containerName: string, protectedItemName: string, parameters: ProtectedItemResource, options?: ProtectedItemsCreateOrUpdateOptionalParams): Promise<ProtectedItemResource>

Parameters

vaultName

string

The name of the recovery services vault.

resourceGroupName

string

The name of the resource group where the recovery services vault is present.

fabricName

string

Fabric name associated with the backup item.

containerName

string

Container name associated with the backup item.

protectedItemName

string

Item name to be backed up.

parameters

ProtectedItemResource

resource backed up item

options

ProtectedItemsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<ProtectedItemResource>

delete(string, string, string, string, string, ProtectedItemsDeleteOptionalParams)

Used to disable backup of an item within a container. This is an asynchronous operation. To know the status of the request, call the GetItemOperationResult API.

function delete(vaultName: string, resourceGroupName: string, fabricName: string, containerName: string, protectedItemName: string, options?: ProtectedItemsDeleteOptionalParams): Promise<void>

Parameters

vaultName

string

The name of the recovery services vault.

resourceGroupName

string

The name of the resource group where the recovery services vault is present.

fabricName

string

Fabric name associated with the backed up item.

containerName

string

Container name associated with the backed up item.

protectedItemName

string

Backed up item to be deleted.

options

ProtectedItemsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, string, string, ProtectedItemsGetOptionalParams)

Provides the details of the backed up item. This is an asynchronous operation. To know the status of the operation, call the GetItemOperationResult API.

function get(vaultName: string, resourceGroupName: string, fabricName: string, containerName: string, protectedItemName: string, options?: ProtectedItemsGetOptionalParams): Promise<ProtectedItemResource>

Parameters

vaultName

string

The name of the recovery services vault.

resourceGroupName

string

The name of the resource group where the recovery services vault is present.

fabricName

string

Fabric name associated with the backed up item.

containerName

string

Container name associated with the backed up item.

protectedItemName

string

Backed up item name whose details are to be fetched.

options

ProtectedItemsGetOptionalParams

The options parameters.

Returns

Promise<ProtectedItemResource>