Share via

Backups - Trigger

Service:
Recovery Services - Backup
API Version:
2025-08-01

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=2025-08-01

URI Parameters

Name In Required Type Description
containerName
 path True

string

Name of the container whose details need to be fetched.
fabricName
 path True

string

The name of the BackupFabricResource
protectedItemName
 path True

string

Backed up item name whose details are to be fetched.
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

The name of the resource group. The name is case insensitive.
subscriptionId
 path True

string

minLength: 1

The ID of the target subscription.
vaultName
 path True

string

The name of the VaultResource
api-version
 query True

string

minLength: 1

The API version to use for this operation.

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

The request has been accepted for processing, but processing has not yet completed.
Other Status Codes

ErrorResponse

An unexpected error response.

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=2025-08-01

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

Sample response

Status code:
202 
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
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
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
createdByType

The type of identity that created the resource.
ErrorDetail

Error Detail class which encapsulates Code, Message and Recommendations.
ErrorResponse

Error response
IaasVMBackupRequest

IaaS VM workload-specific backup request.
systemData

Metadata pertaining to creation and last modification of the resource.

AzureFileShareBackupRequest

Object

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 (date-time)

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

AzureWorkloadBackupRequest

Object

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 (date-time)

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

BackupRequestResource

Object

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

Name Type Description
eTag

string

Optional ETag.
id

string

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location

string

Resource location.
name

string

The name of the resource
properties BackupRequest:

BackupRequestResource properties
systemData

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags

object

Resource tags.
type

string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

BackupType

Enumeration

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

Value Description
Invalid
Full
Differential
Log
CopyOnlyFull
Incremental
SnapshotFull
SnapshotCopyOnlyFull

createdByType

Enumeration

The type of identity that created the resource.

Value Description
User
Application
ManagedIdentity
Key

ErrorDetail

Object

Error Detail class which encapsulates Code, Message and Recommendations.

Name Type Description
code

string

Error code.
message

string

Error Message related to the Code.
recommendations

string[]

List of recommendation strings.

ErrorResponse

Object

Error response

Name Type Description
error

ErrorDetail

The error object.

IaasVMBackupRequest

Object

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 (date-time)

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

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name Type Description
createdAt

string (date-time)

The timestamp of resource creation (UTC).
createdBy

string

The identity that created the resource.
createdByType

createdByType

The type of identity that created the resource.
lastModifiedAt

string (date-time)

The timestamp of resource last modification (UTC)
lastModifiedBy

string

The identity that last modified the resource.
lastModifiedByType

createdByType

The type of identity that last modified the resource.