File Shares - Delete

Service:

Storage Resource Provider

API Version:

2023-01-01

Odstraní zadanou sdílenou složku pod svým účtem.

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}

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
accountName	path	True	string	Název účtu úložiště v zadané skupině prostředků. Názvy účtů úložiště musí mít délku 3 až 24 znaků a musí obsahovat jenom číslice a malá písmena. Regex pattern: ^[a-z0-9]+$
resourceGroupName	path	True	string	Název skupiny prostředků v rámci předplatného uživatele. V názvu se rozlišují malá a velká písmena. Regex pattern: ^[-\w\._\(\)]+$
shareName	path	True	string	Název sdílené složky v zadaném účtu úložiště. Názvy sdílených složek musí mít délku 3 až 63 znaků a musí obsahovat pouze číslice, malá písmena a pomlčku (-). Každému znaku pomlčky (-) musí bezprostředně předcházet písmeno nebo číslo.
subscriptionId	path	True	string	ID cílového předplatného.
api-version	query	True	string	Verze rozhraní API, která se má použít pro tuto operaci.
$include	query		string	Nepovinný parametr. Platné hodnoty jsou: snímky, zapůjčené snímky, žádné. Výchozí hodnota jsou snímky. U snímků se odstraní sdílená složka včetně všech snímků sdílené složky. Pokud sdílená složka obsahuje zapůjčené snímky, odstranění se nezdaří. V případě zapůjčených snímků se sdílená složka odstraní včetně všech snímků sdílených složek (zapůjčených nebo neolovněných). U položky none se sdílená složka odstraní, pokud nemá žádné snímky sdílené složky. Pokud sdílená složka obsahuje nějaké snímky (zapůjčené nebo neolovněné), odstranění se nezdaří.

Hlavička požadavku

Name	Vyžadováno	Typ	Description
x-ms-snapshot		string	Volitelné– slouží k odstranění snímku.

Odpovědi

Name	Typ	Description
200 OK		OK – Operace odstranění sdílené složky se úspěšně dokončila.
204 No Content		Žádný obsah – Sdílená složka neexistuje.
Other Status Codes	CloudError	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

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

Scopes

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

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

Definice

Name	Description
CloudError	Chybová odpověď ze služby Storage.
CloudErrorBody	Chybová odpověď ze služby Storage.

CloudError

Chybová odpověď ze služby Storage.

Name	Typ	Description
error	CloudErrorBody	Chybová odpověď ze služby Storage.

CloudErrorBody

Chybová odpověď ze služby Storage.

Name	Typ	Description
code	string	Identifikátor chyby. Kódy jsou invariantní a mají být využívány programově.
details	CloudErrorBody[]	Seznam dalších podrobností o chybě
message	string	Zpráva popisující chybu, která má být vhodná pro zobrazení v uživatelském rozhraní.
target	string	Cíl konkrétní chyby. Například název vlastnosti v chybě.