Sprog

FoundryStateStore.DeleteItemAsync Method

Definition

Overloads

Name Description
DeleteItemAsync(String, ETag, CancellationToken)

Deletes one item by key.

DeleteItemAsync(String, ETag, String, CancellationToken)

Deletes one item by key.

DeleteItemAsync(String, ETag, CancellationToken)

Source:
FoundryStateStore.cs

Deletes one item by key.

public virtual System.Threading.Tasks.Task<Azure.AI.AgentServer.Core.Storage.DeletedStateStoreItem> DeleteItemAsync(string key, Azure.ETag ifMatch = default, System.Threading.CancellationToken cancellationToken = default);
abstract member DeleteItemAsync : string * Azure.ETag * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.AgentServer.Core.Storage.DeletedStateStoreItem>
override this.DeleteItemAsync : string * Azure.ETag * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.AgentServer.Core.Storage.DeletedStateStoreItem>
Public Overridable Function DeleteItemAsync (key As String, Optional ifMatch As ETag = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of DeletedStateStoreItem)

Parameters

key
String

The item key.

ifMatch
ETag

Optional optimistic-concurrency token.

cancellationToken
CancellationToken

A cancellation token.

Returns

The deleted-item marker.

Applies to

DeleteItemAsync(String, ETag, String, CancellationToken)

Source:
FoundryStateStore.cs

Deletes one item by key.

public virtual System.Threading.Tasks.Task<Azure.AI.AgentServer.Core.Storage.DeletedStateStoreItem> DeleteItemAsync(string key, Azure.ETag ifMatch, string? callId, System.Threading.CancellationToken cancellationToken = default);
abstract member DeleteItemAsync : string * Azure.ETag * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.AgentServer.Core.Storage.DeletedStateStoreItem>
override this.DeleteItemAsync : string * Azure.ETag * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.AgentServer.Core.Storage.DeletedStateStoreItem>
Public Overridable Function DeleteItemAsync (key As String, ifMatch As ETag, callId As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of DeletedStateStoreItem)

Parameters

key
String

The item key.

ifMatch
ETag

Optional optimistic-concurrency token.

callId
String

The Foundry call ID to forward, or null to use the current request context.

cancellationToken
CancellationToken

A cancellation token.

Returns

The deleted-item marker.

Applies to