Snapshot Class

Snapshot object.

All required parameters must be populated in order to send to Azure.

Inheritance
Snapshot

Constructor

Snapshot(*, id: str, account: str, type, apply_scope, created_time, last_update_time, user_data: str = None, **kwargs) -> None

Parameters

id
str
Required

Required. Snapshot id.

account
str
Required

Required. Azure Cognitive Service Face account id of the subscriber who created the snapshot by Snapshot - Take.

type
str or SnapshotObjectType
Required

Required. Type of the source object in the snapshot, specified by the subscriber who created the snapshot when calling Snapshot

  • Take. Currently FaceList, PersonGroup, LargeFaceList and LargePersonGroup are supported. Possible values include: 'FaceList', 'LargeFaceList', 'LargePersonGroup', 'PersonGroup'
apply_scope
list[str]
Required

Required. Array of the target Face subscription ids for the snapshot, specified by the user who created the snapshot when calling Snapshot - Take. For each snapshot, only subscriptions included in the applyScope of Snapshot - Take can apply it.

user_data
str
Required

User specified data about the snapshot for any purpose. Length should not exceed 16KB.

created_time
datetime
Required

Required. A combined UTC date and time string that describes the created time of the snapshot. E.g. 2018-12-25T11:41:02.2331413Z.

last_update_time
datetime
Required

Required. A combined UTC date and time string that describes the last time when the snapshot was created or updated by Snapshot - Update. E.g. 2018-12-25T11:51:27.8705696Z.