InternalClientPipelineOptions interface

Package:

@azure/core-client

Options for creating a Pipeline to use with ServiceClient. Mostly for customizing the auth policy (if using token auth) or the deserialization options when using XML.

Extends

InternalPipelineOptions

Properties

credentialOptions	Options to customize bearerTokenAuthenticationPolicy.
deserializationOptions	Options to customize deserializationPolicy.
serializationOptions	Options to customize serializationPolicy.

Inherited Properties

loggingOptions	Options to configure request/response logging.
proxyOptions	Options to configure a proxy for outgoing requests.
redirectOptions	Options for how redirect responses are handled.
retryOptions	Options that control how to retry failed requests.
telemetryOptions	Options for setting common telemetry and tracing info to outgoing requests.
tlsOptions	Options for configuring TLS authentication
userAgentOptions	Options for adding user agent details to outgoing requests.

Property Details

credentialOptions

Options to customize bearerTokenAuthenticationPolicy.

credentialOptions?: { credential: TokenCredential, credentialScopes: string | string[] }

Property Value

{ credential: TokenCredential, credentialScopes: string | string[] }

deserializationOptions

Options to customize deserializationPolicy.

deserializationOptions?: DeserializationPolicyOptions

Property Value

DeserializationPolicyOptions

serializationOptions

Options to customize serializationPolicy.

serializationOptions?: SerializationPolicyOptions

Property Value

SerializationPolicyOptions

Inherited Property Details

loggingOptions

Options to configure request/response logging.

loggingOptions?: LogPolicyOptions

Property Value

LogPolicyOptions

Inherited From InternalPipelineOptions.loggingOptions

proxyOptions

Options to configure a proxy for outgoing requests.

proxyOptions?: ProxySettings

Property Value

ProxySettings

Inherited From InternalPipelineOptions.proxyOptions

redirectOptions

Options for how redirect responses are handled.

redirectOptions?: RedirectPolicyOptions

Property Value

RedirectPolicyOptions

Inherited From InternalPipelineOptions.redirectOptions

retryOptions

Options that control how to retry failed requests.

retryOptions?: PipelineRetryOptions

Property Value

PipelineRetryOptions

Inherited From InternalPipelineOptions.retryOptions

telemetryOptions

Options for setting common telemetry and tracing info to outgoing requests.

telemetryOptions?: TelemetryOptions

Property Value

TelemetryOptions

Inherited From InternalPipelineOptions.telemetryOptions

tlsOptions

Options for configuring TLS authentication

tlsOptions?: TlsSettings

Property Value

TlsSettings

Inherited From InternalPipelineOptions.tlsOptions

userAgentOptions

Options for adding user agent details to outgoing requests.

userAgentOptions?: UserAgentPolicyOptions

Property Value

UserAgentPolicyOptions

Inherited From InternalPipelineOptions.userAgentOptions