Backups - Trigger

Odwołanie

Service:: Recovery Services - Backup

API Version:: 2023-02-01

Wyzwala tworzenie kopii zapasowej dla określonego elementu kopii zapasowej. To jest operacja asynchroniczna. Aby poznać stan operacji, wywołaj interfejs API GetProtectedItemOperationResult.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
containerName	path	True	string	Nazwa kontenera skojarzona z elementem kopii zapasowej.
fabricName	path	True	string	Nazwa sieci szkieletowej skojarzona z elementem kopii zapasowej.
protectedItemName	path	True	string	Element kopii zapasowej, dla którego należy wyzwolić kopię zapasową.
resourceGroupName	path	True	string	Nazwa grupy zasobów, w której znajduje się magazyn usługi Recovery Services.
subscriptionId	path	True	string	Identyfikator subskrypcji.
vaultName	path	True	string	Nazwa magazynu usługi Recovery Services.
api-version	query	True	string	Wersja interfejsu API klienta.

Treść żądania

Nazwa	Typ	Opis
eTag	string	Opcjonalny element ETag.
location	string	Lokalizacja zasobu.
properties	BackupRequest: AzureFileShareBackupRequest AzureWorkloadBackupRequest IaasVMBackupRequest	Właściwości elementu BackupRequestResource
tags	object	Tagi zasobów.

Odpowiedzi

Nazwa	Typ	Opis
202 Accepted		Zaakceptowano
Other Status Codes	CloudError	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

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

Scopes

Nazwa	Opis
user_impersonation	personifikuj konto użytkownika.

Przykłady

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

Definicje

Nazwa	Opis
AzureFileShareBackupRequest	Żądanie kopii zapasowej specyficzne dla obciążenia AzureFileShare.
AzureWorkloadBackupRequest	Żądanie kopii zapasowej specyficzne dla obciążenia AzureWorkload.
BackupRequestResource	Klasa bazowa dla żądania kopii zapasowej. Żądania kopii zapasowych specyficzne dla obciążenia pochodzą z tej klasy.
backupType	Typ kopii zapasowej, viz. Pełny, różnicowy, dziennik lub copyOnlyFull
CloudError	Odpowiedź o błędzie z usługi Container Instance.
CloudErrorBody	Odpowiedź o błędzie z usługi Container Instance.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
IaasVMBackupRequest	Żądanie kopii zapasowej maszyny wirtualnej IaaS specyficzne dla obciążenia.

AzureFileShareBackupRequest

Żądanie kopii zapasowej specyficzne dla obciążenia AzureFileShare.

Nazwa	Typ	Opis
objectType	string: AzureFileShareBackupRequest	Ta właściwość będzie używana jako dyskryminator do decydowania o określonych typach w łańcuchu polimorficznym typów.
recoveryPointExpiryTimeInUTC	string	Kopia zapasowa wygaśnie po określonej godzinie (UTC).

AzureWorkloadBackupRequest

Żądanie kopii zapasowej specyficzne dla obciążenia AzureWorkload.

Nazwa	Typ	Opis
backupType	backupType	Typ kopii zapasowej, viz. Pełny, różnicowy, dziennik lub copyOnlyFull
enableCompression	boolean	Wartość logiczna ustawienia kompresji
objectType	string: AzureWorkloadBackupRequest	Ta właściwość będzie używana jako dyskryminator do decydowania o określonych typach w łańcuchu polimorficznym typów.
recoveryPointExpiryTimeInUTC	string	Kopia zapasowa wygaśnie po określonej godzinie (UTC).

BackupRequestResource

Klasa bazowa dla żądania kopii zapasowej. Żądania kopii zapasowych specyficzne dla obciążenia pochodzą z tej klasy.

Nazwa	Typ	Opis
eTag	string	Opcjonalny element ETag.
id	string	Identyfikator zasobu reprezentuje pełną ścieżkę do zasobu.
location	string	Lokalizacja zasobu.
name	string	Nazwa zasobu skojarzona z zasobem.
properties	BackupRequest: AzureFileShareBackupRequest AzureWorkloadBackupRequest IaasVMBackupRequest	Właściwości elementu BackupRequestResource
tags	object	Tagi zasobów.
type	string	Typ zasobu reprezentuje pełną ścieżkę formularza Namespace/ResourceType/ResourceType/...

backupType

Typ kopii zapasowej, viz. Pełny, różnicowy, dziennik lub copyOnlyFull

Nazwa	Typ	Opis
CopyOnlyFull	string
Differential	string
Full	string
Incremental	string
Invalid	string
Log	string
SnapshotCopyOnlyFull	string
SnapshotFull	string

CloudError

Odpowiedź o błędzie z usługi Container Instance.

Nazwa	Typ	Opis
error	CloudErrorBody	Obiekt error.

CloudErrorBody

Odpowiedź o błędzie z usługi Container Instance.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Identyfikator błędu. Kody są niezmienne i mają być używane programowo.
details	CloudErrorBody[]	Lista dodatkowych szczegółów dotyczących błędu.
message	string	Komunikat opisujący błąd, który ma być odpowiedni do wyświetlania w interfejsie użytkownika.
target	string	Element docelowy określonego błędu. Na przykład nazwa właściwości w błędzie.

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

IaasVMBackupRequest

Żądanie kopii zapasowej maszyny wirtualnej IaaS specyficzne dla obciążenia.

Nazwa	Typ	Opis
objectType	string: IaasVMBackupRequest	Ta właściwość będzie używana jako dyskryminator do decydowania o określonych typach w łańcuchu polimorficznym typów.
recoveryPointExpiryTimeInUTC	string	Kopia zapasowa wygaśnie po określonej godzinie (UTC).