ShareClientOptions Class

Definition

Namespace:

Azure.Storage.Files.Shares

Assembly:

Azure.Storage.Files.Shares.dll

Package:

Azure.Storage.Files.Shares v12.20.1

Source:

ShareClientOptions.cs

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

public class ShareClientOptions : Azure.Core.ClientOptions

type ShareClientOptions = class
    inherit ClientOptions

Public Class ShareClientOptions
Inherits ClientOptions

Inheritance

Object

ClientOptions

ShareClientOptions

Constructors

ShareClientOptions(ShareClientOptions+ServiceVersion)

Initializes a new instance of the ShareClientOptions class.

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).
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.
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.
Diagnostics	Gets the client diagnostic options. (Inherited from ClientOptions)
Retry	Gets the client retry options. (Inherited from ClientOptions)
RetryPolicy	Gets or sets the policy to use for retries. If a policy is specified, it will be used in place of the Retry property. The RetryPolicy type can be derived from to modify the default behavior without needing to fully implement the retry logic. If Process(HttpMessage, ReadOnlyMemory<HttpPipelinePolicy>) is overridden or a custom HttpPipelinePolicy is specified, it is the implementer's responsibility to update the ProcessingContext values. (Inherited from ClientOptions)
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.
TransferValidation	Transfer validation options to be applied to file transfers from this client.
Transport	The HttpPipelineTransport to be used for this client. Defaults to an instance of HttpClientTransport. (Inherited from ClientOptions)
Version	Gets the ShareClientOptions.ServiceVersion of the service API used when making requests. For more, see Versioning for the Azure Storage services.

Methods

AddPolicy(HttpPipelinePolicy, HttpPipelinePosition)

Adds an HttpPipeline policy into the client pipeline. The position of policy in the pipeline is controlled by the position parameter. If you want the policy to execute once per client request use PerCall otherwise use PerRetry to run the policy for every retry. Note that the same instance of policy would be added to all pipelines of client constructed using this ClientOptions object. (Inherited from ClientOptions)