This function permanently deletes the given stream. This operation **CANNOT** be undone! For recoverable deletions, see the Delete(String) method. Purge is restricted to VC admins only.

Namespace: Microsoft.Cosmos.Management
Assembly: VcClient (in VcClient.dll) Version: 1.0.0.0 (1.8.400.4142)

Syntax

C#
public void Purge(
	CosmosUri stream
)
Visual Basic
Public Sub Purge ( _
	stream As CosmosUri _
)
Visual C++
public:
void Purge(
	CosmosUri^ stream
)

Parameters

stream
Type: CosmosUri
Stream path to be purged.

Remarks

Directory purge is currently not supported through this API.

Exceptions

ExceptionCondition
ArgumentNullExceptionThrown when stream is null or empty.
VcClientExceptions..::..VcClientExceptionThrown when the purge operation fails.

See Also