CassandraClusterResource.DeallocateAsync 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.
Deallocate the Managed Cassandra Cluster and Associated Data Centers. Deallocation will deallocate the host virtual machine of this cluster, and reserved the data disk. This won't do anything on an already deallocated cluster. Use Start to restart the cluster.
- Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}/deallocate
- Operation Id: CassandraClusters_Deallocate
- Default Api Version: 2024-09-01-preview
- Resource: CassandraClusterResource
public virtual System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation> DeallocateAsync (Azure.WaitUntil waitUntil, string xMsForceDeallocate = default, System.Threading.CancellationToken cancellationToken = default);abstract member DeallocateAsync : Azure.WaitUntil * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation>
override this.DeallocateAsync : Azure.WaitUntil * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation>Public Overridable Function DeallocateAsync (waitUntil As WaitUntil, Optional xMsForceDeallocate 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.
- xMsForceDeallocate
- String
Force to deallocate a cluster of Cluster Type Production. Force to deallocate a cluster of Cluster Type Production might cause data loss.
- cancellationToken
- CancellationToken
The cancellation token to use.
