Click or drag to resize
IBlockStorageProviderDeleteVolume Method
Deletes a volume.

Namespace: net.openstack.Core.Providers
Assembly: openstacknet (in openstacknet.dll) Version: 1.7.7+Branch.master.Sha.25d803f397c8693c2c13777ef6675f796f520f2c
Syntax
bool DeleteVolume(
	string volumeId,
	string region = null,
	CloudIdentity identity = null
)

Parameters

volumeId
Type: SystemString
The ID of the volume to delete. The value should be obtained from Volume.Id.
region (Optional)
Type: SystemString
The region in which to execute this action. If not specified, the user's default region will be used.
identity (Optional)
Type: net.openstack.Core.DomainCloudIdentity
The cloud identity to use for this request. If not specified, the default identity for the current provider instance will be used.

Return Value

Type: Boolean
if the volume was successfully deleted; otherwise .
Exceptions
ExceptionCondition
ArgumentNullExceptionIf volumeId is .
ArgumentExceptionIf volumeId is empty.
NotSupportedException If the provider does not support the given identity type.

-or-

The specified region is not supported.

InvalidOperationException If identity is and no default identity is available for the provider.

-or-

If region is and no default region is available for the provider.

ResponseExceptionIf the REST API request failed.
Remarks
The deletion operation is performed asynchronously. After this call returns, WaitForVolumeDeleted(String, Int32, NullableTimeSpan, String, CloudIdentity) may be called to wait until the volume is finally deleted.
Note Note
It is not currently possible to delete a volume once you have created a snapshot from it. Any snapshots will need to be deleted prior to deleting the volume.
Version Information

.NET Framework

Supported in: 4.5

openstack.net

Supported in: 1.6, 1.5, 1.4, 1.3.6
See Also