ApplicationInsightsClientOptionalParams interface

Optional parameters for the Application Insights client. Extends both ServiceClientOptions (for backward compatibility) and ClientOptions (REST client).

Extends

Properties

endpoint

Overrides client endpoint.

host

Breeze endpoint: https://dc.services.visualstudio.com

Inherited Properties

additionalPolicies

Additional policies to include in the HTTP pipeline.

agent

Options for configuring Agent instance for outgoing requests

allowInsecureConnection

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

apiVersion

Options for setting a custom apiVersion.

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.

baseUrl

Base url for the client

credential

Credential used to authenticate the request.

credentials

Credentials information

credentialScopes

If specified, will be used to build the BearerTokenAuthenticationPolicy.

httpClient

The HttpClient that will be used to send HTTP requests.

loggingOptions

Options to configure request/response logging.

pipeline

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

proxyOptions

Options to configure a proxy for outgoing requests.

redirectOptions

Options for how redirect responses are handled.

requestContentType

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

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

endpoint

Overrides client endpoint.

endpoint?: string

Property Value

string

host

Breeze endpoint: https://dc.services.visualstudio.com

host?: string

Property Value

string

Inherited Property Details

additionalPolicies

Additional policies to include in the HTTP pipeline.

additionalPolicies?: AdditionalPolicyConfig[]

Property Value

Inherited From ServiceClientOptions.additionalPolicies

agent

Options for configuring Agent instance for outgoing requests

agent?: Agent

Property Value

Inherited From ServiceClientOptions.agent

allowInsecureConnection

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

allowInsecureConnection?: boolean

Property Value

boolean

Inherited From ServiceClientOptions.allowInsecureConnection

apiVersion

Options for setting a custom apiVersion.

apiVersion?: string

Property Value

string

Inherited From ClientOptions.apiVersion

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

Inherited From ServiceClientOptions.baseUri

baseUrl

Warning

This API is now deprecated.

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

Base url for the client

baseUrl?: string

Property Value

string

Inherited From ClientOptions.baseUrl

credential

Credential used to authenticate the request.

credential?: TokenCredential

Property Value

Inherited From ServiceClientOptions.credential

credentials

Credentials information

credentials?: { apiKeyHeaderName?: string, scopes?: string[] }

Property Value

{ apiKeyHeaderName?: string, scopes?: string[] }

Inherited From ClientOptions.credentials

credentialScopes

If specified, will be used to build the BearerTokenAuthenticationPolicy.

credentialScopes?: string | string[]

Property Value

string | string[]

Inherited From ServiceClientOptions.credentialScopes

httpClient

The HttpClient that will be used to send HTTP requests.

httpClient?: HttpClient

Property Value

Inherited From ServiceClientOptions.httpClient

loggingOptions

Options to configure request/response logging.

loggingOptions?: LogPolicyOptions

Property Value

Inherited From ClientOptions.loggingOptions

pipeline

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

pipeline?: Pipeline

Property Value

Inherited From ServiceClientOptions.pipeline

proxyOptions

Options to configure a proxy for outgoing requests.

proxyOptions?: ProxySettings

Property Value

Inherited From ServiceClientOptions.proxyOptions

redirectOptions

Options for how redirect responses are handled.

redirectOptions?: RedirectPolicyOptions

Property Value

Inherited From ServiceClientOptions.redirectOptions

requestContentType

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

requestContentType?: string

Property Value

string

Inherited From ServiceClientOptions.requestContentType

retryOptions

Options that control how to retry failed requests.

retryOptions?: PipelineRetryOptions

Property Value

Inherited From ServiceClientOptions.retryOptions

telemetryOptions

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

telemetryOptions?: TelemetryOptions

Property Value

Inherited From ServiceClientOptions.telemetryOptions

tlsOptions

Options for configuring TLS authentication

tlsOptions?: TlsSettings

Property Value

Inherited From ServiceClientOptions.tlsOptions

userAgentOptions

Options for adding user agent details to outgoing requests.

userAgentOptions?: UserAgentPolicyOptions

Property Value

Inherited From ServiceClientOptions.userAgentOptions