SettingsClientOptions interface

The optional parameters accepted by the KeyVaultSettingsClient.

Extends

Properties

disableChallengeResourceVerification

Whether to disable verification that the authentication challenge resource matches the Key Vault or Managed HSM domain. Defaults to false.

serviceVersion

The accepted versions of the Key Vault's service API.

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

disableChallengeResourceVerification

Whether to disable verification that the authentication challenge resource matches the Key Vault or Managed HSM domain. Defaults to false.

disableChallengeResourceVerification?: boolean

Property Value

boolean

serviceVersion

The accepted versions of the Key Vault's service API.

serviceVersion?: SUPPORTED_API_VERSIONS

Property Value

Inherited Property Details

additionalPolicies

Additional policies to include in the HTTP pipeline.

additionalPolicies?: AdditionalPolicyConfig[]

Property Value

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

Inherited From CommonClientOptions.httpClient

proxyOptions

Options to configure a proxy for outgoing requests.

proxyOptions?: ProxySettings

Property Value

Inherited From CommonClientOptions.proxyOptions

redirectOptions

Options for how redirect responses are handled.

redirectOptions?: RedirectPolicyOptions

Property Value

Inherited From CommonClientOptions.redirectOptions

retryOptions

Options that control how to retry failed requests.

retryOptions?: PipelineRetryOptions

Property Value

Inherited From CommonClientOptions.retryOptions

telemetryOptions

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

telemetryOptions?: TelemetryOptions

Property Value

Inherited From CommonClientOptions.telemetryOptions

tlsOptions

Options for configuring TLS authentication

tlsOptions?: TlsSettings

Property Value

Inherited From CommonClientOptions.tlsOptions

userAgentOptions

Options for adding user agent details to outgoing requests.

userAgentOptions?: UserAgentPolicyOptions

Property Value

Inherited From CommonClientOptions.userAgentOptions