SnapshotOperations.GetWithHttpMessagesAsync Method

Definition

Namespace:

Microsoft.Azure.CognitiveServices.Vision.Face

Assembly:

Microsoft.Azure.CognitiveServices.Vision.Face.dll

Package:

Microsoft.Azure.CognitiveServices.Vision.Face v2.8.0-preview.3

Source:

SnapshotOperations.cs

Retrieve information about a snapshot. Snapshot is only accessible to the source subscription who took it, and target subscriptions included in the applyScope in Snapshot - Take.

public System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.CognitiveServices.Vision.Face.Models.Snapshot>> GetWithHttpMessagesAsync (Guid snapshotId, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);

abstract member GetWithHttpMessagesAsync : Guid * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.CognitiveServices.Vision.Face.Models.Snapshot>>
override this.GetWithHttpMessagesAsync : Guid * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.CognitiveServices.Vision.Face.Models.Snapshot>>

Public Function GetWithHttpMessagesAsync (snapshotId As Guid, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of HttpOperationResponse(Of Snapshot))

Parameters

snapshotId

Guid

Id referencing a particular snapshot.

customHeaders

Dictionary<String,List<String>>

Headers that will be added to request.

cancellationToken

CancellationToken

The cancellation token.

Returns

Task<HttpOperationResponse<Snapshot>>

Implements

GetWithHttpMessagesAsync(Guid, Dictionary<String,List<String>>, CancellationToken)

Exceptions

APIErrorException

Thrown when the operation returned an invalid status code

SerializationException

Thrown when unable to deserialize the response

ValidationException

Thrown when a required parameter is null

ArgumentNullException

Thrown when a required parameter is null