Interface IProviderClient

Namespace

OpenShell

Assembly

OpenShell.Sdk.dll

Provider operations, scoped to one workspace.

public interface IProviderClient

Properties

Profiles

Provider type profiles, in this workspace.

IProviderProfileClient Profiles { get; }

Property Value

IProviderProfileClient

Refresh

Gateway-owned credential refresh configuration.

IProviderRefreshClient Refresh { get; }

Property Value

IProviderRefreshClient

Methods

CreateAsync(Provider, CreateProviderOptions?, CancellationToken)

Creates a provider.

ValueTask<Provider> CreateAsync(Provider provider, CreateProviderOptions? options = null, CancellationToken cancellationToken = default)

Parameters

provider Provider

options CreateProviderOptions

cancellationToken CancellationToken

Returns

ValueTask<Provider>

DeleteAsync(string, DeleteOptions?, CancellationToken)

Deletes a provider.

ValueTask<DeletionResult> DeleteAsync(string name, DeleteOptions? options = null, CancellationToken cancellationToken = default)

Parameters

name string

options DeleteOptions

cancellationToken CancellationToken

Returns

ValueTask<DeletionResult>

EnsureAsync(Provider, CancellationToken)

Creates the provider, or updates it in place when one with the same name already exists.

ValueTask<Provider> EnsureAsync(Provider provider, CancellationToken cancellationToken = default)

Parameters

provider Provider

cancellationToken CancellationToken

Returns

ValueTask<Provider>

GetAsync(string, CancellationToken)

Gets a provider by name.

ValueTask<Provider> GetAsync(string name, CancellationToken cancellationToken = default)

Parameters

name string

cancellationToken CancellationToken

Returns

ValueTask<Provider>

GetCredentialsAsync(string, IReadOnlyCollection<string>, ProviderCredentialsOptions, CancellationToken)

Exports exactly the selected runtime credential keys, or fails without a result. Requires direct operator mTLS (a trusted OU=operator client certificate) and no bearer or edge token. The gateway refreshes eligible missing or short-lived outputs and may commit refresh effects even if delivery fails. This helper does not retry or cache, and never logs values; treat the result as secret.

ValueTask<IReadOnlyDictionary<string, ProviderCredentialValue>> GetCredentialsAsync(string name, IReadOnlyCollection<string> credentialKeys, ProviderCredentialsOptions options, CancellationToken cancellationToken = default)

Parameters

name string

credentialKeys IReadOnlyCollection<string>

options ProviderCredentialsOptions

cancellationToken CancellationToken

Returns

ValueTask<IReadOnlyDictionary<string, ProviderCredentialValue>>

List(ListOptions?)

Lists providers lazily; set AllWorkspaces to span workspaces.

Pager<Provider> List(ListOptions? options = null)

Parameters

options ListOptions

Returns

Pager<Provider>

UpdateAsync(Provider, UpdateProviderOptions?, CancellationToken)

Updates a provider and returns the per-sandbox receipts for sandboxes it is attached to.

ValueTask<ProviderUpdateResult> UpdateAsync(Provider provider, UpdateProviderOptions? options = null, CancellationToken cancellationToken = default)

Parameters

provider Provider

options UpdateProviderOptions

cancellationToken CancellationToken

Returns

ValueTask<ProviderUpdateResult>