Class ShareClientOptions

Namespace

Azure.Storage.Files.Shares

Assembly

Azure.Storage.Files.Shares.dll

Provides the client configuration options for connecting to Azure File Storage.

public class ShareClientOptions : ClientOptions

Inheritance

object

ShareClientOptions

Constructors

ShareClientOptions(ServiceVersion)

Initializes a new instance of the ShareClientOptions class.

public ShareClientOptions(ShareClientOptions.ServiceVersion version = ServiceVersion.V2024_08_04)

Parameters

version ShareClientOptions.ServiceVersion

The ShareClientOptions.ServiceVersion of the service API used when making requests.

Properties

AllowSourceTrailingDot

If set to true, trailing dot (.) will be allowed to source file names. If false, the trailing dot will be trimmed. Supported by x-ms-version 2022-11-02 and above. Applicable to Rename(string, ShareFileRenameOptions, CancellationToken), RenameAsync(string, ShareFileRenameOptions, CancellationToken), UploadRangeFromUri(Uri, HttpRange, HttpRange, ShareFileUploadRangeFromUriOptions, CancellationToken), UploadRangeFromUriAsync(Uri, HttpRange, HttpRange, ShareFileUploadRangeFromUriOptions, CancellationToken), StartCopy(Uri, ShareFileCopyOptions, CancellationToken), StartCopyAsync(Uri, ShareFileCopyOptions, CancellationToken), Rename(string, ShareFileRenameOptions, CancellationToken), and RenameAsync(string, ShareFileRenameOptions, CancellationToken).

public bool? AllowSourceTrailingDot { get; set; }

Property Value

bool?

AllowTrailingDot

If set to true, trailing dot (.) will be allowed to suffex directory and file names. If false, the trailing dot will be trimmed. Supported by x-ms-version 2022-11-02 and above.

public bool? AllowTrailingDot { get; set; }

Property Value

bool?

Audience

Gets or sets the Audience to use for authentication with Azure Active Directory (AAD). The audience is not considered when using a shared key.

public ShareAudience? Audience { get; set; }

Property Value

ShareAudience?

If null, DefaultAudience will be assumed.

ShareTokenIntent

Share Token Intent. For use with token authentication. Used to indicate the intent of the request. This is currently required when using token authentication.

public ShareTokenIntent? ShareTokenIntent { get; set; }

Property Value

ShareTokenIntent?

TransferValidation

Transfer validation options to be applied to file transfers from this client.

public TransferValidationOptions TransferValidation { get; }

Property Value

TransferValidationOptions

Version

Gets the ShareClientOptions.ServiceVersion of the service API used when making requests. For more, see Versioning for the Azure Storage services.

public ShareClientOptions.ServiceVersion Version { get; }

Property Value

ShareClientOptions.ServiceVersion