DigitalTwinsClientOptions Class

Definition

Namespace:

Azure.DigitalTwins.Core

Assembly:

Azure.DigitalTwins.Core.dll

Package:

Azure.DigitalTwins.Core v1.4.0

Source:

DigitalTwinsClientOptions.cs

Options that allow configuration of requests sent to the digital twins service.

public class DigitalTwinsClientOptions : Azure.Core.ClientOptions

type DigitalTwinsClientOptions = class
    inherit ClientOptions

Public Class DigitalTwinsClientOptions
Inherits ClientOptions

Inheritance

Object

ClientOptions

DigitalTwinsClientOptions

Constructors

DigitalTwinsClientOptions(DigitalTwinsClientOptions+ServiceVersion)

Initializes a new instance of the DigitalTwinsClientOptions class.

Properties

Diagnostics	Gets the client diagnostic options. (Inherited from ClientOptions)
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)
Serializer	Used to serialize and deserialize the payloads of user-provided types to/from UTF-8 encoded JSON.
Transport	The HttpPipelineTransport to be used for this client. Defaults to an instance of HttpClientTransport. (Inherited from ClientOptions)
Version	Gets the DigitalTwinsClientOptions.ServiceVersion of the service API used when making requests.

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)