Managed CCF - Backup

Dienst:

Azure confidential ledger

API-Version:

2024-09-19-preview

Führt den Sicherungsvorgang für eine verwaltete CCF-Ressource aus.
Sichert eine verwaltete CCF-Ressource.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConfidentialLedger/managedCCFs/{appName}/backup?api-version=2024-09-19-preview

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
appName	path	True	string pattern: ^[a-zA-Z0-9]	Name des verwalteten CCF
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string minLength: 1	Die ID des Zielabonnements.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
uri	True	string	SAS-URI, der für den Zugriff auf die Sicherungsdateifreigabe verwendet wird.
restoreRegion		string	Die Region, in der die Sicherung der verwalteten CCF-Ressource schließlich wiederhergestellt wird.

Antworten

Name	Typ	Beschreibung
200 OK	ManagedCCFBackupResponse	Die Anforderung war erfolgreich; antwort enthält eine Meldung, die besagt, dass die verwaltete CCF-Ressource erfolgreich gesichert wird.
202 Accepted		Die verwaltete CCF-Ressource wird asynchron gesichert.
Other Status Codes	ErrorResponse	Fehlerantwort, die den Grund für Vorgangsfehler beschreibt.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

ManagedCCFBackup

Beispielanforderung

HTTP

POST https://management.azure.com/subscriptions/0000000-0000-0000-0000-000000000001/resourceGroups/DummyResourceGroupName/providers/Microsoft.ConfidentialLedger/managedCCFs/DummyMccfAppName/backup?api-version=2024-09-19-preview

{
  "restoreRegion": "EastUS",
  "uri": "DummySASUri"
}

Java

import com.azure.resourcemanager.confidentialledger.models.ManagedCcfBackup;

/**
 * Samples for ManagedCcf Backup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/confidentialledger/resource-manager/Microsoft.ConfidentialLedger/preview/2024-09-19-preview/
     * examples/ManagedCCF_Backup.json
     */
    /**
     * Sample code: ManagedCCFBackup.
     * 
     * @param manager Entry point to ConfidentialLedgerManager.
     */
    public static void
        managedCCFBackup(com.azure.resourcemanager.confidentialledger.ConfidentialLedgerManager manager) {
        manager.managedCcfs().backup("DummyResourceGroupName", "DummyMccfAppName",
            new ManagedCcfBackup().withRestoreRegion("EastUS").withUri("DummySASUri"),
            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

Go

package armconfidentialledger_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/confidentialledger/armconfidentialledger"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/40c12a2dd76da721d480d55a44e6ec666045d508/specification/confidentialledger/resource-manager/Microsoft.ConfidentialLedger/preview/2024-09-19-preview/examples/ManagedCCF_Backup.json
func ExampleManagedCCFClient_BeginBackup() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armconfidentialledger.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewManagedCCFClient().BeginBackup(ctx, "DummyResourceGroupName", "DummyMccfAppName", armconfidentialledger.ManagedCCFBackup{
		RestoreRegion: to.Ptr("EastUS"),
		URI:           to.Ptr("DummySASUri"),
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.ManagedCCFBackupResponse = armconfidentialledger.ManagedCCFBackupResponse{
	// 	Message: to.Ptr("Backup Created for ManagedCCF App : DummyMccfAppName."),
	// }
}

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 { ConfidentialLedgerClient } = require("@azure/arm-confidentialledger");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Backs up a Managed CCF Resource.
 *
 * @summary Backs up a Managed CCF Resource.
 * x-ms-original-file: specification/confidentialledger/resource-manager/Microsoft.ConfidentialLedger/preview/2024-09-19-preview/examples/ManagedCCF_Backup.json
 */
async function managedCcfBackup() {
  const subscriptionId =
    process.env["CONFIDENTIALLEDGER_SUBSCRIPTION_ID"] || "0000000-0000-0000-0000-000000000001";
  const resourceGroupName =
    process.env["CONFIDENTIALLEDGER_RESOURCE_GROUP"] || "DummyResourceGroupName";
  const appName = "DummyMccfAppName";
  const managedCCF = {
    restoreRegion: "EastUS",
    uri: "DummySASUri",
  };
  const credential = new DefaultAzureCredential();
  const client = new ConfidentialLedgerClient(credential, subscriptionId);
  const result = await client.managedCCFOperations.beginBackupAndWait(
    resourceGroupName,
    appName,
    managedCCF,
  );
  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

dotnet

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

// Generated from example definition: specification/confidentialledger/resource-manager/Microsoft.ConfidentialLedger/preview/2024-09-19-preview/examples/ManagedCCF_Backup.json
// this example is just showing the usage of "ManagedCCF_Backup" 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 ManagedCcfResource created on azure
// for more information of creating ManagedCcfResource, please refer to the document of ManagedCcfResource
string subscriptionId = "0000000-0000-0000-0000-000000000001";
string resourceGroupName = "DummyResourceGroupName";
string appName = "DummyMccfAppName";
ResourceIdentifier managedCcfResourceId = ManagedCcfResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, appName);
ManagedCcfResource managedCcf = client.GetManagedCcfResource(managedCcfResourceId);

// invoke the operation
ManagedCcfBackupContent content = new ManagedCcfBackupContent(new Uri("DummySASUri"))
{
    RestoreRegion = "EastUS",
};
ArmOperation<ManagedCcfBackupResult> lro = await managedCcf.BackupAsync(WaitUntil.Completed, content);
ManagedCcfBackupResult result = lro.Value;

Console.WriteLine($"Succeeded: {result}");

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

Beispiel für eine Antwort

Statuscode:

200

{
  "message": "Backup Created for ManagedCCF App : DummyMccfAppName."
}

Statuscode:

202

azure-asyncoperation: http://azure.async.operation/status

Definitionen

Name	Beschreibung
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
ManagedCCFBackup	Objekt, das Sicherungseigenschaften einer verwalteten CCF-Ressource darstellt.
ManagedCCFBackupResponse	Objekt, das die Sicherungsantwort einer verwalteten CCF-Ressource darstellt.

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

ManagedCCFBackup

Objekt

Objekt, das Sicherungseigenschaften einer verwalteten CCF-Ressource darstellt.

Name	Typ	Beschreibung
restoreRegion	string	Die Region, in der die Sicherung der verwalteten CCF-Ressource schließlich wiederhergestellt wird.
uri	string	SAS-URI, der für den Zugriff auf die Sicherungsdateifreigabe verwendet wird.

ManagedCCFBackupResponse

Objekt

Objekt, das die Sicherungsantwort einer verwalteten CCF-Ressource darstellt.

Name	Typ	Beschreibung
message	string	Antworttext, der angibt, ob die verwaltete CCF-Ressource gesichert wird.