File Shares - Restore

Dienst:

Storage Resource Provider

API-Version:

2024-01-01

Wiederherstellen einer Dateifreigabe innerhalb einer gültigen Aufbewahrungszeit, wenn "Vorläufiges Löschen freigeben" aktiviert ist

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
accountName	path	True	string minLength: 3 maxLength: 24 pattern: ^[a-z0-9]+$	Der Name des Speicherkontos innerhalb der angegebenen Ressourcengruppe. Die Namen von Speicherkonten müssen zwischen 3 und 24 Zeichen lang sein und nur Zahlen und Kleinbuchstaben verwenden.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+$	Der Name der Ressourcengruppe innerhalb des Abonnements des Benutzers. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
shareName	path	True	string minLength: 3 maxLength: 63	Der Name der Dateifreigabe innerhalb des angegebenen Speicherkontos. Dateinamen müssen zwischen 3 und 63 Zeichen lang sein und Zahlen verwenden, nur Kleinbuchstaben und Gedankenstriche (-). Jedem Gedankenstrich (-) Zeichen muss unmittelbar ein Buchstabe oder eine Zahl vorangestellt und gefolgt werden.
subscriptionId	path	True	string minLength: 1	Die ID des Zielabonnements.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
deletedShareName	True	string	Erforderlich. Identifizieren Sie den Namen der gelöschten Freigabe, die wiederhergestellt wird.
deletedShareVersion	True	string	Erforderlich. Identifizieren Sie die Version der gelöschten Freigabe, die wiederhergestellt wird.

Antworten

Name	Typ	Beschreibung
200 OK		OK - Die Freigabe wurde erfolgreich wiederhergestellt.
Other Status Codes	CloudError	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

RestoreShares

Beispielanforderung

HTTP

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

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

Java

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/2024-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

Python

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/2024-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

Go

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/97ee23a6db6078abcbec7b75bf9af8c503e9bb8b/specification/storage/resource-manager/Microsoft.Storage/stable/2024-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

JavaScript

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

/**
 * 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/2024-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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Storage.Models;
using Azure.ResourceManager.Storage;

// Generated from example definition: specification/storage/resource-manager/Microsoft.Storage/stable/2024-01-01/examples/FileSharesRestore.json
// this example is just showing the usage of "FileShares_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 FileShareResource created on azure
// for more information of creating FileShareResource, please refer to the document of FileShareResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "res3376";
string accountName = "sto328";
string shareName = "share1249";
ResourceIdentifier fileShareResourceId = FileShareResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName, shareName);
FileShareResource fileShare = client.GetFileShareResource(fileShareResourceId);

// invoke the operation
DeletedShare deletedShare = new DeletedShare("share1249", "1234567890");
await fileShare.RestoreAsync(deletedShare);

Console.WriteLine("Succeeded");

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

Beispiel für eine Antwort

Statuscode:

200

Definitionen

Name	Beschreibung
CloudError	Eine Fehlerantwort des Speicherdiensts.
CloudErrorBody	Eine Fehlerantwort des Speicherdiensts.
DeletedShare	Die gelöschte Freigabe, die wiederhergestellt werden soll.

CloudError

Objekt

Eine Fehlerantwort des Speicherdiensts.

Name	Typ	Beschreibung
error	CloudErrorBody	Eine Fehlerantwort des Speicherdiensts.

CloudErrorBody

Objekt

Eine Fehlerantwort des Speicherdiensts.

Name	Typ	Beschreibung
code	string	Ein Bezeichner für den Fehler. Codes sind unveränderlich und sollen programmgesteuert genutzt werden.
details	CloudErrorBody[]	Eine Liste mit zusätzlichen Details zum Fehler.
message	string	Eine Meldung, die den Fehler beschreibt, der für die Anzeige in einer Benutzeroberfläche geeignet ist.
target	string	Das Ziel des bestimmten Fehlers. Beispielsweise der Name der Eigenschaft im Fehler.

DeletedShare

Objekt

Die gelöschte Freigabe, die wiederhergestellt werden soll.

Name	Typ	Beschreibung
deletedShareName	string	Erforderlich. Identifizieren Sie den Namen der gelöschten Freigabe, die wiederhergestellt wird.
deletedShareVersion	string	Erforderlich. Identifizieren Sie die Version der gelöschten Freigabe, die wiederhergestellt wird.