WebPubSubChatServiceClientOptions interface
Options for configuring the Web PubSub Chat service client.
Properties
| reverse |
The reverse proxy endpoint (e.g. APIM gateway URL). |
Inherited Properties
| additional |
Additional policies to include in the HTTP pipeline. |
| agent | Options for configuring Agent instance for outgoing requests |
| allow |
Option to allow calling http (insecure) endpoints |
| api |
Known values of KnownVersions that the service accepts. |
| base |
Base url for the client |
| credentials | Credentials information |
| endpoint | Endpoint for the client |
| http |
Specify a custom HttpClient when making requests. |
| internal | Options that are intended for use by generated clients and are not meant to be set by end users directly. |
| logging |
Options to configure request/response logging. |
| pipeline | Pipeline to use for the client. If not provided, a default pipeline will be created using the options provided. Use with caution -- when setting this option, all client options that are used in the creation of the default pipeline will be ignored. |
| proxy |
Options to configure a proxy for outgoing requests. |
| redirect |
Options for how redirect responses are handled. |
| retry |
Options that control how to retry failed requests. |
| telemetry |
Options for setting common telemetry and tracing info to outgoing requests. |
| tls |
Options for configuring TLS authentication |
| user |
Options for adding user agent details to outgoing requests. |
Property Details
reverseProxyEndpoint
The reverse proxy endpoint (e.g. APIM gateway URL).
reverseProxyEndpoint?: string
Property Value
string
Inherited Property Details
additionalPolicies
Additional policies to include in the HTTP pipeline.
additionalPolicies?: AdditionalPolicyConfig[]
Property Value
Inherited From WebPubSubChatServiceClientOptionalParams.additionalPolicies
agent
Options for configuring Agent instance for outgoing requests
agent?: Agent
Property Value
Inherited From WebPubSubChatServiceClientOptionalParams.agent
allowInsecureConnection
Option to allow calling http (insecure) endpoints
allowInsecureConnection?: boolean
Property Value
boolean
Inherited From WebPubSubChatServiceClientOptionalParams.allowInsecureConnection
apiVersion
Known values of KnownVersions that the service accepts.
apiVersion?: string
Property Value
string
Inherited From WebPubSubChatServiceClientOptionalParams.apiVersion
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 WebPubSubChatServiceClientOptionalParams.baseUrl
credentials
Credentials information
credentials?: { apiKeyHeaderName?: string, scopes?: string[] }
Property Value
{ apiKeyHeaderName?: string, scopes?: string[] }
Inherited From WebPubSubChatServiceClientOptionalParams.credentials
endpoint
Endpoint for the client
endpoint?: string
Property Value
string
Inherited From WebPubSubChatServiceClientOptionalParams.endpoint
httpClient
Specify a custom HttpClient when making requests.
httpClient?: HttpClient
Property Value
Inherited From WebPubSubChatServiceClientOptionalParams.httpClient
internal
Options that are intended for use by generated clients and are not meant to be set by end users directly.
internal?: InternalClientOptions
Property Value
InternalClientOptions
Inherited From WebPubSubChatServiceClientOptionalParams.internal
loggingOptions
Options to configure request/response logging.
loggingOptions?: LogPolicyOptions
Property Value
Inherited From WebPubSubChatServiceClientOptionalParams.loggingOptions
pipeline
Pipeline to use for the client. If not provided, a default pipeline will be created using the options provided. Use with caution -- when setting this option, all client options that are used in the creation of the default pipeline will be ignored.
pipeline?: Pipeline
Property Value
Inherited From WebPubSubChatServiceClientOptionalParams.pipeline
proxyOptions
Options to configure a proxy for outgoing requests.
proxyOptions?: ProxySettings
Property Value
Inherited From WebPubSubChatServiceClientOptionalParams.proxyOptions
redirectOptions
Options for how redirect responses are handled.
redirectOptions?: RedirectPolicyOptions
Property Value
Inherited From WebPubSubChatServiceClientOptionalParams.redirectOptions
retryOptions
Options that control how to retry failed requests.
retryOptions?: PipelineRetryOptions
Property Value
Inherited From WebPubSubChatServiceClientOptionalParams.retryOptions
telemetryOptions
Options for setting common telemetry and tracing info to outgoing requests.
telemetryOptions?: TelemetryOptions
Property Value
Inherited From WebPubSubChatServiceClientOptionalParams.telemetryOptions
tlsOptions
Options for configuring TLS authentication
tlsOptions?: TlsSettings
Property Value
Inherited From WebPubSubChatServiceClientOptionalParams.tlsOptions
userAgentOptions
Options for adding user agent details to outgoing requests.
userAgentOptions?: UserAgentPolicyOptions
Property Value
Inherited From WebPubSubChatServiceClientOptionalParams.userAgentOptions