ShareClient.CreateSnapshot Method

Reference

Definition

Namespace:: Azure.Storage.Files.Shares

Assembly:: Azure.Storage.Files.Shares.dll

Package:: Azure.Storage.Files.Shares v12.17.1

Package:: Azure.Storage.Files.Shares v12.18.0-beta.2

Source:: ShareClient.cs

Source:: ShareClient.cs

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.

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

Response<ShareSnapshotInfo>

A Response<T> describing the newly created snapshot.

Remarks

A RequestFailedException will be thrown if a failure occurs.

Applies to