ClientOptions Class

  • Reference

Definition

Namespace:
Azure.Core
Assembly:
Azure.Core.dll
Package:
Azure.Core v1.38.0
Source:
ClientOptions.cs

Base type for all client option types, exposes various common client options like Diagnostics, Retry, Transport.

public abstract class ClientOptions
type ClientOptions = class
Public MustInherit Class ClientOptions
Inheritance
Object
ClientOptions
Derived

Constructors

ClientOptions()

Creates a new instance of ClientOptions.
ClientOptions(DiagnosticsOptions)

Creates a new instance of ClientOptions with the specified DiagnosticsOptions.

Properties

Default

Gets the default set of ClientOptions. Changes to the Default options would be reflected in new instances of ClientOptions type created after changes to Default were made.
Diagnostics

Gets the client diagnostic options.
Retry

Gets the client retry options.
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.
Transport

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

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.

Applies to