Share via

ProtectionIntentOperations interface

  • Reference
Package:
@azure/arm-recoveryservicesbackup

Interface representing a ProtectionIntentOperations.

Methods

createOrUpdate(string, string, string, string, ProtectionIntentResource, ProtectionIntentCreateOrUpdateOptionalParams)

Create Intent for Enabling backup of an item. This is a synchronous operation.
delete(string, string, string, string, ProtectionIntentDeleteOptionalParams)

Used to remove intent from an item
get(string, string, string, string, ProtectionIntentGetOptionalParams)

Provides the details of the protection intent up item. This is an asynchronous operation. To know the status of the operation, call the GetItemOperationResult API.
validate(string, PreValidateEnableBackupRequest, ProtectionIntentValidateOptionalParams)

It will validate followings

  1. Vault capacity
  2. VM is already protected
  3. Any VM related configuration passed in properties.

Method Details

createOrUpdate(string, string, string, string, ProtectionIntentResource, ProtectionIntentCreateOrUpdateOptionalParams)

Create Intent for Enabling backup of an item. This is a synchronous operation.

function createOrUpdate(vaultName: string, resourceGroupName: string, fabricName: string, intentObjectName: string, parameters: ProtectionIntentResource, options?: ProtectionIntentCreateOrUpdateOptionalParams): Promise<ProtectionIntentResource>

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.

intentObjectName

string

Intent object name.

parameters
ProtectionIntentResource

resource backed up item

options
ProtectionIntentCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<ProtectionIntentResource>

delete(string, string, string, string, ProtectionIntentDeleteOptionalParams)

Used to remove intent from an item

function delete(vaultName: string, resourceGroupName: string, fabricName: string, intentObjectName: string, options?: ProtectionIntentDeleteOptionalParams): 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 intent.

intentObjectName

string

Intent to be deleted.

options
ProtectionIntentDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, string, ProtectionIntentGetOptionalParams)

Provides the details of the protection intent 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, intentObjectName: string, options?: ProtectionIntentGetOptionalParams): Promise<ProtectionIntentResource>

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.

intentObjectName

string

Backed up item name whose details are to be fetched.

options
ProtectionIntentGetOptionalParams

The options parameters.

Returns

Promise<ProtectionIntentResource>

validate(string, PreValidateEnableBackupRequest, ProtectionIntentValidateOptionalParams)

It will validate followings

  1. Vault capacity
  2. VM is already protected
  3. Any VM related configuration passed in properties.
function validate(azureRegion: string, parameters: PreValidateEnableBackupRequest, options?: ProtectionIntentValidateOptionalParams): Promise<PreValidateEnableBackupResponse>

Parameters

azureRegion

string

Azure region to hit Api

parameters
PreValidateEnableBackupRequest

Enable backup validation request on Virtual Machine

options
ProtectionIntentValidateOptionalParams

The options parameters.

Returns

Promise<PreValidateEnableBackupResponse>