FileShareResource.DeleteAsync Method
Definition
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.
- Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/fileServices/default/shares/{shareName}
- Operation Id: FileShares_Delete
- Default Api Version: 2023-05-01
- Resource: FileShareResource
public virtual System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation> DeleteAsync (Azure.WaitUntil waitUntil, string xMsSnapshot = default, string include = default, System.Threading.CancellationToken cancellationToken = default);abstract member DeleteAsync : Azure.WaitUntil * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation>
override this.DeleteAsync : Azure.WaitUntil * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation>Public Overridable Function DeleteAsync (waitUntil As WaitUntil, Optional xMsSnapshot As String = Nothing, Optional include As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ArmOperation)Parameters
- waitUntil
- WaitUntil
Completed if the method should wait to return until the long-running operation has completed on the service; Started if it should return after starting the operation. For more information on long-running operations, please see Azure.Core Long-Running Operation samples.
- 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.
- cancellationToken
- CancellationToken
The cancellation token to use.
