File Shares - Delete

Service:

Storage Resource Provider

API Version:

2023-01-01

Löscht die angegebene Freigabe unter ihrem Konto.

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

With optional parameters:

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
accountName	path	True	string	Der Name des Speicherkontos innerhalb der angegebenen Ressourcengruppe. Speicherkontonamen müssen zwischen 3 und 24 Zeichen lang sein und dürfen nur Zahlen und Kleinbuchstaben enthalten. Regex pattern: ^[a-z0-9]+$
resourceGroupName	path	True	string	Der Name der Ressourcengruppe im Abonnement des Benutzers. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet. Regex pattern: ^[-\w\._\(\)]+$
shareName	path	True	string	Der Name der Dateifreigabe innerhalb des angegebenen Speicherkontos. Dateinamen müssen zwischen 3 und 63 Zeichen lang sein und nur Zahlen, Kleinbuchstaben und Bindestriche (-) verwenden. Direkt vor und nach jedem Bindestrich (-) muss ein Buchstabe oder eine Ziffer stehen.
subscriptionId	path	True	string	Hierbei handelt es sich um die ID des Zielabonnements.
api-version	query	True	string	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.
$include	query		string	Optional. Gültige Werte sind: Momentaufnahmen, leased-snapshots, keine. Der Standardwert ist Momentaufnahmen. Bei "Momentaufnahmen" wird die Dateifreigabe einschließlich aller Dateifreigabemomentaufnahmen gelöscht. Wenn die Dateifreigabe leased-snapshots enthält, schlägt der Löschvorgang fehl. Bei "leased-snapshots" wird die Dateifreigabe gelöscht, einschließlich aller Dateifreigabemomentaufnahmen (leased/unleased). Bei "none" wird die Dateifreigabe gelöscht, wenn sie keine Freigabemomentaufnahmen enthält. Wenn die Dateifreigabe Momentaufnahmen (geleast oder unverleased) enthält, schlägt der Löschvorgang fehl.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
x-ms-snapshot		string	Optional, wird zum Löschen einer Momentaufnahme verwendet.

Antworten

Name	Typ	Beschreibung
200 OK		OK : Der Löschvorgang zum Freigeben wurde erfolgreich abgeschlossen.
204 No Content		Kein Inhalt: Die Freigabe ist nicht vorhanden.
Other Status Codes	CloudError	Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

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

Scopes

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

DeleteShares

Sample Request

HTTP

DELETE https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/res4079/providers/Microsoft.Storage/storageAccounts/sto4506/fileServices/default/shares/share9689?api-version=2023-01-01

Java

/** Samples for FileShares Delete. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/storage/resource-manager/Microsoft.Storage/stable/2023-01-01/examples/FileSharesDelete.json
     */
    /**
     * Sample code: DeleteShares.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void deleteShares(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.storageAccounts().manager().serviceClient().getFileShares().deleteWithResponse("res4079", "sto4506",
            "share9689", null, null, 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_delete.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.delete(
        resource_group_name="res4079",
        account_name="sto4506",
        share_name="share9689",
    )


# x-ms-original-file: specification/storage/resource-manager/Microsoft.Storage/stable/2023-01-01/examples/FileSharesDelete.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/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/FileSharesDelete.json
func ExampleFileSharesClient_Delete() {
	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().Delete(ctx, "res4079", "sto4506", "share9689", &armstorage.FileSharesClientDeleteOptions{XMSSnapshot: nil,
		Include: 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");

/**
 * This sample demonstrates how to Deletes specified share under its account.
 *
 * @summary Deletes specified share under its account.
 * x-ms-original-file: specification/storage/resource-manager/Microsoft.Storage/stable/2023-01-01/examples/FileSharesDelete.json
 */
async function deleteShares() {
  const subscriptionId = process.env["STORAGE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["STORAGE_RESOURCE_GROUP"] || "res4079";
  const accountName = "sto4506";
  const shareName = "share9689";
  const credential = new DefaultAzureCredential();
  const client = new StorageManagementClient(credential, subscriptionId);
  const result = await client.fileShares.delete(resourceGroupName, accountName, shareName);
  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

Status code:

204

Definitionen

Name	Beschreibung
CloudError	Eine Fehlerantwort des Speicherdiensts.
CloudErrorBody	Eine Fehlerantwort des Speicherdiensts.

CloudError

Eine Fehlerantwort des Speicherdiensts.

Name	Typ	Beschreibung
error	CloudErrorBody	Eine Fehlerantwort des Speicherdiensts.

CloudErrorBody

Eine Fehlerantwort des Speicherdiensts.

Name	Typ	Beschreibung
code	string	Ein Bezeichner für den Fehler. Codes sind unveränderlich und sollten programmgesteuert verwendet 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 sein soll.
target	string	Das Ziel des jeweiligen Fehlers. Beispiel: Der Name der -Eigenschaft im Fehler.