Backups - Trigger

Layanan:

Recovery Services - Backup

Versi API:

2026-08-01

Memicu pencadangan untuk item yang dicadangkan yang ditentukan. Ini adalah operasi asinkron. Untuk mengetahui status operasi, panggil 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=2026-08-01

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
containerName	path	True	string	Nama wadah yang detailnya perlu diambil.
fabricName	path	True	string	Nama BackupFabricResource
protectedItemName	path	True	string	Nama item yang dicadangkan yang detailnya akan diambil.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nama grup sumber daya. Nama tidak sensitif terhadap penggunaan huruf besar atau kecil.
subscriptionId	path	True	string minLength: 1	ID langganan target.
vaultName	path	True	string	Nama VaultResource
api-version	query	True	string minLength: 1	Versi API yang akan digunakan untuk operasi ini.

Isi Permintaan

Nama	Jenis	Deskripsi
eTag	string	ETag opsional.
location	string	Lokasi sumber daya.
properties	BackupRequest: AzureFileShareBackupRequest AzureWorkloadBackupRequest IaasVMBackupRequest	Properti dari BackupRequestResource
tags	object	Tag sumber daya.

Respons

Nama	Jenis	Deskripsi
202 Accepted		Permintaan telah diterima untuk diproses, tetapi pemrosesan belum selesai.
Other Status Codes	ErrorResponse	Respons kesalahan yang tidak terduga.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory.

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

Trigger Backup

Permintaan sampel

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

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

Java

import com.azure.resourcemanager.recoveryservicesbackup.models.BackupRequestResource;
import com.azure.resourcemanager.recoveryservicesbackup.models.IaasVMBackupRequest;

/**
 * Samples for Backups Trigger.
 */
public final class Main {
    /*
     * x-ms-original-file: 2026-08-01/Common/TriggerBackup_Post.json
     */
    /**
     * Sample code: Trigger Backup.
     * 
     * @param manager Entry point to RecoveryServicesBackupManager.
     */
    public static void
        triggerBackup(com.azure.resourcemanager.recoveryservicesbackup.RecoveryServicesBackupManager manager) {
        manager.backups().triggerWithResponse("linuxRsVault", "linuxRsVaultRG", "Azure",
            "IaasVMContainer;iaasvmcontainerv2;testrg;v1win2012r", "VM;iaasvmcontainerv2;testrg;v1win2012r",
            new BackupRequestResource().withProperties(new IaasVMBackupRequest()), com.azure.core.util.Context.NONE);
    }
}

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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.recoveryservicesbackup 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="SUBSCRIPTION_ID",
    )

    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: 2026-08-01/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/v5"
)

// Generated from example definition: 2026-08-01/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("00000000-0000-0000-0000-000000000000", 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: 2026-08-01/Common/TriggerBackup_Post.json
 */
async function triggerBackup() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-0000-0000-0000-000000000000";
  const client = new RecoveryServicesBackupClient(credential, subscriptionId);
  await client.backups.trigger(
    "linuxRsVault",
    "linuxRsVaultRG",
    "Azure",
    "IaasVMContainer;iaasvmcontainerv2;testrg;v1win2012r",
    "VM;iaasvmcontainerv2;testrg;v1win2012r",
    { properties: { objectType: "IaasVMBackupRequest" } },
  );
}

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

Respon sampel

Kode status:

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

Definisi

Nama	Deskripsi
AzureFileShareBackupRequest	Permintaan pencadangan khusus beban kerja AzureFileShare.
AzureWorkloadBackupRequest	Permintaan pencadangan khusus beban kerja AzureWorkload.
BackupRequestResource	Kelas dasar untuk permintaan pencadangan. Permintaan pencadangan khusus beban kerja berasal dari kelas ini.
BackupType	Jenis cadangan, viz. Penuh, Diferensial, Log, atau CopyOnlyFull
createdByType	Jenis identitas yang membuat sumber daya tersebut.
ErrorDetail	Kelas Detail Kesalahan yang merangkum Kode, Pesan, dan Rekomendasi.
ErrorResponse	Tanggapan kesalahan
IaasVMBackupRequest	Permintaan pencadangan khusus beban kerja IaaS VM.
systemData	Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

