Managed CCF - Backup

Usługa:

Azure confidential ledger

Wersja interfejsu API:

2024-09-19-preview

Wykonuje operację tworzenia kopii zapasowej na zarządzanym zasobie CCF.
Wykonuje kopię zapasową zarządzanego zasobu CCF.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
appName	path	True	string pattern: ^[a-zA-Z0-9]	Nazwa zarządzanego programu CCF
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
subscriptionId	path	True	string minLength: 1	Identyfikator subskrypcji docelowej.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.

Treść żądania

Nazwa	Wymagane	Typ	Opis
uri	True	string	Identyfikator URI sygnatury dostępu współdzielonego używany do uzyskiwania dostępu do udziału plików kopii zapasowej.
restoreRegion		string	Region, w którym zostanie przywrócona kopia zapasowa zarządzanego zasobu CCF.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	ManagedCCFBackupResponse	Żądanie zakończyło się pomyślnie; odpowiedź zawiera komunikat informujący o pomyślnym utworzeniu kopii zapasowej zarządzanego zasobu CCF.
202 Accepted		Zarządzany zasób CCF będzie kopii zapasowej asynchronicznie.
Other Status Codes	ErrorResponse	Odpowiedź na błąd opisująca przyczynę niepowodzenia operacji.

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

ManagedCCFBackup

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:

200

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

Kod stanu:

202

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

Definicje

Nazwa	Opis
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
ManagedCCFBackup	Obiekt reprezentujący właściwości kopii zapasowej zarządzanego zasobu CCF.
ManagedCCFBackupResponse	Obiekt reprezentujący odpowiedź kopii zapasowej zarządzanego zasobu CCF.

ErrorAdditionalInfo

Objekt

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

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

ErrorDetail

Objekt

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponse

Objekt

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

ManagedCCFBackup

Objekt

Obiekt reprezentujący właściwości kopii zapasowej zarządzanego zasobu CCF.

Nazwa	Typ	Opis
restoreRegion	string	Region, w którym zostanie przywrócona kopia zapasowa zarządzanego zasobu CCF.
uri	string	Identyfikator URI sygnatury dostępu współdzielonego używany do uzyskiwania dostępu do udziału plików kopii zapasowej.

ManagedCCFBackupResponse

Objekt

Obiekt reprezentujący odpowiedź kopii zapasowej zarządzanego zasobu CCF.

Nazwa	Typ	Opis
message	string	Treść odpowiedzi z informacją, czy zarządzany zasób CCF jest kopią zapasową.