ProtectionIntentOperations | @azure/arm-recoveryservicesbackup

Interface representing a ProtectionIntentOperations.

Hierarchy

ProtectionIntentOperations

Implemented by

ProtectionIntentOperationsImpl

Index

Methods

createOrUpdate

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

- Defined in operationsInterfaces/protectionIntentOperations.ts:65
Create Intent for Enabling backup of an item. This is a synchronous operation.

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
- Optional options: ProtectionIntentCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<ProtectionIntentCreateOrUpdateResponse>

delete

delete(vaultName: string, resourceGroupName: string, fabricName: string, intentObjectName: string, options?: ProtectionIntentDeleteOptionalParams): Promise<void>

- Defined in operationsInterfaces/protectionIntentOperations.ts:82
Used to remove intent from an item

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.
- Optional options: ProtectionIntentDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

get

get(vaultName: string, resourceGroupName: string, fabricName: string, intentObjectName: string, options?: ProtectionIntentGetOptionalParams): Promise<ProtectionIntentGetResponse>

- Defined in operationsInterfaces/protectionIntentOperations.ts:48
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.

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.
- Optional options: ProtectionIntentGetOptionalParams
  
  The options parameters.
Returns Promise<ProtectionIntentGetResponse>

validate

validate(azureRegion: string, parameters: PreValidateEnableBackupRequest, options?: ProtectionIntentValidateOptionalParams): Promise<ProtectionIntentValidateResponse>

- Defined in operationsInterfaces/protectionIntentOperations.ts:32
It will validate followings
1. Vault capacity
2. VM is already protected
3. Any VM related configuration passed in properties.
Parameters
- azureRegion: string
  
  Azure region to hit Api
- parameters: PreValidateEnableBackupRequest
  
  Enable backup validation request on Virtual Machine
- Optional options: ProtectionIntentValidateOptionalParams
  
  The options parameters.
Returns Promise<ProtectionIntentValidateResponse>

Hierarchy

Implemented by

Index

Methods

Methods

createOrUpdate

Parameters

vaultName: string

resourceGroupName: string

fabricName: string

intentObjectName: string

parameters: ProtectionIntentResource

Optional options: ProtectionIntentCreateOrUpdateOptionalParams

Returns Promise<ProtectionIntentCreateOrUpdateResponse>

delete

Parameters

vaultName: string

resourceGroupName: string

fabricName: string

intentObjectName: string

Optional options: ProtectionIntentDeleteOptionalParams

Returns Promise<void>

get

Parameters

vaultName: string

resourceGroupName: string

fabricName: string

intentObjectName: string

Optional options: ProtectionIntentGetOptionalParams

Returns Promise<ProtectionIntentGetResponse>

validate

Parameters

azureRegion: string

parameters: PreValidateEnableBackupRequest

Optional options: ProtectionIntentValidateOptionalParams

Returns Promise<ProtectionIntentValidateResponse>