ConfidentialLedgerClientOptions Class

Initializes new instance of ConfidentialLedgerClientOptions.

The Identity Service URL. If not provided, the default endpoint "https://identity.confidential-ledger.core.azure.com" will be used.

Gets the client diagnostic options.

Controls whether a current-entry read transparently falls back to ledger history when a collection's live entry has been archived by collection pruning. Defaults to false.

Controls the order in which a read request is retried against the ledger's failover endpoints when the primary ledger returns a transient failure. Defaults to Ordered, which preserves the order reported by the identity service. Use Random to shuffle the candidate endpoints and spread load across failover ledgers.

Optional per-attempt network timeout applied to each failover request. When set, every failover attempt is granted this network timeout, so that time already spent on the failed primary attempt does not consume the failover budget. When null the normal NetworkTimeout applies. Defaults to null.

Gets or sets the maximum allowed length for ApplicationId.

Gets the client retry options.

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.

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

Set to true when targeting the Confidential Ledger Gateway. When enabled, the client skips the CCF identity-service TLS bootstrap (using standard Azure PKI for TLS validation) and disables primary-node caching in the redirect policy (the gateway may redirect to any healthy host, not a sticky primary). Authentication via client certificate (mTLS) is not supported in this mode; only bearer-token authentication is accepted by the gateway.

Boolean determining whether certificate validation will be performed to verify the ledger identity TLS certificate is valid.

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.