AgentAdministrationClient.DeleteSession Method

Definition

Deletes a session synchronously. Returns 204 No Content when the session is deleted or does not exist.

public virtual System.ClientModel.ClientResult DeleteSession(string agentName, string sessionId, System.Threading.CancellationToken cancellationToken = default);
abstract member DeleteSession : string * string * System.Threading.CancellationToken -> System.ClientModel.ClientResult
override this.DeleteSession : string * string * System.Threading.CancellationToken -> System.ClientModel.ClientResult
Public Overridable Function DeleteSession (agentName As String, sessionId As String, Optional cancellationToken As CancellationToken = Nothing) As ClientResult

Parameters

agentName
String

The name of the agent.

sessionId
String

The session identifier.

cancellationToken
CancellationToken

The cancellation token that can be used to cancel the operation.

Returns

Exceptions

agentName or sessionId/> is null.

agentName or sessionId/> is an empty string, and was expected to be non-empty.

Service returned a non-success status code.

Applies to