Managed CCF - Restore

Hizmet:

Azure confidential ledger

API Sürümü:

2024-09-19-preview

Yeni geri yüklenen Yönetilen CCF Kaynağını çalıştırmak için geri yükleme işlemini gerçekleştirir.
Yönetilen CCF Kaynağını geri yükler.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
appName	path	True	string pattern: ^[a-zA-Z0-9]	Yönetilen CCF'nin adı
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Kaynak grubunun adı. Ad büyük/küçük harfe duyarsız.
subscriptionId	path	True	string minLength: 1	Hedef aboneliğin kimliği.
api-version	query	True	string minLength: 1	Bu işlem için kullanılacak API sürümü.

İstek Gövdesi

Name	Gerekli	Tür	Description
fileShareName	True	string	Yönetilen CCF kaynak yedeklemesinin depolandığı dosya paylaşımı.
restoreRegion	True	string	Yönetilen CCF kaynağının geri yüklendiği bölge.
uri	True	string	Yedekleme Dosya paylaşımına erişmek için kullanılan SAS URI'si.

Yanıtlar

Name	Tür	Description
200 OK	ManagedCCFRestoreResponse	İstek başarılı oldu; yanıt, Yönetilen CCF Kaynağının başarıyla geri yüklendiğini belirten bir ileti içerir.
202 Accepted		Yönetilen CCF Kaynağı zaman uyumsuz olarak geri yüklenir. İşleminizin ilerleme durumunu izlemek için provisioningState alanını denetleyin.
Other Status Codes	ErrorResponse	İşlem hatasının nedenini açıklayan hata yanıtı.

Güvenlik

azure_auth

Azure Active Directory OAuth2 Akışı

Tür: oauth2
Akış: implicit
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/authorize

Kapsamlar

Name	Description
user_impersonation	kullanıcı hesabınızın kimliğine bürünme

Örnekler

ManagedCCFRestore

Örnek isteği

HTTP

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

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

Java

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

/**
 * Samples for ManagedCcf Restore.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/confidentialledger/resource-manager/Microsoft.ConfidentialLedger/preview/2024-09-19-preview/
     * examples/ManagedCCF_Restore.json
     */
    /**
     * Sample code: ManagedCCFRestore.
     * 
     * @param manager Entry point to ConfidentialLedgerManager.
     */
    public static void
        managedCCFRestore(com.azure.resourcemanager.confidentialledger.ConfidentialLedgerManager manager) {
        manager.managedCcfs().restore(
            "DummyResourceGroupName", "DummyMccfAppName", new ManagedCcfRestore()
                .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

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_Restore.json
func ExampleManagedCCFClient_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.NewManagedCCFClient().BeginRestore(ctx, "DummyResourceGroupName", "DummyMccfAppName", armconfidentialledger.ManagedCCFRestore{
		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.ManagedCCFRestoreResponse = armconfidentialledger.ManagedCCFRestoreResponse{
	// 	Message: to.Ptr("Restore 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 Restores a Managed CCF Resource.
 *
 * @summary Restores a Managed CCF Resource.
 * x-ms-original-file: specification/confidentialledger/resource-manager/Microsoft.ConfidentialLedger/preview/2024-09-19-preview/examples/ManagedCCF_Restore.json
 */
async function managedCcfRestore() {
  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 = {
    fileShareName: "DummyFileShareName",
    restoreRegion: "EastUS",
    uri: "DummySASUri",
  };
  const credential = new DefaultAzureCredential();
  const client = new ConfidentialLedgerClient(credential, subscriptionId);
  const result = await client.managedCCFOperations.beginRestoreAndWait(
    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_Restore.json
// this example is just showing the usage of "ManagedCCF_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 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
ManagedCcfRestoreContent content = new ManagedCcfRestoreContent("DummyFileShareName", "EastUS", new Uri("DummySASUri"));
ArmOperation<ManagedCcfRestoreResult> lro = await managedCcf.RestoreAsync(WaitUntil.Completed, content);
ManagedCcfRestoreResult 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

Örnek yanıt

Durum kodu:

200

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

Durum kodu:

202

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

Tanımlar

Name	Description
ErrorAdditionalInfo	Kaynak yönetimi hatası ek bilgileri.
ErrorDetail	Hata ayrıntısı.
ErrorResponse	Hata yanıtı
ManagedCCFRestore	Yönetilen CCF Kaynağının Geri Yükleme özelliklerini temsil eden nesne.
ManagedCCFRestoreResponse	Yönetilen CCF Kaynağının geri yükleme yanıtını temsil eden nesne.

ErrorAdditionalInfo

Object

Kaynak yönetimi hatası ek bilgileri.

Name	Tür	Description
info	object	Ek bilgiler.
type	string	Ek bilgi türü.

ErrorDetail

Object

Hata ayrıntısı.

Name	Tür	Description
additionalInfo	ErrorAdditionalInfo[]	Hata ek bilgileri.
code	string	Hata kodu.
details	ErrorDetail[]	Hata ayrıntıları.
message	string	Hata iletisi.
target	string	Hata hedefi.

ErrorResponse

Object

Hata yanıtı

Name	Tür	Description
error	ErrorDetail	Hata nesnesi.

ManagedCCFRestore

Object

Yönetilen CCF Kaynağının Geri Yükleme özelliklerini temsil eden nesne.

Name	Tür	Description
fileShareName	string	Yönetilen CCF kaynak yedeklemesinin depolandığı dosya paylaşımı.
restoreRegion	string	Yönetilen CCF kaynağının geri yüklendiği bölge.
uri	string	Yedekleme Dosya paylaşımına erişmek için kullanılan SAS URI'si.

ManagedCCFRestoreResponse

Object

Yönetilen CCF Kaynağının geri yükleme yanıtını temsil eden nesne.

Name	Tür	Description
message	string	Yönetilen CCF kaynağının geri yüklenip yüklenmediğini belirten yanıt gövdesi.