Azure Connectors Node.js SDK
    Preparing search index...

    Interface ConnectorClientOptions

    Configuration options for connector clients.

    interface ConnectorClientOptions {
        agent?: Agent;
        applicationId?: string;
        baseUri?: string;
        httpClient?: HttpClient;
        proxyOptions?: ProxySettings;
        redirectOptions?: RedirectPolicyOptions;
        retryOptions?: PipelineRetryOptions;
        retryUnsafeHttpMethods?: boolean;
        telemetryEnabled?: boolean;
        telemetryOptions?: TelemetryOptions;
        tlsOptions?: TlsSettings;
        userAgentOptions?: UserAgentPolicyOptions;
    }

    Hierarchy

    • PipelineOptions
      • ConnectorClientOptions
    Index
    agent?: Agent

    Options for configuring Agent instance for outgoing requests

    applicationId?: string

    Optional application identifier prepended to the SDK user agent. Maximum 24 characters, with no whitespace. Use userAgentOptions.userAgentPrefix for wrapping SDK identifiers; that prefix is not an application ID.

    baseUri?: string

    The base URI for the connector endpoint.

    httpClient?: HttpClient

    The HTTP transport used by the request pipeline.

    proxyOptions?: ProxySettings

    Options to configure a proxy for outgoing requests.

    redirectOptions?: RedirectPolicyOptions

    Options for how redirect responses are handled.

    retryOptions?: PipelineRetryOptions

    Options that control how to retry failed requests.

    retryUnsafeHttpMethods?: boolean

    Whether retries are allowed for unsafe HTTP methods such as POST, PUT, PATCH, and DELETE. Defaults to false because retrying a completed connector action can duplicate side effects.

    telemetryEnabled?: boolean

    Whether SDK and platform identification is added to requests. Explicit values override AZURE_TELEMETRY_DISABLED. Defaults to true unless that environment variable is 'true' (case-insensitive) or '1' at client construction. Does not disable authentication, retries, correlation, tracing, logging, or caller-supplied request headers.

    telemetryOptions?: TelemetryOptions

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

    tlsOptions?: TlsSettings

    Options for configuring TLS authentication

    userAgentOptions?: UserAgentPolicyOptions

    Options for adding user agent details to outgoing requests.