FaceSessionClient.GetSessionImage Method

Definition

Namespace:

Azure.AI.Vision.Face

Assembly:

Azure.AI.Vision.Face.dll

Package:

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

Overloads

GetSessionImage(String, RequestContext)	[Protocol Method] Please refer to https://learn.microsoft.com/rest/api/face/liveness-session-operations/get-session-image for more details. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetSessionImage(String, CancellationToken) convenience overload with strongly typed models first.
GetSessionImage(String, CancellationToken)	Please refer to https://learn.microsoft.com/rest/api/face/liveness-session-operations/get-session-image for more details.

GetSessionImage(String, RequestContext)

Source:

FaceSessionClient.cs

[Protocol Method] Please refer to https://learn.microsoft.com/rest/api/face/liveness-session-operations/get-session-image for more details.

• This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
• Please try the simpler GetSessionImage(String, CancellationToken) convenience overload with strongly typed models first.

public virtual Azure.Response GetSessionImage (string sessionImageId, Azure.RequestContext context);

abstract member GetSessionImage : string * Azure.RequestContext -> Azure.Response
override this.GetSessionImage : string * Azure.RequestContext -> Azure.Response

Public Overridable Function GetSessionImage (sessionImageId As String, context As RequestContext) As Response

Parameters

sessionImageId

String

The request ID of the image to be retrieved.

context

RequestContext

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

Returns

Response

The response returned from the service.

Exceptions

ArgumentNullException

sessionImageId is null.

ArgumentException

sessionImageId 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 GetSessionImage and parse the result.

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

Response response = client.GetSessionImage("3d035d35-2e01-4ed4-8935-577afde9caaa", null);

JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.ToString());

GetSessionImage(String, CancellationToken)

Source:

FaceSessionClient.cs

Please refer to https://learn.microsoft.com/rest/api/face/liveness-session-operations/get-session-image for more details.

public virtual Azure.Response<BinaryData> GetSessionImage (string sessionImageId, System.Threading.CancellationToken cancellationToken = default);

abstract member GetSessionImage : string * System.Threading.CancellationToken -> Azure.Response<BinaryData>
override this.GetSessionImage : string * System.Threading.CancellationToken -> Azure.Response<BinaryData>

Public Overridable Function GetSessionImage (sessionImageId As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of BinaryData)

Parameters

sessionImageId

String

The request ID of the image to be retrieved.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Response<BinaryData>

Exceptions

ArgumentNullException

sessionImageId is null.

ArgumentException

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

Examples

This sample shows how to call GetSessionImage.

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

Response<BinaryData> response = client.GetSessionImage("3d035d35-2e01-4ed4-8935-577afde9caaa");