Azure.Core.ClientOptions

ClientOptions

public abstract class ClientOptions

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

public static ClientOptions Default { get; }

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.

public DiagnosticsOptions Diagnostics { get; }

Gets the client diagnostic options.

public RetryOptions Retry { get; }

Gets the client retry options.

public HttpPipelinePolicy RetryPolicy { get; set; }

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 is overridden or a custom HttpPipelinePolicy is specified, it is the implementer's responsibility to update the ProcessingContext values.

public HttpPipelineTransport Transport { get; set; }

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

protected ClientOptions()

Creates a new instance of ClientOptions.

protected ClientOptions(DiagnosticsOptions diagnostics)

Creates a new instance of ClientOptions with the specified DiagnosticsOptions.

public void AddPolicy(HttpPipelinePolicy policy, HttpPipelinePosition position)

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.