Share via


SnapshotOperations.UpdateWithHttpMessagesAsync Method

Definition

Update the information of a snapshot. Only the source subscription who took the snapshot can update the snapshot.

public System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse> UpdateWithHttpMessagesAsync (Guid snapshotId, System.Collections.Generic.IList<Guid> applyScope = default, string userData = default, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);
abstract member UpdateWithHttpMessagesAsync : Guid * System.Collections.Generic.IList<Guid> * string * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse>
override this.UpdateWithHttpMessagesAsync : Guid * System.Collections.Generic.IList<Guid> * string * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse>
Public Function UpdateWithHttpMessagesAsync (snapshotId As Guid, Optional applyScope As IList(Of Guid) = Nothing, Optional userData As String = Nothing, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of HttpOperationResponse)

Parameters

snapshotId
Guid

Id referencing a particular snapshot.

applyScope
IList<Guid>

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.

userData
String

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

customHeaders
Dictionary<String,List<String>>

Headers that will be added to request.

cancellationToken
CancellationToken

The cancellation token.

Returns

Implements

Exceptions

Thrown when the operation returned an invalid status code

Thrown when a required parameter is null

Thrown when a required parameter is null

Applies to