File Shares - Restore

Referensi

Service:: Storage Resource Provider

API Version:: 2023-01-01

Memulihkan berbagi file dalam hari retensi yang valid jika penghapusan sementara berbagi diaktifkan

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/fileServices/default/shares/{shareName}/restore?api-version=2023-01-01

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
accountName	path	True	string	Nama akun penyimpanan dalam grup sumber daya yang ditentukan. Nama akun penyimpanan harus sepanjang antara 3 dan 24 karakter dan hanya menggunakan angka dan huruf kecil. Regex pattern: `^[a-z0-9]+$`
resourceGroupName	path	True	string	Nama grup sumber daya dalam langganan pengguna. Nama tidak peka huruf besar/kecil. Regex pattern: `^[-\w\._]+$`
shareName	path	True	string	Nama berbagi file dalam akun penyimpanan yang ditentukan. Panjang nama berbagi file harus antara 3 dan 63 karakter dan menggunakan angka, huruf kecil dan tanda hubung (-) saja. Setiap karakter tanda hubung (-) harus segera didahului dan diikuti dengan huruf atau angka.
subscriptionId	path	True	string	ID langganan target.
api-version	query	True	string	Versi API yang digunakan untuk operasi ini.

Isi Permintaan

Nama	Diperlukan	Jenis	Deskripsi
deletedShareName	True	string	Wajib diisi. Identifikasi nama berbagi yang dihapus yang akan dipulihkan.
deletedShareVersion	True	string	Wajib diisi. Identifikasi versi berbagi yang dihapus yang akan dipulihkan.

Respons

Nama	Jenis	Deskripsi
200 OK		OK -- Berbagi berhasil dipulihkan.
Other Status Codes	CloudError	Respons kesalahan yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

RestoreShares

Sample Request

POST https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/res3376/providers/Microsoft.Storage/storageAccounts/sto328/fileServices/default/shares/share1249/restore?api-version=2023-01-01

{
  "deletedShareName": "share1249",
  "deletedShareVersion": "1234567890"
}


import com.azure.resourcemanager.storage.models.DeletedShare;

/** Samples for FileShares Restore. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/storage/resource-manager/Microsoft.Storage/stable/2023-01-01/examples/FileSharesRestore.json
     */
    /**
     * Sample code: RestoreShares.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void restoreShares(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.storageAccounts().manager().serviceClient().getFileShares().restoreWithResponse("res3376", "sto328",
            "share1249", new DeletedShare().withDeletedShareName("share1249").withDeletedShareVersion("1234567890"),
            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.storage import StorageManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-storage
# USAGE
    python file_shares_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 = StorageManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="{subscription-id}",
    )

    client.file_shares.restore(
        resource_group_name="res3376",
        account_name="sto328",
        share_name="share1249",
        deleted_share={"deletedShareName": "share1249", "deletedShareVersion": "1234567890"},
    )


# x-ms-original-file: specification/storage/resource-manager/Microsoft.Storage/stable/2023-01-01/examples/FileSharesRestore.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 armstorage_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/storage/armstorage"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/0baf811c3c76c87b3c127d098519bd97141222dd/specification/storage/resource-manager/Microsoft.Storage/stable/2023-01-01/examples/FileSharesRestore.json
func ExampleFileSharesClient_Restore() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armstorage.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = clientFactory.NewFileSharesClient().Restore(ctx, "res3376", "sto328", "share1249", armstorage.DeletedShare{
		DeletedShareName:    to.Ptr("share1249"),
		DeletedShareVersion: to.Ptr("1234567890"),
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

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

const { StorageManagementClient } = require("@azure/arm-storage");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Restore a file share within a valid retention days if share soft delete is enabled
 *
 * @summary Restore a file share within a valid retention days if share soft delete is enabled
 * x-ms-original-file: specification/storage/resource-manager/Microsoft.Storage/stable/2023-01-01/examples/FileSharesRestore.json
 */
async function restoreShares() {
  const subscriptionId = process.env["STORAGE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["STORAGE_RESOURCE_GROUP"] || "res3376";
  const accountName = "sto328";
  const shareName = "share1249";
  const deletedShare = {
    deletedShareName: "share1249",
    deletedShareVersion: "1234567890",
  };
  const credential = new DefaultAzureCredential();
  const client = new StorageManagementClient(credential, subscriptionId);
  const result = await client.fileShares.restore(
    resourceGroupName,
    accountName,
    shareName,
    deletedShare
  );
  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

Sample Response

Status code:: 200

Definisi

Nama	Deskripsi
CloudError	Respons kesalahan dari layanan Penyimpanan.
CloudErrorBody	Respons kesalahan dari layanan Penyimpanan.
DeletedShare	Berbagi yang dihapus untuk dipulihkan.

CloudError

Respons kesalahan dari layanan Penyimpanan.

Nama	Jenis	Deskripsi
error	CloudErrorBody	Respons kesalahan dari layanan Penyimpanan.

CloudErrorBody

Respons kesalahan dari layanan Penyimpanan.

Nama	Jenis	Deskripsi
code	string	Pengidentifikasi untuk kesalahan. Kode tidak berubah dan dimaksudkan untuk dikonsumsi secara terprogram.
details	CloudErrorBody[]	Daftar detail tambahan tentang kesalahan tersebut.
message	string	Pesan yang menjelaskan kesalahan, dimaksudkan agar cocok untuk ditampilkan di antarmuka pengguna.
target	string	Target kesalahan tertentu. Misalnya, nama properti dalam kesalahan.

DeletedShare

Berbagi yang dihapus untuk dipulihkan.

Nama	Jenis	Deskripsi
deletedShareName	string	Wajib diisi. Identifikasi nama berbagi yang dihapus yang akan dipulihkan.
deletedShareVersion	string	Wajib diisi. Identifikasi versi berbagi yang dihapus yang akan dipulihkan.

Share via

File Shares - Restore

Parameter URI

Isi Permintaan

Respons

Keamanan

azure_auth

Scopes

Contoh

RestoreShares

Sample Request

Sample Response

Definisi

CloudError

CloudErrorBody

DeletedShare

Sumber Daya Tambahan: