Share via


ElasticSanVolumeResource.DeleteAsync Method

Definition

Overloads

DeleteAsync(WaitUntil, Nullable<XmsDeleteSnapshot>, Nullable<XmsForceDelete>, CancellationToken)

Delete an Volume.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/volumes/{volumeName}
  • Operation Id: Volumes_Delete
  • Default Api Version: 2023-01-01
  • Resource: ElasticSanVolumeResource
DeleteAsync(WaitUntil, Nullable<XMsDeleteSnapshot>, Nullable<XMsForceDelete>, CancellationToken)

Delete an Volume.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/volumes/{volumeName}
  • Operation Id: Volumes_Delete

DeleteAsync(WaitUntil, Nullable<XmsDeleteSnapshot>, Nullable<XmsForceDelete>, CancellationToken)

Source:
ElasticSanVolumeResource.cs

Delete an Volume.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/volumes/{volumeName}
  • Operation Id: Volumes_Delete
  • Default Api Version: 2023-01-01
  • Resource: ElasticSanVolumeResource
public virtual System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation> DeleteAsync (Azure.WaitUntil waitUntil, Azure.ResourceManager.ElasticSan.Models.XmsDeleteSnapshot? xmsDeleteSnapshots = default, Azure.ResourceManager.ElasticSan.Models.XmsForceDelete? xmsForceDelete = default, System.Threading.CancellationToken cancellationToken = default);
abstract member DeleteAsync : Azure.WaitUntil * Nullable<Azure.ResourceManager.ElasticSan.Models.XmsDeleteSnapshot> * Nullable<Azure.ResourceManager.ElasticSan.Models.XmsForceDelete> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation>
override this.DeleteAsync : Azure.WaitUntil * Nullable<Azure.ResourceManager.ElasticSan.Models.XmsDeleteSnapshot> * Nullable<Azure.ResourceManager.ElasticSan.Models.XmsForceDelete> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation>
Public Overridable Function DeleteAsync (waitUntil As WaitUntil, Optional xmsDeleteSnapshots As Nullable(Of XmsDeleteSnapshot) = Nothing, Optional xmsForceDelete As Nullable(Of XmsForceDelete) = 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.

xmsDeleteSnapshots
Nullable<Azure.ResourceManager.ElasticSan.Models.XmsDeleteSnapshot>

Optional, used to delete snapshots under volume. Allowed value are only true or false. Default value is false.

xmsForceDelete
Nullable<Azure.ResourceManager.ElasticSan.Models.XmsForceDelete>

Optional, used to delete volume if active sessions present. Allowed value are only true or false. Default value is false.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Applies to

DeleteAsync(WaitUntil, Nullable<XMsDeleteSnapshot>, Nullable<XMsForceDelete>, CancellationToken)

Source:
ElasticSanVolumeResource.cs

Delete an Volume.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/volumes/{volumeName}
  • Operation Id: Volumes_Delete
public virtual System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation> DeleteAsync (Azure.WaitUntil waitUntil, Azure.ResourceManager.ElasticSan.Models.XMsDeleteSnapshot? xMsDeleteSnapshots = default, Azure.ResourceManager.ElasticSan.Models.XMsForceDelete? xMsForceDelete = default, System.Threading.CancellationToken cancellationToken = default);
abstract member DeleteAsync : Azure.WaitUntil * Nullable<Azure.ResourceManager.ElasticSan.Models.XMsDeleteSnapshot> * Nullable<Azure.ResourceManager.ElasticSan.Models.XMsForceDelete> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation>
override this.DeleteAsync : Azure.WaitUntil * Nullable<Azure.ResourceManager.ElasticSan.Models.XMsDeleteSnapshot> * Nullable<Azure.ResourceManager.ElasticSan.Models.XMsForceDelete> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation>
Public Overridable Function DeleteAsync (waitUntil As WaitUntil, Optional xMsDeleteSnapshots As Nullable(Of XMsDeleteSnapshot) = Nothing, Optional xMsForceDelete As Nullable(Of XMsForceDelete) = 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.

xMsDeleteSnapshots
Nullable<XMsDeleteSnapshot>

Optional, used to delete snapshots under volume. Allowed value are only true or false. Default value is false.

xMsForceDelete
Nullable<XMsForceDelete>

Optional, used to delete volume if active sessions present. Allowed value are only true or false. Default value is false.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Applies to