FaceSessionClient.DeleteLivenessSessionAsync(String, RequestContext) Method

Definition

Namespace:

Azure.AI.Vision.Face

Assembly:

Azure.AI.Vision.Face.dll

Package:

Azure.AI.Vision.Face v1.0.0-beta.2

Source:

FaceSessionClient.cs

[Protocol Method] Delete all session related information for matching the specified session id.

• This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.

public virtual System.Threading.Tasks.Task<Azure.Response> DeleteLivenessSessionAsync (string sessionId, Azure.RequestContext context = default);

abstract member DeleteLivenessSessionAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.DeleteLivenessSessionAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>

Public Overridable Function DeleteLivenessSessionAsync (sessionId As String, Optional context As RequestContext = Nothing) As Task(Of Response)

Parameters

sessionId

String

The unique ID to reference this session.

context

RequestContext

The request context, which can override default behaviors of the client pipeline on a per-call basis.

Returns

Task<Response>

The response returned from the service.

Exceptions

ArgumentNullException

sessionId is null.

ArgumentException

sessionId is an empty string, and was expected to be non-empty.

RequestFailedException

Service returned a non-success status code.

Examples

This sample shows how to call DeleteLivenessSessionAsync.

Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
FaceSessionClient client = new FaceSessionClient(endpoint, credential);

Response response = await client.DeleteLivenessSessionAsync("b12e033e-bda7-4b83-a211-e721c661f30e");

Console.WriteLine(response.Status);