Skip to main content

liveness_session_audit_entries

Creates, updates, deletes, gets or lists a liveness_session_audit_entries resource.

Overview

Nameliveness_session_audit_entries
TypeResource
Idazure.ai_vision_face.liveness_session_audit_entries

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
idintegerThe unique id to refer to this audit request. Use this id with the 'start' query parameter to continue on to the next page of audit results. Required.
clientRequestIdstringThe unique clientRequestId that is sent by the client in the 'client-request-id' header. Required.
digeststringThe server calculated digest for this request. If the client reported digest differs from the server calculated digest, then the message integrity between the client and service has been compromised and the result should not be trusted. For more information, see how to guides on how to leverage this value to secure your end-to-end solution. Required.
receivedDateTimestring (date-time)The UTC DateTime that the request was received. Required.
requestobjectThe request of this entry. Required.
requestIdstringThe unique requestId that is returned by the service to the client in the 'apim-request-id' header. Required.
responseobjectThe response of this entry. Required.
sessionIdstringThe unique sessionId of the created session. It will expire 48 hours after it was created or may be deleted sooner using the corresponding session DELETE operation. Required.
sessionImageIdstringThe image ID of the session request.
verifyImageHashstringThe sha256 hash of the verify-image in the request.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
get_liveness_session_audit_entriesselectsession_id, endpoint, api_versionstart, topPlease refer to https://learn.microsoft.com/rest/api/face/liveness-session-operations/get-liveness-session-audit-entries for more details.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
api_versionstringThe service endpoint host (no scheme), e.g. myaccount.table.cosmos.azure.com:443 - value of the client apiVersion parameter. (default: )
endpointstringThe service endpoint host (no scheme), e.g. myaccount.table.cosmos.azure.com:443 - value of the client endpoint parameter. (default: )
session_idstringThe unique ID to reference this session. Required.
startstringList resources greater than the "start". It contains no more than 64 characters. Default is empty. Default value is None.
topintegerThe number of items to list, ranging in [1, 1000]. Default is 1000. Default value is None.

SELECT examples

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

SELECT
id,
clientRequestId,
digest,
receivedDateTime,
request,
requestId,
response,
sessionId,
sessionImageId,
verifyImageHash
FROM azure.ai_vision_face.liveness_session_audit_entries
WHERE session_id = '{{ session_id }}' -- required
AND endpoint = '{{ endpoint }}' -- required
AND api_version = '{{ api_version }}' -- required
AND start = '{{ start }}'
AND top = '{{ top }}'
;