Share via

StoragePipelineOptions interface

  • Reference
Package:
@azure/storage-blob

Options interface for the newPipeline function.

Properties

audience

The audience used to retrieve an AAD token. By default, audience 'https://storage.azure.com/.default' will be used.
httpClient

Configures the HTTP client to send requests and receive responses.
keepAliveOptions

Keep alive configurations. Default keep-alive is enabled.
proxyOptions

Options to configure a proxy for outgoing requests.
retryOptions

Configures the built-in retry policy behavior.
userAgentOptions

Options for adding user agent details to outgoing requests.

Property Details

audience

The audience used to retrieve an AAD token. By default, audience 'https://storage.azure.com/.default' will be used.

TypeScript 
audience?: string | string[]

Property Value

string | string[]

httpClient

Configures the HTTP client to send requests and receive responses.

TypeScript 
httpClient?: RequestPolicy

Property Value

IHttpClient

keepAliveOptions

Keep alive configurations. Default keep-alive is enabled.

TypeScript 
keepAliveOptions?: KeepAliveOptions

Property Value

KeepAliveOptions

proxyOptions

Options to configure a proxy for outgoing requests.

TypeScript 
proxyOptions?: ProxySettings

Property Value

ProxySettings

retryOptions

Configures the built-in retry policy behavior.

TypeScript 
retryOptions?: StorageRetryOptions

Property Value

StorageRetryOptions

userAgentOptions

Options for adding user agent details to outgoing requests.

TypeScript 
userAgentOptions?: UserAgentPolicyOptions

Property Value

UserAgentPolicyOptions