SecretClientOptions interface

The optional parameters accepted by the KeyVault's KeyClient

Extends

CommonClientOptions & ExtendedClientOptions

Properties

disableChallengeResourceVerification

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

serviceVersion

The accepted versions of the KeyVault'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.

keepAliveOptions

Options to disable keep alive.

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.

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 domain. Defaults to false.

disableChallengeResourceVerification?: boolean

Property Value

boolean

serviceVersion

The accepted versions of the KeyVault's service API.

serviceVersion?: "7.0" | "7.1" | "7.2" | "7.3"

Property Value

"7.0" | "7.1" | "7.2" | "7.3"

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

keepAliveOptions

Options to disable keep alive.

keepAliveOptions?: KeepAliveOptions

Property Value

KeepAliveOptions

Inherited From ExtendedClientOptions.keepAliveOptions

proxyOptions

Options to configure a proxy for outgoing requests.

proxyOptions?: ProxySettings

Property Value

ProxySettings

Inherited From PipelineOptions.proxyOptions

redirectOptions

Options for how redirect responses are handled.

redirectOptions?: RedirectPolicyOptions

Property Value

RedirectPolicyOptions

Inherited From PipelineOptions.redirectOptions

retryOptions

Options that control how to retry failed requests.

retryOptions?: PipelineRetryOptions

Property Value

PipelineRetryOptions

Inherited From PipelineOptions.retryOptions

tlsOptions

Options for configuring TLS authentication

tlsOptions?: TlsSettings

Property Value

TlsSettings

Inherited From PipelineOptions.tlsOptions

userAgentOptions

Options for adding user agent details to outgoing requests.

userAgentOptions?: UserAgentPolicyOptions

Property Value

UserAgentPolicyOptions

Inherited From PipelineOptions.userAgentOptions