Backups - Trigger

참조

Service:: Recovery Services - Backup

API Version:: 2023-02-01

지정된 백업 항목에 대한 백업을 트리거합니다. 이 작업은 비동기 작업입니다. 작업의 상태 알아보려면 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=2023-02-01

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
containerName	path	True	string	백업 항목과 연결된 컨테이너 이름입니다.
fabricName	path	True	string	백업 항목과 연결된 패브릭 이름입니다.
protectedItemName	path	True	string	백업을 트리거해야 하는 백업 항목입니다.
resourceGroupName	path	True	string	복구 서비스 자격 증명 모음이 있는 리소스 그룹의 이름입니다.
subscriptionId	path	True	string	구독 ID입니다.
vaultName	path	True	string	복구 서비스 자격 증명 모음의 이름입니다.
api-version	query	True	string	클라이언트 API 버전.

요청 본문

Name	형식	Description
eTag	string	선택적 ETag입니다.
location	string	리소스 위치.
properties	BackupRequest: AzureFileShareBackupRequest AzureWorkloadBackupRequest IaasVMBackupRequest	BackupRequestResource 속성
tags	object	리소스 태그.

응답

Name	형식	Description
202 Accepted		수락됨
Other Status Codes	CloudError	작업이 실패한 이유를 설명하는 오류 응답입니다.

보안

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	사용자 계정을 가장합니다.

예제

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=2023-02-01

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

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: specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2023-02-01/examples/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

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="00000000-0000-0000-0000-000000000000",
    )

    response = 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"}},
    )
    print(response)


# x-ms-original-file: specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2023-02-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

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/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/a498cae6d1a93f4c33073f0747b93b22815c09b7/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2023-02-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

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/2023-02-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

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.RecoveryServicesBackup;
using Azure.ResourceManager.RecoveryServicesBackup.Models;

// Generated from example definition: specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2023-02-01/examples/Common/TriggerBackup_Post.json
// this example is just showing the usage of "Backups_Trigger" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this BackupProtectedItemResource created on azure
// for more information of creating BackupProtectedItemResource, please refer to the document of BackupProtectedItemResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
string resourceGroupName = "linuxRsVaultRG";
string vaultName = "linuxRsVault";
string fabricName = "Azure";
string containerName = "IaasVMContainer;iaasvmcontainerv2;testrg;v1win2012r";
string protectedItemName = "VM;iaasvmcontainerv2;testrg;v1win2012r";
ResourceIdentifier backupProtectedItemResourceId = BackupProtectedItemResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, vaultName, fabricName, containerName, protectedItemName);
BackupProtectedItemResource backupProtectedItem = client.GetBackupProtectedItemResource(backupProtectedItemResourceId);

// invoke the operation
TriggerBackupContent content = new TriggerBackupContent(new AzureLocation("placeholder"))
{
    Properties = new IaasVmBackupContent(),
};
await backupProtectedItem.TriggerBackupAsync(content);

Console.WriteLine($"Succeeded");

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

정의

Name	Description
AzureFileShareBackupRequest	AzureFileShare 워크로드별 백업 요청.
AzureWorkloadBackupRequest	AzureWorkload 워크로드별 백업 요청.
BackupRequestResource	백업 요청에 대한 기본 클래스입니다. 워크로드별 백업 요청은 이 클래스에서 파생됩니다.
backupType	백업 유형, viz. 전체, 차등, 로그 또는 CopyOnlyFull
CloudError	Container Instance 서비스의 오류 응답입니다.
CloudErrorBody	Container Instance 서비스의 오류 응답입니다.
ErrorAdditionalInfo	리소스 관리 오류 추가 정보입니다.
IaasVMBackupRequest	IaaS VM 워크로드별 백업 요청.

AzureFileShareBackupRequest

AzureFileShare 워크로드별 백업 요청.

Name	형식	Description
objectType	string: AzureFileShareBackupRequest	이 속성은 형식의 다형 체인에서 특정 형식을 결정하는 판별자로 사용됩니다.
recoveryPointExpiryTimeInUTC	string	백업 복사는 지정된 시간(UTC) 후에 만료됩니다.

AzureWorkloadBackupRequest

AzureWorkload 워크로드별 백업 요청.

Name	형식	Description
backupType	backupType	백업 유형, viz. 전체, 차등, 로그 또는 CopyOnlyFull
enableCompression	boolean	압축용 Bool 설정
objectType	string: AzureWorkloadBackupRequest	이 속성은 형식의 다형 체인에서 특정 형식을 결정하는 판별자로 사용됩니다.
recoveryPointExpiryTimeInUTC	string	백업 복사는 지정된 시간(UTC) 후에 만료됩니다.

BackupRequestResource

백업 요청에 대한 기본 클래스입니다. 워크로드별 백업 요청은 이 클래스에서 파생됩니다.

Name	형식	Description
eTag	string	선택적 ETag입니다.
id	string	리소스 ID는 리소스의 전체 경로를 나타냅니다.
location	string	리소스 위치.
name	string	리소스와 연결된 리소스 이름입니다.
properties	BackupRequest: AzureFileShareBackupRequest AzureWorkloadBackupRequest IaasVMBackupRequest	BackupRequestResource 속성
tags	object	리소스 태그.
type	string	리소스 종류는 네임스페이스/ResourceType/ResourceType/... 양식의 전체 경로를 나타냅니다.

backupType

백업 유형, viz. 전체, 차등, 로그 또는 CopyOnlyFull

Name	형식	Description
CopyOnlyFull	string
Differential	string
Full	string
Incremental	string
Invalid	string
Log	string
SnapshotCopyOnlyFull	string
SnapshotFull	string

CloudError

Container Instance 서비스의 오류 응답입니다.

Name	형식	Description
error	CloudErrorBody	Error 개체.

CloudErrorBody

Container Instance 서비스의 오류 응답입니다.

Name	형식	Description
additionalInfo	ErrorAdditionalInfo[]	오류 추가 정보입니다.
code	string	오류의 식별자입니다. 코드는 고정이며 프로그래밍 방식으로 사용하기 위한 것입니다.
details	CloudErrorBody[]	오류에 대한 추가 세부 정보 목록입니다.
message	string	사용자 인터페이스에 표시하기에 적합한 오류를 설명하는 메시지입니다.
target	string	특정 오류의 대상입니다. 예를 들어 오류에 있는 속성의 이름입니다.

ErrorAdditionalInfo

리소스 관리 오류 추가 정보입니다.

Name	형식	Description
info	object	추가 정보입니다.
type	string	추가 정보 유형입니다.

IaasVMBackupRequest

IaaS VM 워크로드별 백업 요청.

Name	형식	Description
objectType	string: IaasVMBackupRequest	이 속성은 형식의 다형 체인에서 특정 형식을 결정하는 판별자로 사용됩니다.
recoveryPointExpiryTimeInUTC	string	백업 복사는 지정된 시간(UTC) 후에 만료됩니다.