AzureFileShareBackupRequest

Objek

Permintaan pencadangan khusus beban kerja AzureFileShare.

Nama	Jenis	Deskripsi
objectType	string: AzureFileShareBackupRequest	Properti ini akan digunakan sebagai diskriminator untuk memutuskan jenis tertentu dalam rantai polimorfik jenis.
recoveryPointExpiryTimeInUTC	string (date-time)	Salinan cadangan akan kedaluwarsa setelah waktu yang ditentukan (UTC).

AzureWorkloadBackupRequest

Objek

Permintaan pencadangan khusus beban kerja AzureWorkload.

Nama	Jenis	Deskripsi
backupType	BackupType	Jenis cadangan, viz. Penuh, Diferensial, Log, atau CopyOnlyFull
enableCompression	boolean	Bool untuk pengaturan Kompresi
objectType	string: AzureWorkloadBackupRequest	Properti ini akan digunakan sebagai diskriminator untuk memutuskan jenis tertentu dalam rantai polimorfik jenis.
recoveryPointExpiryTimeInUTC	string (date-time)	Salinan cadangan akan kedaluwarsa setelah waktu yang ditentukan (UTC).

BackupRequestResource

Objek

Kelas dasar untuk permintaan pencadangan. Permintaan pencadangan khusus beban kerja berasal dari kelas ini.

Nama	Jenis	Deskripsi
eTag	string	ETag opsional.
id	string	ID sumber daya lengkap untuk sumber daya tersebut. Contoh - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Lokasi sumber daya.
name	string	Nama sumber daya.
properties	BackupRequest: AzureFileShareBackupRequest AzureWorkloadBackupRequest IaasVMBackupRequest	Properti dari BackupRequestResource
systemData	systemData	Metadata Azure Resource Manager yang berisi informasi createBy dan modifiedBy.
tags	object	Tag sumber daya.
type	string	Jenis sumber daya. Misalnya, "Microsoft.Compute/virtualMachines" atau "Microsoft.Storage/storageAccounts"

BackupType

Enumerasi

Jenis cadangan, viz. Penuh, Diferensial, Log, atau CopyOnlyFull

Nilai	Deskripsi
Invalid
Full
Differential
Log
CopyOnlyFull
Incremental
SnapshotFull
SnapshotCopyOnlyFull

createdByType

Enumerasi

Jenis identitas yang membuat sumber daya tersebut.

Nilai	Deskripsi
User
Application
ManagedIdentity
Key

ErrorDetail

Objek

Kelas Detail Kesalahan yang merangkum Kode, Pesan, dan Rekomendasi.

Nama	Jenis	Deskripsi
code	string	Kode kesalahan.
message	string	Pesan Kesalahan yang terkait dengan Kode.
recommendations	string[]	Daftar string rekomendasi.

ErrorResponse

Objek

Tanggapan kesalahan

Nama	Jenis	Deskripsi
error	ErrorDetail	Objek kesalahan.

IaasVMBackupRequest

Objek

Permintaan pencadangan khusus beban kerja IaaS VM.

Nama	Jenis	Deskripsi
objectType	string: IaasVMBackupRequest	Properti ini akan digunakan sebagai diskriminator untuk memutuskan jenis tertentu dalam rantai polimorfik jenis.
recoveryPointExpiryTimeInUTC	string (date-time)	Salinan cadangan akan kedaluwarsa setelah waktu yang ditentukan (UTC).

systemData

Objek

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

Nama	Jenis	Deskripsi
createdAt	string (date-time)	Tanda waktu pembuatan sumber daya (UTC).
createdBy	string	Identitas yang membuat sumber daya tersebut.
createdByType	createdByType	Jenis identitas yang membuat sumber daya tersebut.
lastModifiedAt	string (date-time)	Tanda waktu modifikasi terakhir sumber daya (UTC)
lastModifiedBy	string	Identitas yang terakhir kali mengubah sumber daya.
lastModifiedByType	createdByType	Jenis identitas yang terakhir memodifikasi sumber daya.