Condividi tramite


ShareClient.CreateSnapshot Method

Definition

Creates a read-only snapshot of a share.

For more information, see Snapshot Share.

public virtual Azure.Response<Azure.Storage.Files.Shares.Models.ShareSnapshotInfo> CreateSnapshot (System.Collections.Generic.IDictionary<string,string> metadata = default, System.Threading.CancellationToken cancellationToken = default);
abstract member CreateSnapshot : System.Collections.Generic.IDictionary<string, string> * System.Threading.CancellationToken -> Azure.Response<Azure.Storage.Files.Shares.Models.ShareSnapshotInfo>
override this.CreateSnapshot : System.Collections.Generic.IDictionary<string, string> * System.Threading.CancellationToken -> Azure.Response<Azure.Storage.Files.Shares.Models.ShareSnapshotInfo>
Public Overridable Function CreateSnapshot (Optional metadata As IDictionary(Of String, String) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of ShareSnapshotInfo)

Parameters

metadata
IDictionary<String,String>

Optional custom metadata to set for this share.

cancellationToken
CancellationToken

Optional CancellationToken to propagate notifications that the operation should be cancelled.

Returns

A Response<T> describing the newly created snapshot.

Remarks

A RequestFailedException will be thrown if a failure occurs.

Applies to