Backups - Trigger

Triggers backup for specified backed up item. This is an asynchronous operation. To know the status of the operation, call GetProtectedItemOperationResult API.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}/backup?api-version=2024-04-01

URI Parameters

Name In Required Type Description
containerName
path True

string

Container name associated with the backup item.

fabricName
path True

string

Fabric name associated with the backup item.

protectedItemName
path True

string

Backup item for which backup needs to be triggered.

resourceGroupName
path True

string

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

subscriptionId
path True

string

The subscription Id.

vaultName
path True

string

The name of the recovery services vault.

api-version
query True

string

Client Api Version.

Request Body

Name Type Description
eTag

string

Optional ETag.

location

string

Resource location.

properties BackupRequest:

BackupRequestResource properties

tags

object

Resource tags.

Responses

Name Type Description
202 Accepted

Accepted

Other Status Codes

CloudError

Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account.

Examples

Trigger Backup

Sample request

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/linuxRsVaultRG/providers/Microsoft.RecoveryServices/vaults/linuxRsVault/backupFabrics/Azure/protectionContainers/IaasVMContainer;iaasvmcontainerv2;testrg;v1win2012r/protectedItems/VM;iaasvmcontainerv2;testrg;v1win2012r/backup?api-version=2024-04-01

{
  "properties": {
    "objectType": "IaasVMBackupRequest"
  }
}

Sample response

Location: https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/linuxRsVaultRG/providers/Microsoft.RecoveryServices/vaults/linuxRsVault/backupFabrics/Azure/protectionContainers/IaasVMContainer;iaasvmcontainer;testrg;v1win2012r/protectedItems/VM;iaasvmcontainer;testrg;v1win2012r/operationResults/00000000-0000-0000-0000-000000000000?api-version=2016-12-01
Azure-AsyncOperation: https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/linuxRsVaultRG/providers/Microsoft.RecoveryServices/vaults/linuxRsVault/backupFabrics/Azure/protectionContainers/IaasVMContainer;iaasvmcontainer;testrg;v1win2012r/protectedItems/VM;iaasvmcontainer;testrg;v1win2012r/operationsStatus/00000000-0000-0000-0000-000000000000?api-version=2016-12-01
Retry-After: 60

Definitions

Name Description
AzureFileShareBackupRequest

AzureFileShare workload-specific backup request.

AzureWorkloadBackupRequest

AzureWorkload workload-specific backup request.

BackupRequestResource

Base class for backup request. Workload-specific backup requests are derived from this class.

backupType

Type of backup, viz. Full, Differential, Log or CopyOnlyFull

CloudError

An error response from the Container Instance service.

CloudErrorBody

An error response from the Container Instance service.

ErrorAdditionalInfo

The resource management error additional info.

IaasVMBackupRequest

IaaS VM workload-specific backup request.

AzureFileShareBackupRequest

AzureFileShare workload-specific backup request.

Name Type Description
objectType string:

AzureFileShareBackupRequest

This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.

recoveryPointExpiryTimeInUTC

string

Backup copy will expire after the time specified (UTC).

AzureWorkloadBackupRequest

AzureWorkload workload-specific backup request.

Name Type Description
backupType

backupType

Type of backup, viz. Full, Differential, Log or CopyOnlyFull

enableCompression

boolean

Bool for Compression setting

objectType string:

AzureWorkloadBackupRequest

This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.

recoveryPointExpiryTimeInUTC

string

Backup copy will expire after the time specified (UTC).

BackupRequestResource

Base class for backup request. Workload-specific backup requests are derived from this class.

Name Type Description
eTag

string

Optional ETag.

id

string

Resource Id represents the complete path to the resource.

location

string

Resource location.

name

string

Resource name associated with the resource.

properties BackupRequest:

BackupRequestResource properties

tags

object

Resource tags.

type

string

Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...

backupType

Type of backup, viz. Full, Differential, Log or CopyOnlyFull

Name Type Description
CopyOnlyFull

string

Differential

string

Full

string

Incremental

string

Invalid

string

Log

string

SnapshotCopyOnlyFull

string

SnapshotFull

string

CloudError

An error response from the Container Instance service.

Name Type Description
error

CloudErrorBody

The error object.

CloudErrorBody

An error response from the Container Instance service.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

The error additional info.

code

string

An identifier for the error. Codes are invariant and are intended to be consumed programmatically.

details

CloudErrorBody[]

A list of additional details about the error.

message

string

A message describing the error, intended to be suitable for display in a user interface.

target

string

The target of the particular error. For example, the name of the property in error.

ErrorAdditionalInfo

The resource management error additional info.

Name Type Description
info

object

The additional info.

type

string

The additional info type.

IaasVMBackupRequest

IaaS VM workload-specific backup request.

Name Type Description
objectType string:

IaasVMBackupRequest

This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.

recoveryPointExpiryTimeInUTC

string

Backup copy will expire after the time specified (UTC).