Interface IOpenShellClientBuilder

Namespace

Microsoft.Extensions.DependencyInjection

Assembly

OpenShell.Sdk.DependencyInjection.dll

Configures one gateway registration fluently. Obtain it from AddOpenShellClient.

public interface IOpenShellClientBuilder

Extension Methods

OpenShellClientBuilderExtensions.AllowInsecureAuth(IOpenShellClientBuilder)

OpenShellClientBuilderExtensions.BindConfiguration(IOpenShellClientBuilder, IConfiguration)

OpenShellClientBuilderExtensions.WithAddress(IOpenShellClientBuilder, string)

OpenShellClientBuilderExtensions.WithAddress(IOpenShellClientBuilder, Uri)

OpenShellClientBuilderExtensions.WithAuth(IOpenShellClientBuilder, IAuthProvider)

OpenShellClientBuilderExtensions.WithAuth(IOpenShellClientBuilder, Func<IServiceProvider, IAuthProvider>)

OpenShellClientBuilderExtensions.WithBearerToken(IOpenShellClientBuilder, string)

OpenShellClientBuilderExtensions.WithCaCertificate(IOpenShellClientBuilder, string)

OpenShellClientBuilderExtensions.WithClientCertificate(IOpenShellClientBuilder, string, string?)

OpenShellClientBuilderExtensions.WithClientCredentials(IOpenShellClientBuilder, Func<IServiceProvider, OidcOptions>)

OpenShellClientBuilderExtensions.WithClientCredentials(IOpenShellClientBuilder, string, string, Func<CancellationToken, ValueTask<string>>, params string[])

OpenShellClientBuilderExtensions.WithInsecureTls(IOpenShellClientBuilder)

OpenShellClientBuilderExtensions.WithRetry(IOpenShellClientBuilder, Action<RetryOptions>)

OpenShellClientBuilderExtensions.WithTimeout(IOpenShellClientBuilder, TimeSpan)

OpenShellClientBuilderExtensions.WithTls(IOpenShellClientBuilder, TlsOptions)

OpenShellClientBuilderExtensions.WithWorkspace(IOpenShellClientBuilder, string)

OpenShellClientBuilderExtensions.WithoutRetry(IOpenShellClientBuilder)

Properties

Name

The registration name; empty for the default gateway.

string Name { get; }

Property Value

string

Services

The service collection being configured.

IServiceCollection Services { get; }

Property Value

IServiceCollection

Methods

Configure(Action<OpenShellOptions>)

Adjusts the options in code.

IOpenShellClientBuilder Configure(Action<OpenShellOptions> configure)

Parameters

configure Action<OpenShellOptions>

Returns

IOpenShellClientBuilder

Configure(Action<IServiceProvider, OpenShellOptions>)

Adjusts the options with access to other registered services, such as a token cache or secret store.

IOpenShellClientBuilder Configure(Action<IServiceProvider, OpenShellOptions> configure)

Parameters

configure Action<IServiceProvider, OpenShellOptions>

Returns

IOpenShellClientBuilder