ISnapshotOperations.ListWithHttpMessagesAsync(Nullable<SnapshotObjectType>, IList<Guid>, Dictionary<String,List<String>>, CancellationToken) Method

Definition

List all accessible snapshots with related information, including snapshots that were taken by the user, or snapshots to be applied to the user (subscription id was included in the applyScope in Snapshot - Take).

public System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<System.Collections.Generic.IList<Microsoft.Azure.CognitiveServices.Vision.Face.Models.Snapshot>>> ListWithHttpMessagesAsync (Microsoft.Azure.CognitiveServices.Vision.Face.Models.SnapshotObjectType? type = default, System.Collections.Generic.IList<Guid> applyScope = default, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);
abstract member ListWithHttpMessagesAsync : Nullable<Microsoft.Azure.CognitiveServices.Vision.Face.Models.SnapshotObjectType> * System.Collections.Generic.IList<Guid> * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<System.Collections.Generic.IList<Microsoft.Azure.CognitiveServices.Vision.Face.Models.Snapshot>>>
Public Function ListWithHttpMessagesAsync (Optional type As Nullable(Of SnapshotObjectType) = Nothing, Optional applyScope As IList(Of Guid) = Nothing, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of HttpOperationResponse(Of IList(Of Snapshot)))

Parameters

type
Nullable<SnapshotObjectType>

User specified object type as a search filter. Possible values include: 'FaceList', 'LargeFaceList', 'LargePersonGroup', 'PersonGroup'

applyScope
IList<Guid>

User specified snapshot apply scopes as a search filter. ApplyScope is an array of the target Azure subscription ids for the snapshot, specified by the user who created the snapshot by Snapshot - Take.

customHeaders
Dictionary<String,List<String>>

The headers that will be added to request.

cancellationToken
CancellationToken

The cancellation token.

Returns

Task<HttpOperationResponse<IList<Snapshot>>>

Exceptions

Thrown when the operation returned an invalid status code

Thrown when unable to deserialize the response

Thrown when a required parameter is null

Applies to