Backups - Trigger

Service:

Recovery Services - Backup

API Version:

2024-04-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=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: AzureFileShareBackupRequest AzureWorkloadBackupRequest IaasVMBackupRequest	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

HTTP

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"
  }
}

Python

from typing import Any, IO, Union

from azure.identity import DefaultAzureCredential

from azure.mgmt.recoveryservicesbackup.activestamp import RecoveryServicesBackupClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-recoveryservicesbackup
# USAGE
    python trigger_backup_post.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = RecoveryServicesBackupClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    client.backups.trigger(
        vault_name="linuxRsVault",
        resource_group_name="linuxRsVaultRG",
        fabric_name="Azure",
        container_name="IaasVMContainer;iaasvmcontainerv2;testrg;v1win2012r",
        protected_item_name="VM;iaasvmcontainerv2;testrg;v1win2012r",
        parameters={"properties": {"objectType": "IaasVMBackupRequest"}},
    )


# x-ms-original-file: specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/Common/TriggerBackup_Post.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armrecoveryservicesbackup_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/recoveryservices/armrecoveryservicesbackup/v4"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/33c4457b1d13f83965f4fe3367dca4a6df898100/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/Common/TriggerBackup_Post.json
func ExampleBackupsClient_Trigger() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armrecoveryservicesbackup.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = clientFactory.NewBackupsClient().Trigger(ctx, "linuxRsVault", "linuxRsVaultRG", "Azure", "IaasVMContainer;iaasvmcontainerv2;testrg;v1win2012r", "VM;iaasvmcontainerv2;testrg;v1win2012r", armrecoveryservicesbackup.BackupRequestResource{
		Properties: &armrecoveryservicesbackup.IaasVMBackupRequest{
			ObjectType: to.Ptr("IaasVMBackupRequest"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { RecoveryServicesBackupClient } = require("@azure/arm-recoveryservicesbackup");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Triggers backup for specified backed up item. This is an asynchronous operation. To know the status of the
operation, call GetProtectedItemOperationResult API.
 *
 * @summary Triggers backup for specified backed up item. This is an asynchronous operation. To know the status of the
operation, call GetProtectedItemOperationResult API.
 * x-ms-original-file: specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/Common/TriggerBackup_Post.json
 */
async function triggerBackup() {
  const subscriptionId =
    process.env["RECOVERYSERVICESBACKUP_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const vaultName = "linuxRsVault";
  const resourceGroupName =
    process.env["RECOVERYSERVICESBACKUP_RESOURCE_GROUP"] || "linuxRsVaultRG";
  const fabricName = "Azure";
  const containerName = "IaasVMContainer;iaasvmcontainerv2;testrg;v1win2012r";
  const protectedItemName = "VM;iaasvmcontainerv2;testrg;v1win2012r";
  const parameters = {
    properties: { objectType: "IaasVMBackupRequest" },
  };
  const credential = new DefaultAzureCredential();
  const client = new RecoveryServicesBackupClient(credential, subscriptionId);
  const result = await client.backups.trigger(
    vaultName,
    resourceGroupName,
    fabricName,
    containerName,
    protectedItemName,
    parameters,
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:

202

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: AzureFileShareBackupRequest AzureWorkloadBackupRequest IaasVMBackupRequest	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).