ServiceClientOptions interface

Package:

@azure/core-client

Options to be provided while creating the client.

Extends

CommonClientOptions

Properties

baseUri	If specified, this is the base URI that requests will be made against for this ServiceClient. If it is not specified, then all OperationSpecs must contain a baseUrl property.
credential	Credential used to authenticate the request.
credentialScopes	If specified, will be used to build the BearerTokenAuthenticationPolicy.
endpoint	If specified, this is the endpoint that requests will be made against for this ServiceClient. If it is not specified, then all OperationSpecs must contain a baseUrl property. to encourage customer to use endpoint, we mark the baseUri as deprecated.
pipeline	A customized pipeline to use, otherwise a default one will be created.
requestContentType	The default request content type for the service. Used if no requestContentType is present on an OperationSpec.

Inherited Properties

additionalPolicies	Additional policies to include in the HTTP pipeline.
allowInsecureConnection	Set to true if the request is sent over HTTP instead of HTTPS
httpClient	The HttpClient that will be used to send HTTP requests.
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

baseUri

Warning

This API is now deprecated.

This property is deprecated and will be removed soon, please use endpoint instead

If specified, this is the base URI that requests will be made against for this ServiceClient. If it is not specified, then all OperationSpecs must contain a baseUrl property.

baseUri?: string

Property Value

string

credential

Credential used to authenticate the request.

credential?: TokenCredential

Property Value

TokenCredential

credentialScopes

If specified, will be used to build the BearerTokenAuthenticationPolicy.

credentialScopes?: string | string[]

Property Value

string | string[]

endpoint

If specified, this is the endpoint that requests will be made against for this ServiceClient. If it is not specified, then all OperationSpecs must contain a baseUrl property. to encourage customer to use endpoint, we mark the baseUri as deprecated.

endpoint?: string

Property Value

string

pipeline

A customized pipeline to use, otherwise a default one will be created.

pipeline?: Pipeline

Property Value

Pipeline

requestContentType

The default request content type for the service. Used if no requestContentType is present on an OperationSpec.

requestContentType?: string

Property Value

string

Inherited Property Details

additionalPolicies

Additional policies to include in the HTTP pipeline.

additionalPolicies?: AdditionalPolicyConfig[]

Property Value

AdditionalPolicyConfig[]

Inherited From CommonClientOptions.additionalPolicies

allowInsecureConnection

Set to true if the request is sent over HTTP instead of HTTPS

allowInsecureConnection?: boolean

Property Value

boolean

Inherited From CommonClientOptions.allowInsecureConnection

httpClient

The HttpClient that will be used to send HTTP requests.

httpClient?: HttpClient

Property Value

HttpClient

Inherited From CommonClientOptions.httpClient

proxyOptions

Options to configure a proxy for outgoing requests.

proxyOptions?: ProxySettings

Property Value

ProxySettings

Inherited From CommonClientOptions.proxyOptions

redirectOptions

Options for how redirect responses are handled.

redirectOptions?: RedirectPolicyOptions

Property Value

RedirectPolicyOptions

Inherited From CommonClientOptions.redirectOptions

retryOptions

Options that control how to retry failed requests.

retryOptions?: PipelineRetryOptions

Property Value

PipelineRetryOptions

Inherited From CommonClientOptions.retryOptions

telemetryOptions

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

telemetryOptions?: TelemetryOptions

Property Value

TelemetryOptions

Inherited From CommonClientOptions.telemetryOptions

tlsOptions

Options for configuring TLS authentication

tlsOptions?: TlsSettings

Property Value

TlsSettings

Inherited From CommonClientOptions.tlsOptions

userAgentOptions

Options for adding user agent details to outgoing requests.

userAgentOptions?: UserAgentPolicyOptions

Property Value

UserAgentPolicyOptions

Inherited From CommonClientOptions.userAgentOptions