Ledger - Backup

Service:

Azure confidential ledger

API-versie:

2024-09-19-preview

Voert de back-upbewerking uit op een vertrouwelijke grootboekresource.
Maakt een back-up van een vertrouwelijke grootboekresource.

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

URI-parameters

Name	In	Vereist	Type	Description
ledgerName	path	True	string pattern: ^[^-0-9][A-Za-z0-9-]{1,33}[A-Za-z0-9]$	Naam van het vertrouwelijke grootboek
resourceGroupName	path	True	string minLength: 1 maxLength: 90	De naam van de resourcegroep. De naam is hoofdletterongevoelig.
subscriptionId	path	True	string minLength: 1	De id van het doelabonnement.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagbody

Name	Vereist	Type	Description
uri	True	string	SAS-URI die wordt gebruikt voor toegang tot de back-upbestandsshare.
restoreRegion		string	De regio waarin de back-up van het grootboek uiteindelijk wordt hersteld.

Antwoorden

Name	Type	Description
200 OK	ConfidentialLedgerBackupResponse	De aanvraag is geslaagd; antwoord bevat een bericht waarin wordt aangegeven dat er een back-up van de vertrouwelijke grootboekresource wordt gemaakt.
202 Accepted		Er wordt asynchroon een back-up gemaakt van de vertrouwelijke grootboekresource.
Other Status Codes	ErrorResponse	Foutreactie waarin de reden voor de bewerkingsfout wordt beschreven. 404 - NotFound (Vertrouwelijk grootboek bestaat niet.)

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

ConfidentialLedgerBackup

Voorbeeldaanvraag

HTTP

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

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

Java

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

/**
 * Samples for Ledger Backup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/confidentialledger/resource-manager/Microsoft.ConfidentialLedger/preview/2024-09-19-preview/
     * examples/ConfidentialLedger_Backup.json
     */
    /**
     * Sample code: ConfidentialLedgerBackup.
     * 
     * @param manager Entry point to ConfidentialLedgerManager.
     */
    public static void
        confidentialLedgerBackup(com.azure.resourcemanager.confidentialledger.ConfidentialLedgerManager manager) {
        manager.ledgers().backup("DummyResourceGroupName", "DummyLedgerName",
            new ConfidentialLedgerBackup().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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.confidentialledger import ConfidentialLedger

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-confidentialledger
# USAGE
    python confidential_ledger_backup.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 = ConfidentialLedger(
        credential=DefaultAzureCredential(),
        subscription_id="0000000-0000-0000-0000-000000000001",
    )

    response = client.ledger.begin_backup(
        resource_group_name="DummyResourceGroupName",
        ledger_name="DummyLedgerName",
        confidential_ledger={"restoreRegion": "EastUS", "uri": "DummySASUri"},
    ).result()
    print(response)


# x-ms-original-file: specification/confidentialledger/resource-manager/Microsoft.ConfidentialLedger/preview/2024-09-19-preview/examples/ConfidentialLedger_Backup.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 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/ConfidentialLedger_Backup.json
func ExampleLedgerClient_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.NewLedgerClient().BeginBackup(ctx, "DummyResourceGroupName", "DummyLedgerName", armconfidentialledger.Backup{
		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.BackupResponse = armconfidentialledger.BackupResponse{
	// 	Message: to.Ptr("Backup Created for Ledger: DummyLedgerName."),
	// }
}

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 Confidential Ledger Resource.
 *
 * @summary Backs up a Confidential Ledger Resource.
 * x-ms-original-file: specification/confidentialledger/resource-manager/Microsoft.ConfidentialLedger/preview/2024-09-19-preview/examples/ConfidentialLedger_Backup.json
 */
async function confidentialLedgerBackup() {
  const subscriptionId =
    process.env["CONFIDENTIALLEDGER_SUBSCRIPTION_ID"] || "0000000-0000-0000-0000-000000000001";
  const resourceGroupName =
    process.env["CONFIDENTIALLEDGER_RESOURCE_GROUP"] || "DummyResourceGroupName";
  const ledgerName = "DummyLedgerName";
  const confidentialLedger = {
    restoreRegion: "EastUS",
    uri: "DummySASUri",
  };
  const credential = new DefaultAzureCredential();
  const client = new ConfidentialLedgerClient(credential, subscriptionId);
  const result = await client.ledger.beginBackupAndWait(
    resourceGroupName,
    ledgerName,
    confidentialLedger,
  );
  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/ConfidentialLedger_Backup.json
// this example is just showing the usage of "Ledger_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 ConfidentialLedgerResource created on azure
// for more information of creating ConfidentialLedgerResource, please refer to the document of ConfidentialLedgerResource
string subscriptionId = "0000000-0000-0000-0000-000000000001";
string resourceGroupName = "DummyResourceGroupName";
string ledgerName = "DummyLedgerName";
ResourceIdentifier confidentialLedgerResourceId = ConfidentialLedgerResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, ledgerName);
ConfidentialLedgerResource confidentialLedger = client.GetConfidentialLedgerResource(confidentialLedgerResourceId);

// invoke the operation
ConfidentialLedgerBackupContent content = new ConfidentialLedgerBackupContent(new Uri("DummySASUri"))
{
    RestoreRegion = "EastUS",
};
ArmOperation<ConfidentialLedgerBackupResult> lro = await confidentialLedger.BackupAsync(WaitUntil.Completed, content);
ConfidentialLedgerBackupResult 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

Voorbeeldrespons

Statuscode:

200

{
  "message": "Backup Created for Ledger: DummyLedgerName."
}

Statuscode:

202

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

Definities

Name	Description
ConfidentialLedgerBackup	Object dat back-upeigenschappen van een vertrouwelijke grootboekresource vertegenwoordigt.
ConfidentialLedgerBackupResponse	Object dat het back-upantwoord van een vertrouwelijke grootboekresource vertegenwoordigt.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie

ConfidentialLedgerBackup

Object

Object dat back-upeigenschappen van een vertrouwelijke grootboekresource vertegenwoordigt.

Name	Type	Description
restoreRegion	string	De regio waarin de back-up van het grootboek uiteindelijk wordt hersteld.
uri	string	SAS-URI die wordt gebruikt voor toegang tot de back-upbestandsshare.

ConfidentialLedgerBackupResponse

Object

Object dat het back-upantwoord van een vertrouwelijke grootboekresource vertegenwoordigt.

Name	Type	Description
message	string	Antwoordtekst die aangeeft of er een back-up van het grootboek wordt gemaakt.

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het extra informatietype.

ErrorDetail

Object

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Object

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.