PipelineOptions | @azure/storage-file-share

Defines options that are used to configure the HTTP pipeline for an SDK client. Option interface for Pipeline constructor.

export
interface: PipelineOptions

Hierarchy

PipelineOptions
- InternalPipelineOptions

Index

Properties

httpClient
keepAliveOptions
proxyOptions
redirectOptions
retryOptions
userAgentOptions

Properties

Optional httpClient

httpClient: IHttpClient

The HttpClient implementation to use for outgoing HTTP requests. Defaults to DefaultHttpClient. Optional. Configures the HTTP client to send requests and receive responses.

type: {IHttpClient}
memberof: PipelineOptions

Optional keepAliveOptions

keepAliveOptions: KeepAliveOptions

Optional proxyOptions

proxyOptions: ProxyOptions

Options to configure a proxy for outgoing requests.

Optional redirectOptions

redirectOptions: RedirectOptions

Options for how redirect responses are handled.

Optional retryOptions

retryOptions: RetryOptions

Options that control how to retry failed requests.

Optional userAgentOptions

userAgentOptions: UserAgentOptions

Options for adding user agent details to outgoing requests.