KeyClientOptions Class

Definition

Options that allow you to configure the requests sent to Key Vault.

public class KeyClientOptions : Azure.Core.ClientOptions
type KeyClientOptions = class
    inherit ClientOptions
Public Class KeyClientOptions
Inherits ClientOptions
Inheritance
KeyClientOptions

Constructors

KeyClientOptions(KeyClientOptions+ServiceVersion)

Initializes a new instance of the KeyClientOptions class. class.

Properties

Diagnostics

Gets the client diagnostic options.

(Inherited from ClientOptions)
DisableChallengeResourceVerification

Gets or sets whether to disable verification that the authentication challenge resource matches the Key Vault or Managed HSM domain.

Retry

Gets the client retry options.

(Inherited from ClientOptions)
RetryPolicy

Gets or sets the policy to use for retries. If a policy is specified, it will be used in place of the Retry property. The RetryPolicy type can be derived from to modify the default behavior without needing to fully implement the retry logic. If Process(HttpMessage, ReadOnlyMemory<HttpPipelinePolicy>) is overridden or a custom HttpPipelinePolicy is specified, it is the implementer's responsibility to update the ProcessingContext values.

(Inherited from ClientOptions)
Transport

The HttpPipelineTransport to be used for this client. Defaults to an instance of HttpClientTransport.

(Inherited from ClientOptions)
Version

Gets the KeyClientOptions.ServiceVersion of the service API used when making requests. For more information, see Key Vault versions.

Methods

AddPolicy(HttpPipelinePolicy, HttpPipelinePosition)

Adds an HttpPipeline policy into the client pipeline. The position of policy in the pipeline is controlled by the position parameter. If you want the policy to execute once per client request use PerCall otherwise use PerRetry to run the policy for every retry. Note that the same instance of policy would be added to all pipelines of client constructed using this ClientOptions object.

(Inherited from ClientOptions)

Applies to