IFileSharesOperations.DeleteWithHttpMessagesAsync Method

Definition

Namespace:

Microsoft.Azure.Management.Storage

Assembly:

Microsoft.Azure.Management.Storage.dll

Package:

Microsoft.Azure.Management.Storage v25.0.0

Deletes specified share under its account.

public System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse> DeleteWithHttpMessagesAsync (string resourceGroupName, string accountName, string shareName, string xMsSnapshot = default, string include = default, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);

abstract member DeleteWithHttpMessagesAsync : string * string * string * string * string * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse>

Public Function DeleteWithHttpMessagesAsync (resourceGroupName As String, accountName As String, shareName As String, Optional xMsSnapshot As String = Nothing, Optional include As String = Nothing, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AzureOperationResponse)

Parameters

resourceGroupName

String

The name of the resource group within the user's subscription. The name is case insensitive.

accountName

String

The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.

shareName

String

The name of the file share within the specified storage account. File share names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number.

xMsSnapshot

String

Optional, used to delete a snapshot.

include

String

Optional. Valid values are: snapshots, leased-snapshots, none. The default value is snapshots. For 'snapshots', the file share is deleted including all of its file share snapshots. If the file share contains leased-snapshots, the deletion fails. For 'leased-snapshots', the file share is deleted included all of its file share snapshots (leased/unleased). For 'none', the file share is deleted if it has no share snapshots. If the file share contains any snapshots (leased or unleased), the deletion fails.

customHeaders

Dictionary<String,List<String>>

The headers that will be added to request.

cancellationToken

CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse>

Exceptions

CloudException

Thrown when the operation returned an invalid status code

ValidationException

Thrown when a required parameter is null