Ledger - Restore

Service:: Azure confidential ledger

API Version:: 2024-09-19-preview

Performs the restore operation to spin up a newly restored Confidential Ledger Resource.
Restores a Confidential Ledger Resource.

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

URI Parameters

Name	In	Required	Type	Description
ledgerName	path	True	string pattern: ^[^-0-9][A-Za-z0-9-]{1,33}[A-Za-z0-9]$	Name of the Confidential Ledger
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string minLength: 1	The ID of the target subscription.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Request Body

Name	Required	Type	Description
fileShareName	True	string	Fileshare where the ledger backup is stored.
restoreRegion	True	string	The region the ledger is being restored to.
uri	True	string	SAS URI used to access the backup fileshare.

Responses

Name	Type	Description
200 OK	ConfidentialLedgerRestoreResponse	The request was successful; response contains a message stating the Confidential Ledger Resource is successfully being restored.
202 Accepted		The Confidential Ledger Resource will be restored asynchronously. Check the provisioningState field to monitor the progress of your operation.
Other Status Codes	ErrorResponse	Error response describing the reason for operation failure.

Security

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	impersonate your user account

Examples

ConfidentialLedgerRestore

Sample request

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

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


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

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

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_restore.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_restore(
        resource_group_name="DummyResourceGroupName",
        ledger_name="DummyLedgerName",
        confidential_ledger={"fileShareName": "DummyFileShareName", "restoreRegion": "EastUS", "uri": "DummySASUri"},
    ).result()
    print(response)


# x-ms-original-file: specification/confidentialledger/resource-manager/Microsoft.ConfidentialLedger/preview/2024-09-19-preview/examples/ConfidentialLedger_Restore.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 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_Restore.json
func ExampleLedgerClient_BeginRestore() {
	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().BeginRestore(ctx, "DummyResourceGroupName", "DummyLedgerName", armconfidentialledger.Restore{
		FileShareName: to.Ptr("DummyFileShareName"),
		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.RestoreResponse = armconfidentialledger.RestoreResponse{
	// 	Message: to.Ptr("Restore 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

const { ConfidentialLedgerClient } = require("@azure/arm-confidentialledger");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Restores a Confidential Ledger Resource.
 *
 * @summary Restores a Confidential Ledger Resource.
 * x-ms-original-file: specification/confidentialledger/resource-manager/Microsoft.ConfidentialLedger/preview/2024-09-19-preview/examples/ConfidentialLedger_Restore.json
 */
async function confidentialLedgerRestore() {
  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 = {
    fileShareName: "DummyFileShareName",
    restoreRegion: "EastUS",
    uri: "DummySASUri",
  };
  const credential = new DefaultAzureCredential();
  const client = new ConfidentialLedgerClient(credential, subscriptionId);
  const result = await client.ledger.beginRestoreAndWait(
    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

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_Restore.json
// this example is just showing the usage of "Ledger_Restore" 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
ConfidentialLedgerRestoreContent content = new ConfidentialLedgerRestoreContent("DummyFileShareName", "EastUS", new Uri("DummySASUri"));
ArmOperation<ConfidentialLedgerRestoreResult> lro = await confidentialLedger.RestoreAsync(WaitUntil.Completed, content);
ConfidentialLedgerRestoreResult 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

Sample response

Status code:: 200

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

Status code:: 202

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

Definitions

Name	Description
ConfidentialLedgerRestore	Object representing Restore properties of a Confidential Ledger Resource.
ConfidentialLedgerRestoreResponse	Object representing the restore response of a Confidential Ledger Resource.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response

ConfidentialLedgerRestore

Object

Object representing Restore properties of a Confidential Ledger Resource.

Name	Type	Description
fileShareName	string	Fileshare where the ledger backup is stored.
restoreRegion	string	The region the ledger is being restored to.
uri	string	SAS URI used to access the backup fileshare.

ConfidentialLedgerRestoreResponse

Object

Object representing the restore response of a Confidential Ledger Resource.

Name	Type	Description
message	string	Response body stating if the ledger is being restored.

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.