BlobBaseClient.CreateSnapshotAsync Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
The CreateSnapshotAsync(IDictionary<String,String>, BlobRequestConditions, CancellationToken) operation creates a read-only snapshot of a blob.
For more information, see Snapshot Blob.
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Blobs.Models.BlobSnapshotInfo>> CreateSnapshotAsync (System.Collections.Generic.IDictionary<string,string> metadata = default, Azure.Storage.Blobs.Models.BlobRequestConditions conditions = default, System.Threading.CancellationToken cancellationToken = default);abstract member CreateSnapshotAsync : System.Collections.Generic.IDictionary<string, string> * Azure.Storage.Blobs.Models.BlobRequestConditions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Blobs.Models.BlobSnapshotInfo>>
override this.CreateSnapshotAsync : System.Collections.Generic.IDictionary<string, string> * Azure.Storage.Blobs.Models.BlobRequestConditions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Blobs.Models.BlobSnapshotInfo>>Public Overridable Function CreateSnapshotAsync (Optional metadata As IDictionary(Of String, String) = Nothing, Optional conditions As BlobRequestConditions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of BlobSnapshotInfo))Parameters
- metadata
- IDictionary<String,String>
Optional custom metadata to set for this blob snapshot.
- conditions
- BlobRequestConditions
Optional BlobRequestConditions to add conditions on setting creating this snapshot.
- cancellationToken
- CancellationToken
Optional CancellationToken to propagate notifications that the operation should be cancelled.
Returns
A Response<T> describing the new blob snapshot.
Remarks
A RequestFailedException will be thrown if a failure occurs.
