Storage.FileSharesDelete Method

Definition

Namespace:: Microsoft.Azure.PowerShell.Cmdlets.Storage

Assembly:: Az.Storage.private.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Deletes specified share under its account.

public System.Threading.Tasks.Task FileSharesDelete(string subscriptionId, string resourceGroupName, string accountName, string shareName, string xMSSnapshot, string Include, Func<System.Net.Http.HttpResponseMessage,System.Threading.Tasks.Task> onOk, Func<System.Net.Http.HttpResponseMessage,System.Threading.Tasks.Task> onNoContent, Func<System.Net.Http.HttpResponseMessage,System.Threading.Tasks.Task<Microsoft.Azure.PowerShell.Cmdlets.Storage.Models.ICloudError>,System.Threading.Tasks.Task> onDefault, Microsoft.Azure.PowerShell.Cmdlets.Storage.Runtime.IEventListener eventListener, Microsoft.Azure.PowerShell.Cmdlets.Storage.Runtime.ISendAsync sender);

member this.FileSharesDelete : string * string * string * string * string * string * Func<System.Net.Http.HttpResponseMessage, System.Threading.Tasks.Task> * Func<System.Net.Http.HttpResponseMessage, System.Threading.Tasks.Task> * Func<System.Net.Http.HttpResponseMessage, System.Threading.Tasks.Task<Microsoft.Azure.PowerShell.Cmdlets.Storage.Models.ICloudError>, System.Threading.Tasks.Task> * Microsoft.Azure.PowerShell.Cmdlets.Storage.Runtime.IEventListener * Microsoft.Azure.PowerShell.Cmdlets.Storage.Runtime.ISendAsync -> System.Threading.Tasks.Task

Public Function FileSharesDelete (subscriptionId As String, resourceGroupName As String, accountName As String, shareName As String, xMSSnapshot As String, Include As String, onOk As Func(Of HttpResponseMessage, Task), onNoContent As Func(Of HttpResponseMessage, Task), onDefault As Func(Of HttpResponseMessage, Task(Of ICloudError), Task), eventListener As IEventListener, sender As ISendAsync) As Task

Parameters

subscriptionId: String

The ID of the target subscription. The value must be an UUID.

resourceGroupName: String

The name of the resource group. 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.