ReliableStateManager.IReliableStateManager.RemoveAsync 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.
Overloads
| IReliableStateManager.RemoveAsync(ITransaction, Uri, TimeSpan) |
Removes the IReliableState with the given name from this state manager. The state is permanently removed from persistent storage and all replicas when the transaction is committed. |
| IReliableStateManager.RemoveAsync(String, TimeSpan) |
Removes the IReliableState with the given name from this state manager. The state is permanently removed from persistent storage and all replicas. |
| IReliableStateManager.RemoveAsync(Uri, TimeSpan) |
Removes the IReliableState with the given name from this state manager. The state is permanently removed from persistent storage and all replicas. |
| IReliableStateManager.RemoveAsync(ITransaction, Uri) |
Removes the IReliableState with the given name from this state manager. The state is permanently removed from persistent storage and all replicas when the transaction is committed. |
| IReliableStateManager.RemoveAsync(ITransaction, String) |
Removes the IReliableState with the given name from this state manager. The state is permanently removed from persistent storage and all replicas when the transaction is committed. |
| IReliableStateManager.RemoveAsync(Uri) |
Removes the IReliableState with the given name from this state manager. The state is permanently removed from persistent storage and all replicas. |
| IReliableStateManager.RemoveAsync(String) |
Removes the IReliableState with the given name from this state manager. The state is permanently removed from persistent storage and all replicas. |
| IReliableStateManager.RemoveAsync(ITransaction, String, TimeSpan) |
Removes the IReliableState with the given name from this state manager. The state is permanently removed from persistent storage and all replicas when the transaction is committed. |
IReliableStateManager.RemoveAsync(ITransaction, Uri, TimeSpan)
Removes the IReliableState with the given name from this state manager. The state is permanently removed from persistent storage and all replicas when the transaction is committed.
System.Threading.Tasks.Task IReliableStateManager.RemoveAsync (Microsoft.ServiceFabric.Data.ITransaction tx, Uri name, TimeSpan timeout);abstract member Microsoft.ServiceFabric.Data.IReliableStateManager.RemoveAsync : Microsoft.ServiceFabric.Data.ITransaction * Uri * TimeSpan -> System.Threading.Tasks.Task
override this.Microsoft.ServiceFabric.Data.IReliableStateManager.RemoveAsync : Microsoft.ServiceFabric.Data.ITransaction * Uri * TimeSpan -> System.Threading.Tasks.TaskFunction RemoveAsync (tx As ITransaction, name As Uri, timeout As TimeSpan) As Task Implements IReliableStateManager.RemoveAsyncParameters
- tx
- ITransaction
Transaction to associate this operation with.
- name
- Uri
The name of the IReliableState to remove.
- timeout
- TimeSpan
The amount of time to wait for the operation to complete before throwing a TimeoutException. Primarily used to prevent deadlocks. The default is 4 seconds.
Returns
Task that represents the asynchronous remove operation.
Implements
Exceptions
tx is null, or name is null.
An IReliableState with the given name does not exist, or timeout is negative.
The operation failed to complete within the given timeout.
Thrown when the IReliableStateManager is not in Primary.
Thrown when a method call is invalid for the object's current state. For example, transaction used is already terminated: committed or aborted.
Indicates that the Reliable State Manager is closed.
Remarks
This is an atomic operation. The IReliableState will be successfully removed along with all state or be left in-tact. If this method throws an exception, the transaction must be aborted.
Applies to
IReliableStateManager.RemoveAsync(String, TimeSpan)
Removes the IReliableState with the given name from this state manager. The state is permanently removed from persistent storage and all replicas.
System.Threading.Tasks.Task IReliableStateManager.RemoveAsync (string name, TimeSpan timeout);abstract member Microsoft.ServiceFabric.Data.IReliableStateManager.RemoveAsync : string * TimeSpan -> System.Threading.Tasks.Task
override this.Microsoft.ServiceFabric.Data.IReliableStateManager.RemoveAsync : string * TimeSpan -> System.Threading.Tasks.TaskFunction RemoveAsync (name As String, timeout As TimeSpan) As Task Implements IReliableStateManager.RemoveAsyncParameters
- name
- String
The name of the IReliableState to remove.
- timeout
- TimeSpan
The amount of time to wait for the operation to complete before throwing a TimeoutException. Primarily used to prevent deadlocks. The default is 4 seconds.
Returns
Task that represents the asynchronous remove operation.
Implements
Exceptions
name is null.
An IReliableState with the given name does not exist, or timeout is negative.
The operation failed to complete within the given timeout.
Thrown when the IReliableStateManager is not in Primary.
Indicates that the Reliable State Manager is closed.
Remarks
This is an atomic operation. The IReliableState will be successfully removed along with all state or be left in-tact.
Applies to
IReliableStateManager.RemoveAsync(Uri, TimeSpan)
Removes the IReliableState with the given name from this state manager. The state is permanently removed from persistent storage and all replicas.
System.Threading.Tasks.Task IReliableStateManager.RemoveAsync (Uri name, TimeSpan timeout);abstract member Microsoft.ServiceFabric.Data.IReliableStateManager.RemoveAsync : Uri * TimeSpan -> System.Threading.Tasks.Task
override this.Microsoft.ServiceFabric.Data.IReliableStateManager.RemoveAsync : Uri * TimeSpan -> System.Threading.Tasks.TaskFunction RemoveAsync (name As Uri, timeout As TimeSpan) As Task Implements IReliableStateManager.RemoveAsyncParameters
- name
- Uri
The name of the IReliableState to remove.
- timeout
- TimeSpan
The amount of time to wait for the operation to complete before throwing a TimeoutException. Primarily used to prevent deadlocks. The default is 4 seconds.
Returns
Task that represents the asynchronous remove operation.
Implements
Exceptions
name is null.
An IReliableState with the given name does not exist, or timeout is negative.
The operation failed to complete within the given timeout.
Thrown when the IReliableStateManager is not in Primary.
Indicates that the Reliable State Manager is closed.
Remarks
This is an atomic operation. The IReliableState will be successfully removed along with all state or be left in-tact.
Applies to
IReliableStateManager.RemoveAsync(ITransaction, Uri)
Removes the IReliableState with the given name from this state manager. The state is permanently removed from persistent storage and all replicas when the transaction is committed.
System.Threading.Tasks.Task IReliableStateManager.RemoveAsync (Microsoft.ServiceFabric.Data.ITransaction tx, Uri name);abstract member Microsoft.ServiceFabric.Data.IReliableStateManager.RemoveAsync : Microsoft.ServiceFabric.Data.ITransaction * Uri -> System.Threading.Tasks.Task
override this.Microsoft.ServiceFabric.Data.IReliableStateManager.RemoveAsync : Microsoft.ServiceFabric.Data.ITransaction * Uri -> System.Threading.Tasks.TaskFunction RemoveAsync (tx As ITransaction, name As Uri) As Task Implements IReliableStateManager.RemoveAsyncParameters
- tx
- ITransaction
Transaction to associate this operation with.
- name
- Uri
The name of the IReliableState to remove.
Returns
Task that represents the asynchronous remove operation.
Implements
Exceptions
tx is null, or name is null.
An IReliableState with the given name does not exist.
The operation failed to complete within the default timeout.
Thrown when the IReliableStateManager is not in Primary.
Thrown when a method call is invalid for the object's current state. For example, transaction used is already terminated: committed or aborted.
Indicates that the Reliable State Manager is closed.
Remarks
This is an atomic operation. The IReliableState will be successfully removed along with all state or be left in-tact. If this method throws an exception, the transaction must be aborted.
Applies to
IReliableStateManager.RemoveAsync(ITransaction, String)
Removes the IReliableState with the given name from this state manager. The state is permanently removed from persistent storage and all replicas when the transaction is committed.
System.Threading.Tasks.Task IReliableStateManager.RemoveAsync (Microsoft.ServiceFabric.Data.ITransaction tx, string name);abstract member Microsoft.ServiceFabric.Data.IReliableStateManager.RemoveAsync : Microsoft.ServiceFabric.Data.ITransaction * string -> System.Threading.Tasks.Task
override this.Microsoft.ServiceFabric.Data.IReliableStateManager.RemoveAsync : Microsoft.ServiceFabric.Data.ITransaction * string -> System.Threading.Tasks.TaskFunction RemoveAsync (tx As ITransaction, name As String) As Task Implements IReliableStateManager.RemoveAsyncParameters
- tx
- ITransaction
Transaction to associate this operation with.
- name
- String
The name of the IReliableState to remove.
Returns
Task that represents the asynchronous remove operation.
Implements
Exceptions
tx is null, or name is null.
An IReliableState with the given name does not exist.
The operation failed to complete within the default timeout.
Thrown when the IReliableStateManager is not in Primary.
Thrown when a method call is invalid for the object's current state. For example, transaction used is already terminated: committed or aborted.
Indicates that the Reliable State Manager is closed.
Remarks
This is an atomic operation. The IReliableState will be successfully removed along with all state or be left in-tact. If this method throws an exception, the transaction must be aborted.
Applies to
IReliableStateManager.RemoveAsync(Uri)
Removes the IReliableState with the given name from this state manager. The state is permanently removed from persistent storage and all replicas.
System.Threading.Tasks.Task IReliableStateManager.RemoveAsync (Uri name);abstract member Microsoft.ServiceFabric.Data.IReliableStateManager.RemoveAsync : Uri -> System.Threading.Tasks.Task
override this.Microsoft.ServiceFabric.Data.IReliableStateManager.RemoveAsync : Uri -> System.Threading.Tasks.TaskFunction RemoveAsync (name As Uri) As Task Implements IReliableStateManager.RemoveAsyncParameters
- name
- Uri
The name of the IReliableState to remove.
Returns
Task that represents the asynchronous remove operation.
Implements
Exceptions
name is null.
An IReliableState with the given name does not exist.
The operation failed to complete within the default timeout.
Thrown when the IReliableStateManager is not in Primary.
Indicates that the Reliable State Manager is closed.
Remarks
This is an atomic operation. The IReliableState will be successfully removed along with all state or be left in-tact.
Applies to
IReliableStateManager.RemoveAsync(String)
Removes the IReliableState with the given name from this state manager. The state is permanently removed from persistent storage and all replicas.
System.Threading.Tasks.Task IReliableStateManager.RemoveAsync (string name);abstract member Microsoft.ServiceFabric.Data.IReliableStateManager.RemoveAsync : string -> System.Threading.Tasks.Task
override this.Microsoft.ServiceFabric.Data.IReliableStateManager.RemoveAsync : string -> System.Threading.Tasks.TaskFunction RemoveAsync (name As String) As Task Implements IReliableStateManager.RemoveAsyncParameters
- name
- String
The name of the IReliableState to remove.
Returns
Task that represents the asynchronous remove operation.
Implements
Exceptions
name is null.
An IReliableState with the given name does not exist.
The operation failed to complete within the default timeout.
Thrown when the IReliableStateManager is not in Primary.
Indicates that the Reliable State Manager is closed.
Remarks
This is an atomic operation. The IReliableState will be successfully removed along with all state or be left in-tact.
Applies to
IReliableStateManager.RemoveAsync(ITransaction, String, TimeSpan)
Removes the IReliableState with the given name from this state manager. The state is permanently removed from persistent storage and all replicas when the transaction is committed.
System.Threading.Tasks.Task IReliableStateManager.RemoveAsync (Microsoft.ServiceFabric.Data.ITransaction tx, string name, TimeSpan timeout);abstract member Microsoft.ServiceFabric.Data.IReliableStateManager.RemoveAsync : Microsoft.ServiceFabric.Data.ITransaction * string * TimeSpan -> System.Threading.Tasks.Task
override this.Microsoft.ServiceFabric.Data.IReliableStateManager.RemoveAsync : Microsoft.ServiceFabric.Data.ITransaction * string * TimeSpan -> System.Threading.Tasks.TaskFunction RemoveAsync (tx As ITransaction, name As String, timeout As TimeSpan) As Task Implements IReliableStateManager.RemoveAsyncParameters
- tx
- ITransaction
Transaction to associate this operation with.
- name
- String
The name of the IReliableState to remove.
- timeout
- TimeSpan
The amount of time to wait for the operation to complete before throwing a TimeoutException. Primarily used to prevent deadlocks. The default is 4 seconds.
Returns
Task that represents the asynchronous remove operation.
Implements
Exceptions
tx is null, or name is null.
An IReliableState with the given name does not exist, or timeout is negative.
The operation failed to complete within the given timeout.
Thrown when the IReliableStateManager is not in Primary.
Thrown when a method call is invalid for the object's current state. For example, transaction used is already terminated: committed or aborted.
Indicates that the Reliable State Manager is closed.
Remarks
This is an atomic operation. The IReliableState will be successfully removed along with all state or be left in-tact. If this method throws an exception, the transaction must be aborted.
Applies to
Azure SDK for .NET
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for